OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::PanelOverlayElement Class Reference

OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements. More...

#include <OgrePanelOverlayElement.h>

+ Inheritance diagram for Ogre::PanelOverlayElement:

Classes

class  CmdTiling
 Command object for specifying tiling (see ParamCommand). More...
 
class  CmdTransparent
 Command object for specifying transparency (see ParamCommand). More...
 
class  CmdUVCoords
 Command object for specifying UV coordinates (see ParamCommand). More...
 

Public Member Functions

 PanelOverlayElement (const String &name)
 Constructor. More...
 
virtual ~PanelOverlayElement ()
 
virtual void _releaseManualHardwareResources ()
 Notifies that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies that hardware resources should be restored. More...
 
void _updateRenderQueue (RenderQueue *queue)
 Overridden from OverlayContainer. More...
 
void getRenderOperation (RenderOperation &op)
 See Renderable. More...
 
Real getTileX (ushort layer=0) const
 
Real getTileY (ushort layer=0) const
 Gets the number of times the texture should repeat vertically. More...
 
virtual const StringgetTypeName (void) const
 See OverlayElement. More...
 
void getUV (Real &u1, Real &v1, Real &u2, Real &v2) const
 Get the uv coordinates for the panel. More...
 
virtual void initialise (void)
 Initialise. More...
 
bool isTransparent (void) const
 Returns whether this panel is transparent. More...
 
void setTiling (Real x, Real y, ushort layer=0)
 Sets the number of times textures should repeat. More...
 
void setTransparent (bool isTransparent)
 Sets whether this panel is transparent (used only as a grouping level), or if it is actually rendered. More...
 
void setUV (Real u1, Real v1, Real u2, Real v2)
 Sets the texture coordinates for the panel. More...
 
- Public Member Functions inherited from Ogre::OverlayContainer
 OverlayContainer (const String &name)
 Constructor: do not call direct, use OverlayManager::createOverlayElement. More...
 
virtual ~OverlayContainer ()
 
void _addChild (OverlayElement *elem)
 
virtual void _notifyParent (OverlayContainer *parent, Overlay *overlay)
 Overridden from OverlayElement. More...
 
virtual void _notifyViewport ()
 Overridden from OverlayElement. More...
 
virtual void _notifyWorldTransforms (const Matrix4 &xform)
 Overridden from OverlayElement. More...
 
virtual ushort _notifyZOrder (ushort newZOrder)
 Overridden from OverlayElement. More...
 
virtual void _positionsOutOfDate (void)
 Tell the object and its children to recalculate. More...
 
void _removeChild (const String &name)
 
void _removeChild (OverlayElement *elem)
 
virtual void _update (void)
 Overridden from OverlayElement. More...
 
virtual void addChild (OverlayElement *elem)
 Adds another OverlayElement to this container. More...
 
virtual void addChildImpl (OverlayContainer *cont)
 Add a nested container to this container. More...
 
virtual void addChildImpl (OverlayElement *elem)
 Adds another OverlayElement to this container. More...
 
virtual OverlayElementclone (const String &instanceName)
 
void copyFromTemplate (OverlayElement *templateOverlay)
 
virtual OverlayElementfindElementAt (Real x, Real y)
 This returns a OverlayElement at position x,y. More...
 
virtual OverlayElementgetChild (const String &name)
 Gets the named child of this container. More...
 
virtual ChildContainerIterator getChildContainerIterator (void)
 Gets an iterator for just the container children of this object. More...
 
virtual ChildIterator getChildIterator (void)
 
const ChildMapgetChildren () const
 Gets all the children of this object. More...
 
virtual bool isChildrenProcessEvents () const
 Should this container pass events to their children. More...
 
bool isContainer () const
 Overridden from OverlayElement. More...
 
virtual void removeChild (const String &name)
 Removes a named element from this container. More...
 
virtual void setChildrenProcessEvents (bool val)
 Should this container pass events to their children. More...
 
- Public Member Functions inherited from Ogre::OverlayElement
 OverlayElement (const String &name)
 Constructor: do not call direct, use OverlayManager::createElement. More...
 
virtual ~OverlayElement ()
 
virtual void _getClippingRegion (RealRect &clippingRegion)
 Gets the clipping region of the element. More...
 
virtual Real _getDerivedLeft (void)
 Gets the 'left' position as derived from own left and that of parents. More...
 
virtual Real _getDerivedTop (void)
 Gets the 'top' position as derived from own left and that of parents. More...
 
Real _getHeight (void) const
 Gets the height of this element in relation to the screen (where 1.0 = screen height)
More...
 
Real _getLeft (void) const
 Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
virtual Real _getRelativeHeight (void)
 Gets the 'height' as derived from own height and metrics mode. More...
 
virtual Real _getRelativeWidth (void)
 Gets the 'width' as derived from own width and metrics mode. More...
 
Real _getTop (void) const
 Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
Real _getWidth (void) const
 Gets the width of this element in relation to the screen (where 1.0 = screen width)
More...
 
void _setDimensions (Real width, Real height)
 Sets the width and height of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setHeight (Real height)
 Sets the height of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setLeft (Real left)
 Sets the left of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setParent (OverlayContainer *parent)
 
void _setPosition (Real left, Real top)
 Sets the left and top of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setTop (Real top)
 Sets the top of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setWidth (Real width)
 Sets the width of this element in relation to the screen (where 1.0 = screen width) More...
 
virtual void _updateFromParent (void)
 Updates this elements transform based on it's parent. More...
 
virtual bool contains (Real x, Real y) const
 Returns true if xy is within the constraints of the component. More...
 
virtual const DisplayStringgetCaption (void) const
 Gets the caption for this element. More...
 
virtual const ColourValuegetColour (void) const
 Gets the colour for this element. More...
 
Real getHeight (void) const
 Gets the height of this element in relation to the screen (where 1.0 = screen height) More...
 
virtual GuiHorizontalAlignment getHorizontalAlignment (void) const
 Gets the horizontal alignment for this element. More...
 
Real getLeft (void) const
 Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
const LightListgetLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable. More...
 
const MaterialPtrgetMaterial (void) const
 See Renderable. More...
 
virtual const StringgetMaterialName (void) const
 Gets the name of the material this element uses. More...
 
virtual GuiMetricsMode getMetricsMode (void) const
 Retrieves the current settings of how the element metrics are interpreted. More...
 
const StringgetName (void) const
 Gets the name of this overlay. More...
 
OverlayContainergetParent ()
 Returns the parent container. More...
 
const OverlayElementgetSourceTemplate () const
 Returns the SourceTemplate for this element. More...
 
Real getSquaredViewDepth (const Camera *cam) const
 Overridden from Renderable. More...
 
Real getTop (void) const
 Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
More...
 
virtual GuiVerticalAlignment getVerticalAlignment (void) const
 Gets the vertical alignment for this element. More...
 
Real getWidth (void) const
 Gets the width of this element in relation to the screen (where 1.0 = screen width) More...
 
void getWorldTransforms (Matrix4 *xform) const
 See Renderable. More...
 
ushort getZOrder () const
 Returns the zOrder of the element. More...
 
virtual void hide (void)
 Hides this element if it was visible. More...
 
virtual bool isCloneable () const
 
bool isEnabled () const
 
virtual bool isKeyEnabled () const
 
bool isVisible (void) const
 Returns whether or not the element is visible. More...
 
virtual void setCaption (const DisplayString &text)
 Sets the caption on elements that support it. More...
 
virtual void setCloneable (bool c)
 
virtual void setColour (const ColourValue &col)
 Sets the colour on elements that support it. More...
 
void setDimensions (Real width, Real height)
 Sets the dimensions of this element in relation to the screen (1.0 = screen width/height). More...
 
virtual void setEnabled (bool b)
 
void setHeight (Real height)
 Sets the height of this element in relation to the screen (where 1.0 = screen height) More...
 
virtual void setHorizontalAlignment (GuiHorizontalAlignment gha)
 Sets the horizontal origin for this element. More...
 
void setLeft (Real left)
 Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...
 
void setMaterial (const MaterialPtr &mat)
 Sets the the material this element will use. More...
 
void setMaterialName (const String &matName, const String &group=DEFAULT_RESOURCE_GROUP)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void setMetricsMode (GuiMetricsMode gmm)
 Tells this element how to interpret the position and dimension values it is given. More...
 
void setPosition (Real left, Real top)
 Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height) More...
 
void setTop (Real Top)
 Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...
 
virtual void setVerticalAlignment (GuiVerticalAlignment gva)
 Sets the vertical origin for this element. More...
 
void setWidth (Real width)
 Sets the width of this element in relation to the screen (where 1.0 = screen width) More...
 
virtual void show (void)
 Shows this element if it was hidden. More...
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
- Public Member Functions inherited from Ogre::Renderable
 Renderable ()
 
virtual ~Renderable ()
 Virtual destructor needed as class has virtual methods. More...
 
virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...
 
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
const RenderSystemDataPtrgetRenderSystemData () const
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection. More...
 
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view. More...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. More...
 
void setCustomParameter (size_t index, const Vector4 &value)
 Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...
 
void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
void setRenderSystemData (RenderSystemDataPtr val) const
 
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection. More...
 
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view. More...
 
void setUserAny (const Any &anything)
 

Additional Inherited Members

- Public Types inherited from Ogre::OverlayContainer
typedef MapIterator< ChildContainerMapChildContainerIterator
 
typedef std::map< String, OverlayContainer * > ChildContainerMap
 
typedef MapIterator< ChildMapChildIterator
 
typedef std::map< String, OverlayElement * > ChildMap
 
- Public Types inherited from Ogre::Renderable
enum  { DEFAULT_PRIORITY = 100 }
 
typedef SharedPtr< RenderSystemDataRenderSystemDataPtr
 
- Static Public Member Functions inherited from Ogre::StringInterface
static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
 
- Static Public Attributes inherited from Ogre::OverlayElement
static const StringDEFAULT_RESOURCE_GROUP
 

Detailed Description

OverlayElement representing a flat, single-material (or transparent) panel which can contain other elements.

Remarks
This class subclasses OverlayContainer because it can contain other elements. Like other containers, if hidden it's contents are also hidden, if moved it's contents also move etc. The panel itself is a 2D rectangle which is either completely transparent, or is rendered with a single material. The texture(s) on the panel can be tiled depending on your requirements.
This component is suitable for backgrounds and grouping other elements. Note that because it has a single repeating material it cannot have a discrete border (unless the texture has one and the texture is tiled only once). For a bordered panel, see it's subclass BorderPanelOverlayElement.
Note that the material can have all the usual effects applied to it like multiple texture layers, scrolling / animated textures etc. For multiple texture layers, you have to set the tiling level for each layer.

Constructor & Destructor Documentation

◆ PanelOverlayElement()

Ogre::PanelOverlayElement::PanelOverlayElement ( const String name)

Constructor.

◆ ~PanelOverlayElement()

virtual Ogre::PanelOverlayElement::~PanelOverlayElement ( )
virtual

Member Function Documentation

◆ initialise()

virtual void Ogre::PanelOverlayElement::initialise ( void  )
virtual

Initialise.

Reimplemented from Ogre::OverlayContainer.

Reimplemented in Ogre::BorderPanelOverlayElement.

◆ _releaseManualHardwareResources()

virtual void Ogre::PanelOverlayElement::_releaseManualHardwareResources ( )
virtual

Notifies that hardware resources were lost.

Reimplemented from Ogre::OverlayElement.

Reimplemented in Ogre::BorderPanelOverlayElement.

◆ _restoreManualHardwareResources()

virtual void Ogre::PanelOverlayElement::_restoreManualHardwareResources ( )
virtual

Notifies that hardware resources should be restored.

Reimplemented from Ogre::OverlayElement.

Reimplemented in Ogre::BorderPanelOverlayElement.

◆ setTiling()

void Ogre::PanelOverlayElement::setTiling ( Real  x,
Real  y,
ushort  layer = 0 
)

Sets the number of times textures should repeat.

Parameters
xThe number of times the texture should repeat horizontally
yThe number of times the texture should repeat vertically
layerThe texture layer to specify (only needs to be altered if you're using a multi-texture layer material)

◆ getTileX()

Real Ogre::PanelOverlayElement::getTileX ( ushort  layer = 0) const

◆ getTileY()

Real Ogre::PanelOverlayElement::getTileY ( ushort  layer = 0) const

Gets the number of times the texture should repeat vertically.

Parameters
layerThe texture layer to specify (only needs to be altered if you're using a multi-texture layer material)

◆ setUV()

void Ogre::PanelOverlayElement::setUV ( Real  u1,
Real  v1,
Real  u2,
Real  v2 
)

Sets the texture coordinates for the panel.

◆ getUV()

void Ogre::PanelOverlayElement::getUV ( Real u1,
Real v1,
Real u2,
Real v2 
) const

Get the uv coordinates for the panel.

◆ setTransparent()

void Ogre::PanelOverlayElement::setTransparent ( bool  isTransparent)

Sets whether this panel is transparent (used only as a grouping level), or if it is actually rendered.

◆ isTransparent()

bool Ogre::PanelOverlayElement::isTransparent ( void  ) const

Returns whether this panel is transparent.

◆ getTypeName()

virtual const String& Ogre::PanelOverlayElement::getTypeName ( void  ) const
virtual

◆ getRenderOperation()

void Ogre::PanelOverlayElement::getRenderOperation ( RenderOperation op)
virtual

See Renderable.

Implements Ogre::Renderable.

◆ _updateRenderQueue()

void Ogre::PanelOverlayElement::_updateRenderQueue ( RenderQueue queue)
virtual

Overridden from OverlayContainer.

Reimplemented from Ogre::OverlayContainer.


The documentation for this class was generated from the following file: