lugre_ColourClipPaneOverlay.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_ColourClipPaneOVERLAY_H
#define LUGRE_ColourClipPaneOVERLAY_H
#include "lugre_robrenderable.h"
#include <OgrePrerequisites.h>
#include <OgreOverlayContainer.h>


namespace Lugre {
    
// temporary name
// see also OgrePanelOverlayElement.cpp
// OgreOverlayElementFactory.h
// ./include/OgreOverlayElementFactory.h

class cColourClipPaneOverlay : public cRobRenderOp, public Ogre::OverlayContainer { public :
    Ogre::RenderOperation   mRenderOp;
    static Ogre::String     msTypeName;
    
    struct Vertex {
        Ogre::Real          x,y;
        Ogre::Real          u,v; 
        Ogre::ColourValue   col;
        
        Vertex();
        Vertex(const Ogre::Real x,const Ogre::Real y,const Ogre::Real u,const Ogre::Real v,const Ogre::ColourValue& col);
        friend Vertex Interpolate   (const Vertex& a,const Vertex& b,const float t);
        void    Print               (); 
        void    Draw                (cRobRenderOp* pRobRenderOp,const Ogre::Real z); 
    };
    
    struct VertexRect {
        Vertex  lt,lb,rt,rb; 
        
        VertexRect ();
        VertexRect (const Vertex& lt,const Vertex& lb,const Vertex& rt,const Vertex& rb);
        void        SetLTWH     (const Ogre::Real l,const Ogre::Real t,const Ogre::Real w,const Ogre::Real h);
        void        SetLTRB     (const Ogre::Real l,const Ogre::Real t,const Ogre::Real r,const Ogre::Real b);
        void        SetCol      (const Ogre::ColourValue& col);
        void        SetUV       (const Ogre::Real u1,const Ogre::Real v1,const Ogre::Real u2,const Ogre::Real v2);
        Vertex      Pick        (const Ogre::Real x,const Ogre::Real y); 
        VertexRect  Intersect   (const Ogre::Rectangle& clippingRegion);
        void        DrawStrip   (cRobRenderOp* pRobRenderOp,const Ogre::Real z); 
        void        DrawList    (cRobRenderOp* pRobRenderOp,const Ogre::Real z); 
        void        Print       (); 
    };

    // Flag indicating if this panel should be visual or just a group
    bool mTransparent;
    bool mbClipInitialized;
    VertexRect          mForm;
    Ogre::Rectangle     mClip; 
    
    cColourClipPaneOverlay(const Ogre::String& name);
    virtual ~cColourClipPaneOverlay();
    
    static void RegisterFactory ();
    
    virtual void initialise     (void);

    virtual void setColour      (const Ogre::ColourValue& col);
    virtual void SetColours     (const Ogre::ColourValue colLT,const Ogre::ColourValue colRT,const Ogre::ColourValue colLB,const Ogre::ColourValue colRB);
    virtual void SetTexCoords   (const Ogre::Real fU1,const Ogre::Real fV1,const Ogre::Real fU2,const Ogre::Real fV2);
    virtual void SetClip        (const Ogre::Real fCL,const Ogre::Real fCT,const Ogre::Real fCW,const Ogre::Real fCH);

    void setTransparent(bool isTransparent);

    bool isTransparent(void) const;

    virtual const Ogre::String& getTypeName(void) const;
    void getRenderOperation(Ogre::RenderOperation& op);
    void setMaterialName(const Ogre::String& matName);
    void _updateRenderQueue(Ogre::RenderQueue* queue);

    virtual void updatePositionGeometry(void);

    virtual void updateTextureGeometry(void);

    void addBaseParameters(void);
};

};

#endif