OGRE: OgrePanelOverlayElement.h Source File - OGRE Documentation

# OgrePanelOverlayElement.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028
    00029 #ifndef __PanelOverlayElement_H__
    00030 #define __PanelOverlayElement_H__
    00031
    00032 #include "OgreOverlayContainer.h"
    00033
    00034 namespace Ogre {
    00035
    00036
    00058     class _OgreExport PanelOverlayElement : public OverlayContainer
    00059     {
    00060     public:
    00062         PanelOverlayElement(const String& name);
    00063         virtual ~PanelOverlayElement();
    00064
    00066         virtual void initialise(void);
    00067
    00074         void setTiling(Real x, Real y, ushort layer = 0);
    00075
    00076         Real getTileX(ushort layer = 0) const;
    00081         Real getTileY(ushort layer = 0) const;
    00082
    00084         void setUV(Real u1, Real v1, Real u2, Real v2);
    00085
    00087         void getUV(Real& u1, Real& v1, Real& u2, Real& v2) const;
    00088
    00092         void setTransparent(bool isTransparent);
    00093
    00095         bool isTransparent(void) const;
    00096
    00098         virtual const String& getTypeName(void) const;
    00100         void getRenderOperation(RenderOperation& op);
    00102         void setMaterialName(const String& matName);
    00104         void _updateRenderQueue(RenderQueue* queue);
    00105
    00106
    00108         class _OgrePrivate CmdTiling : public ParamCommand
    00109         {
    00110         public:
    00111             String doGet(const void* target) const;
    00112             void doSet(void* target, const String& val);
    00113         };
    00115         class _OgrePrivate CmdTransparent : public ParamCommand
    00116         {
    00117         public:
    00118             String doGet(const void* target) const;
    00119             void doSet(void* target, const String& val);
    00120         };
    00122         class _OgrePrivate CmdUVCoords : public ParamCommand
    00123         {
    00124         public:
    00125             String doGet(const void* target) const;
    00126             void doSet(void* target, const String& val);
    00127         };
    00128     protected:
    00129         // Flag indicating if this panel should be visual or just group things
    00130         bool mTransparent;
    00131         // Texture tiling
    00132         Real mTileX[OGRE_MAX_TEXTURE_LAYERS];
    00133         Real mTileY[OGRE_MAX_TEXTURE_LAYERS];
    00134         size_t mNumTexCoordsInBuffer;
    00135         Real mU1, mV1, mU2, mV2;
    00136
    00137         RenderOperation mRenderOp;
    00138
    00140         virtual void updatePositionGeometry(void);
    00141
    00143         virtual void updateTextureGeometry(void);
    00144
    00146         void addBaseParameters(void);
    00147
    00148         static String msTypeName;
    00149
    00150         // Command objects
    00151         static CmdTiling msCmdTiling;
    00152         static CmdTransparent msCmdTransparent;
    00153         static CmdUVCoords msCmdUVCoords;
    00154
    00155     };
    00159 }
    00160
    00161 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52