lugre_gfx2D.h

Go to the documentation of this file.

/*
http://www.opensource.org/licenses/mit-license.php  (MIT-License)

Copyright (c) 2007 Lugre-Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#ifndef LUGRE_GFX2D_H
#define LUGRE_GFX2D_H

#include <list>
#include <OgrePrerequisites.h>
#include <OgreVector2.h>
#include <OgreVector3.h>
#include <OgreQuaternion.h>
#include "lugre_gfx3D.h"
#include "lugre_listener.h"

using Ogre::Vector2;
using Ogre::Vector3;
using Ogre::Quaternion;
using Ogre::Real;

class lua_State;


namespace Ogre {
    class PanelOverlayElement;
    class TextAreaOverlayElement;
};

namespace Lugre {
    
class cGfx3D;
class cCompassOverlay;
class cColourClipPaneOverlay;
class cColourClipTextOverlay;
class cBorderColourClipPaneOverlay;
class cSortedOverlayContainer;
class cRobRenderableOverlay;
    

class cGfx2D : public cSmartPointable { public :
    static unsigned int miCount;

    enum {
        kGfx2DAlign_Left,
        kGfx2DAlign_Top,
        kGfx2DAlign_Right,
        kGfx2DAlign_Bottom,
        kGfx2DAlign_Center,
    };
    
             cGfx2D (Ogre::Overlay* pRootOverlay=0,cGfx2D* pDefaultParent=0);
    virtual ~cGfx2D ();
    void    Init    ();
    void    Clear   ();
        
    static std::string  GetUniqueName   (); 
    
    static  Ogre::Overlay*  CreateOverlay   (const char* szName,const size_t iZOrder); 
    static  void            DestroyOverlay  (Ogre::Overlay* pOverlay);
    
    Ogre::Overlay*  mpRootOverlay;
    cGfx2D*         mpDefaultParent;
    
    Ogre::Overlay*      mpParent_Overlay;
    cSmartPtr<cGfx2D>   mpParent_Gfx2D;
    
    // interfaces
    Ogre::OverlayElement*           mpOverlayElement; 
    Ogre::OverlayContainer*         mpOverlayContainer;
    
    // concrete classes
    Ogre::PanelOverlayElement*      mpPanel; // is container
    cColourClipPaneOverlay*         mpCCPO; // is container
    cColourClipTextOverlay*         mpCCTO;
    cBorderColourClipPaneOverlay*   mpBCCPO; // is container
    cSortedOverlayContainer*        mpSOC; // is container
    cRobRenderableOverlay*          mpRROC; // is container
    cCompassOverlay*                mpCompass; // is container
    Ogre::TextAreaOverlayElement*   mpText;
    // todo : spline meter
    // todo : line
    
    // PrepareFrameStep options
    cSmartPtr<cGfx3D>       mpTrackPosTarget;   
    Vector2                 mvTrackPosOffset;   
    Vector2                 mvTrackPosTargetSizeFactor;
    Vector2                 mvTrackPosOwnSizeFactor;
    Vector2                 mvTrackClampMin; 
    Vector2                 mvTrackClampMax; 
    Vector2                 mvTrackSetSizeFactor; 
    bool                    mbTrackClamp;
    bool                    mbTrackHideIfClamped;       
    bool                    mbTrackHideIfBehindCam;     
    bool                    mbTrackClampMaxXIfBehindCam;
    bool                    mbTrackClampMaxYIfBehindCam;
    bool                    mbTrackSetSize; 
    bool                    mbTrackMouse;
    
    void    InitPanel       (cGfx2D* pParent=0); 
    void    InitCCPO        (cGfx2D* pParent=0); 
    void    InitCCTO        (cGfx2D* pParent=0); 
    void    InitBCCPO       (cGfx2D* pParent=0); 
    void    InitSOC         (cGfx2D* pParent=0); 
    void    InitRROC        (cGfx2D* pParent=0); 
    void    InitText        (cGfx2D* pParent=0); 
    void    InitBase        (Ogre::OverlayElement* pOverlayElement,cGfx2D* pParent=0);
    void    InitCompass     (cGfx2D* pParent=0); 
    
    void    SetPrepareFrameStep (const bool bOn);
    void    SetVisible      (const bool bVisible);
    bool    GetVisible      ();
    void    SetMaterial     (const char* szMat);
    void    SetBorderMaterial   (const char* szMat);
    void    SetPos          (const Ogre::Real x,const Ogre::Real y);
    void    SetDimensions   (const Ogre::Real cx,const Ogre::Real cy);
    void    SetAlignment    (const size_t iHAlign,const size_t iVAlign);
    void    SetTextAlignment    (const size_t iTextAlign);
    void    SetUV           (const Ogre::Real u1, const Ogre::Real v1, const Ogre::Real u2, const Ogre::Real v2);
    void    SetPartUV       (const int iPart,const Ogre::Real u1, const Ogre::Real v1, const Ogre::Real u2, const Ogre::Real v2);
    void    SetClip         (const Ogre::Real fCL,const Ogre::Real fCT,const Ogre::Real fCW,const Ogre::Real fCH);
    void    SetBorder       (const Ogre::Real l,const Ogre::Real t,const Ogre::Real r,const Ogre::Real b);
    void    SetCharHeight   (const Ogre::Real fHeight);
    void    SetFont         (const char* szFont);
    void    SetText         (const char* szText);
    void    SetAutoWrap     (const int iMaxW);
    void    SetColour       (const Ogre::ColourValue& col);
    void    SetColours      (const Ogre::ColourValue& colLT,const Ogre::ColourValue& colRT,const Ogre::ColourValue& colLB,const Ogre::ColourValue& colRB);
    void    SetPartColours  (const int iPart,const Ogre::ColourValue& colLT,const Ogre::ColourValue& colRT,const Ogre::ColourValue& colLB,const Ogre::ColourValue& colRB);
    void    SetRotate       (const Ogre::Real radians); 
    
    Ogre::Real  GetLeft         ();
    Ogre::Real  GetTop          ();
    Ogre::Real  GetDerivedLeft  ();
    Ogre::Real  GetDerivedTop   ();
    Ogre::Real  GetWidth        ();
    Ogre::Real  GetHeight       ();
    
    bool    IsPointWithin   (const size_t x,const size_t y); 
    
    void    GetTextBounds   (Ogre::Real& w,Ogre::Real& h);      
    int     GetGlyphAtPos   (const size_t x,const size_t y);    
    void    GetGlyphBounds  (const size_t iIndex,Ogre::Real& l,Ogre::Real& t,Ogre::Real& r,Ogre::Real& b); 
    
    // lua binding
    static void     LuaRegister     (lua_State *L);
    
    private:
        
    static  std::list<cGfx2D*>      gPrepareFrameStepper;
    std::list<cGfx2D*>::iterator    mPrepareFrameItor; 
    bool    mbPrepareFrameStep; 
    void    PrepareFrameStep    ();
    
    public:
        
    static  void        PrepareFrame    (); 
};

};

#endif