OGRE  1.12.4
Object-Oriented Graphics Rendering Engine
Ogre::OverlayElement Class Referenceabstract

Abstract definition of a 2D element to be displayed in an Overlay. More...

#include <OgreOverlayElement.h>

+ Inheritance diagram for Ogre::OverlayElement:

Public Types

typedef SharedPtr< RenderSystemDataRenderSystemDataPtr
 

Public Member Functions

 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...
 
virtual void _notifyParent (OverlayContainer *parent, Overlay *overlay)
 Internal method for notifying the GUI element of it's parent and ultimate overlay. More...
 
virtual void _notifyViewport ()
 Internal method to notify the element when the viewport of parent overlay has changed. More...
 
virtual void _notifyWorldTransforms (const Matrix4 &xform)
 Internal method to notify the element when it's world transform of parent overlay has changed. More...
 
virtual ushort _notifyZOrder (ushort newZOrder)
 Internal method to notify the element when Z-order of parent overlay has changed. More...
 
virtual void _positionsOutOfDate (void)
 Tell the object to recalculate. More...
 
virtual void _releaseManualHardwareResources ()
 Notifies that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies that hardware resources should be restored. 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 _update (void)
 Internal method to update the element based on transforms applied. 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 void _updateFromParent (void)
 Updates this elements transform based on it's parent. More...
 
virtual void _updateRenderQueue (RenderQueue *queue)
 Internal method to put the contents onto the render queue. More...
 
virtual OverlayElementclone (const String &instanceName)
 
virtual bool contains (Real x, Real y) const
 Returns true if xy is within the constraints of the component. More...
 
virtual void copyFromTemplate (OverlayElement *templateOverlay)
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
virtual OverlayElementfindElementAt (Real x, Real y)
 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 bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
virtual const ColourValuegetColour (void) const
 Gets the colour for this element. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. 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...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. 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...
 
OverlayContainergetParent ()
 Returns the parent container. More...
 
bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
virtual void getRenderOperation (RenderOperation &op)=0
 Gets the render operation required to send this object to the frame buffer. More...
 
const RenderSystemDataPtrgetRenderSystemData () const
 Gets RenderSystem private data. More...
 
const OverlayElementgetSourceTemplate () const
 Returns the SourceTemplate for this element. More...
 
Real getSquaredViewDepth (const Camera *cam) const
 Overridden from Renderable. More...
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
Real getTop (void) const
 Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...
 
virtual const StringgetTypeName (void) const =0
 Gets the type name of the element. 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...
 
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...
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
virtual void hide (void)
 Hides this element if it was visible. More...
 
virtual void initialise (void)=0
 Initialise gui element. More...
 
virtual bool isCloneable () const
 
virtual bool isContainer () const
 returns false as this class is not a container type More...
 
bool isEnabled () const
 
virtual bool isKeyEnabled () const
 
bool isVisible (void) const
 Returns whether or not the element is visible. 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...
 
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 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 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)
 
virtual void setMetricsMode (GuiMetricsMode gmm)
 Tells this element how to interpret the position and dimension values it is given. 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...
 
void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. 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 setRenderSystemData (RenderSystemDataPtr val) const
 Sets RenderSystem private data. More...
 
void setTop (Real Top)
 Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...
 
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)
 
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...
 

Static Public Member Functions

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

static const StringDEFAULT_RESOURCE_GROUP
 

Detailed Description

Abstract definition of a 2D element to be displayed in an Overlay.

Remarks
This class abstracts all the details of a 2D element which will appear in an overlay. In fact, not all OverlayElement instances can be directly added to an Overlay, only those which are OverlayContainer instances (a subclass of this class). OverlayContainer objects can contain any OverlayElement however. This is just to enforce some level of grouping on widgets.
OverlayElements should be managed using OverlayManager. This class is responsible for instantiating / deleting elements, and also for accepting new types of element from plugins etc.
Note that positions / dimensions of 2D screen elements are expressed as parametric values (0.0 - 1.0) because this makes them resolution-independent. However, most screen resolutions have an aspect ratio of 1.3333:1 (width : height) so note that in physical pixels 0.5 is wider than it is tall, so a 0.5x0.5 panel will not be square on the screen (but it will take up exactly half the screen in both dimensions).
Because this class is designed to be extensible, it subclasses from StringInterface so its parameters can be set in a generic way.

Member Typedef Documentation

◆ RenderSystemDataPtr

Constructor & Destructor Documentation

◆ OverlayElement()

Ogre::OverlayElement::OverlayElement ( const String name)

Constructor: do not call direct, use OverlayManager::createElement.

◆ ~OverlayElement()

virtual Ogre::OverlayElement::~OverlayElement ( )
virtual

Member Function Documentation

◆ initialise()

virtual void Ogre::OverlayElement::initialise ( void  )
pure virtual

◆ _releaseManualHardwareResources()

virtual void Ogre::OverlayElement::_releaseManualHardwareResources ( )
inlinevirtual

Notifies that hardware resources were lost.

Reimplemented in Ogre::PanelOverlayElement, Ogre::BorderPanelOverlayElement, and Ogre::TextAreaOverlayElement.

◆ _restoreManualHardwareResources()

virtual void Ogre::OverlayElement::_restoreManualHardwareResources ( )
inlinevirtual

Notifies that hardware resources should be restored.

Reimplemented in Ogre::PanelOverlayElement, Ogre::BorderPanelOverlayElement, and Ogre::TextAreaOverlayElement.

◆ getName()

const String& Ogre::OverlayElement::getName ( void  ) const

Gets the name of this overlay.

Referenced by Ogre::OverlayContainer::_removeChild().

◆ show()

virtual void Ogre::OverlayElement::show ( void  )
virtual

Shows this element if it was hidden.

◆ hide()

virtual void Ogre::OverlayElement::hide ( void  )
virtual

Hides this element if it was visible.

◆ isVisible()

bool Ogre::OverlayElement::isVisible ( void  ) const

Returns whether or not the element is visible.

◆ isEnabled()

bool Ogre::OverlayElement::isEnabled ( ) const

◆ setEnabled()

virtual void Ogre::OverlayElement::setEnabled ( bool  b)
virtual

◆ setDimensions()

void Ogre::OverlayElement::setDimensions ( Real  width,
Real  height 
)

Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).

◆ setPosition()

void Ogre::OverlayElement::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)

◆ setWidth()

void Ogre::OverlayElement::setWidth ( Real  width)

Sets the width of this element in relation to the screen (where 1.0 = screen width)

◆ getWidth()

Real Ogre::OverlayElement::getWidth ( void  ) const

Gets the width of this element in relation to the screen (where 1.0 = screen width)

◆ setHeight()

void Ogre::OverlayElement::setHeight ( Real  height)

Sets the height of this element in relation to the screen (where 1.0 = screen height)

◆ getHeight()

Real Ogre::OverlayElement::getHeight ( void  ) const

Gets the height of this element in relation to the screen (where 1.0 = screen height)

◆ setLeft()

void Ogre::OverlayElement::setLeft ( Real  left)

Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ getLeft()

Real Ogre::OverlayElement::getLeft ( void  ) const

Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ setTop()

void Ogre::OverlayElement::setTop ( Real  Top)

Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)

◆ getTop()

Real Ogre::OverlayElement::getTop ( void  ) const

Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)

◆ _getLeft()

Real Ogre::OverlayElement::_getLeft ( void  ) const
inline

Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ _getTop()

Real Ogre::OverlayElement::_getTop ( void  ) const
inline

Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right)

◆ _getWidth()

Real Ogre::OverlayElement::_getWidth ( void  ) const
inline

Gets the width of this element in relation to the screen (where 1.0 = screen width)

◆ _getHeight()

Real Ogre::OverlayElement::_getHeight ( void  ) const
inline

Gets the height of this element in relation to the screen (where 1.0 = screen height)

◆ _setLeft()

void Ogre::OverlayElement::_setLeft ( Real  left)

Sets the left of this element in relation to the screen (where 1.0 = screen width)

◆ _setTop()

void Ogre::OverlayElement::_setTop ( Real  top)

Sets the top of this element in relation to the screen (where 1.0 = screen width)

◆ _setWidth()

void Ogre::OverlayElement::_setWidth ( Real  width)

Sets the width of this element in relation to the screen (where 1.0 = screen width)

◆ _setHeight()

void Ogre::OverlayElement::_setHeight ( Real  height)

Sets the height of this element in relation to the screen (where 1.0 = screen width)

◆ _setPosition()

void Ogre::OverlayElement::_setPosition ( Real  left,
Real  top 
)

Sets the left and top of this element in relation to the screen (where 1.0 = screen width)

◆ _setDimensions()

void Ogre::OverlayElement::_setDimensions ( Real  width,
Real  height 
)

Sets the width and height of this element in relation to the screen (where 1.0 = screen width)

◆ getMaterialName()

virtual const String& Ogre::OverlayElement::getMaterialName ( void  ) const
virtual

Gets the name of the material this element uses.

◆ setMaterial()

void Ogre::OverlayElement::setMaterial ( const MaterialPtr mat)

Sets the the material this element will use.

Remarks
Different elements will use different materials. One constant about them all though is that a Material used for a OverlayElement must have it's depth checking set to 'off', which means it always gets rendered on top. OGRE will set this flag for you if necessary. What it does mean though is that you should not use the same Material for rendering OverlayElements as standard scene objects. It's fine to use the same textures, just not the same Material.

◆ setMaterialName()

void Ogre::OverlayElement::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.

◆ getMaterial()

const MaterialPtr& Ogre::OverlayElement::getMaterial ( void  ) const
virtual

See Renderable.

Implements Ogre::Renderable.

Reimplemented in Ogre::TextAreaOverlayElement.

◆ getWorldTransforms()

void Ogre::OverlayElement::getWorldTransforms ( Matrix4 xform) const
virtual

◆ _positionsOutOfDate()

virtual void Ogre::OverlayElement::_positionsOutOfDate ( void  )
virtual

Tell the object to recalculate.

Reimplemented in Ogre::OverlayContainer.

◆ _update()

virtual void Ogre::OverlayElement::_update ( void  )
virtual

Internal method to update the element based on transforms applied.

Reimplemented in Ogre::BorderPanelOverlayElement, Ogre::TextAreaOverlayElement, and Ogre::OverlayContainer.

◆ _updateFromParent()

virtual void Ogre::OverlayElement::_updateFromParent ( void  )
virtual

Updates this elements transform based on it's parent.

◆ _notifyParent()

virtual void Ogre::OverlayElement::_notifyParent ( OverlayContainer parent,
Overlay overlay 
)
virtual

Internal method for notifying the GUI element of it's parent and ultimate overlay.

Reimplemented in Ogre::OverlayContainer.

◆ _getDerivedLeft()

virtual Real Ogre::OverlayElement::_getDerivedLeft ( void  )
virtual

Gets the 'left' position as derived from own left and that of parents.

◆ _getDerivedTop()

virtual Real Ogre::OverlayElement::_getDerivedTop ( void  )
virtual

Gets the 'top' position as derived from own left and that of parents.

◆ _getRelativeWidth()

virtual Real Ogre::OverlayElement::_getRelativeWidth ( void  )
virtual

Gets the 'width' as derived from own width and metrics mode.

◆ _getRelativeHeight()

virtual Real Ogre::OverlayElement::_getRelativeHeight ( void  )
virtual

Gets the 'height' as derived from own height and metrics mode.

◆ _getClippingRegion()

virtual void Ogre::OverlayElement::_getClippingRegion ( RealRect clippingRegion)
virtual

Gets the clipping region of the element.

◆ _notifyZOrder()

virtual ushort Ogre::OverlayElement::_notifyZOrder ( ushort  newZOrder)
virtual

Internal method to notify the element when Z-order of parent overlay has changed.

Remarks
Overlays have explicit Z-orders. OverlayElements do not, they inherit the Z-order of the overlay, and the Z-order is incremented for every container nested within this to ensure that containers are displayed behind contained items. This method is used internally to notify the element of a change in final Z-order which is used to render the element.
Returns
Return the next Z-ordering number available. For single elements, this is simply 'newZOrder + 1', except for containers. They increment it once for each child (or even more if those children are also containers with their own elements).

Reimplemented in Ogre::OverlayContainer.

◆ _notifyWorldTransforms()

virtual void Ogre::OverlayElement::_notifyWorldTransforms ( const Matrix4 xform)
virtual

Internal method to notify the element when it's world transform of parent overlay has changed.

Reimplemented in Ogre::OverlayContainer.

◆ _notifyViewport()

virtual void Ogre::OverlayElement::_notifyViewport ( )
virtual

Internal method to notify the element when the viewport of parent overlay has changed.

Reimplemented in Ogre::OverlayContainer.

◆ _updateRenderQueue()

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

Internal method to put the contents onto the render queue.

Reimplemented in Ogre::BorderPanelOverlayElement, Ogre::OverlayContainer, and Ogre::PanelOverlayElement.

◆ visitRenderables()

void Ogre::OverlayElement::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.

Parameters
visitorPointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderablesIf false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

◆ getTypeName()

virtual const String& Ogre::OverlayElement::getTypeName ( void  ) const
pure virtual

Gets the type name of the element.

All concrete subclasses must implement this.

Implemented in Ogre::PanelOverlayElement, Ogre::TextAreaOverlayElement, and Ogre::BorderPanelOverlayElement.

◆ setCaption()

virtual void Ogre::OverlayElement::setCaption ( const DisplayString text)
virtual

Sets the caption on elements that support it.

Remarks
This property doesn't do something on all elements, just those that support it. However, being a common requirement it is in the top-level interface to avoid having to set it via the StringInterface all the time.

Reimplemented in Ogre::TextAreaOverlayElement.

◆ getCaption()

virtual const DisplayString& Ogre::OverlayElement::getCaption ( void  ) const
virtual

Gets the caption for this element.

◆ setColour()

virtual void Ogre::OverlayElement::setColour ( const ColourValue col)
virtual

Sets the colour on elements that support it.

Remarks
This property doesn't do something on all elements, just those that support it. However, being a common requirement it is in the top-level interface to avoid having to set it via the StringInterface all the time.

Reimplemented in Ogre::TextAreaOverlayElement.

◆ getColour()

virtual const ColourValue& Ogre::OverlayElement::getColour ( void  ) const
virtual

Gets the colour for this element.

Reimplemented in Ogre::TextAreaOverlayElement.

◆ setMetricsMode()

virtual void Ogre::OverlayElement::setMetricsMode ( GuiMetricsMode  gmm)
virtual

Tells this element how to interpret the position and dimension values it is given.

Remarks
By default, OverlayElements are positioned and sized according to relative dimensions of the screen. This is to ensure portability between different resolutions when you want things to be positioned and sized the same way across all resolutions. However, sometimes you want things to be sized according to fixed pixels. In order to do this, you can call this method with the parameter GMM_PIXELS. Note that if you then want to place your element relative to the center, right or bottom of it's parent, you will need to use the setHorizontalAlignment and setVerticalAlignment methods.

Reimplemented in Ogre::BorderPanelOverlayElement, and Ogre::TextAreaOverlayElement.

◆ getMetricsMode()

virtual GuiMetricsMode Ogre::OverlayElement::getMetricsMode ( void  ) const
virtual

Retrieves the current settings of how the element metrics are interpreted.

◆ setHorizontalAlignment()

virtual void Ogre::OverlayElement::setHorizontalAlignment ( GuiHorizontalAlignment  gha)
virtual

Sets the horizontal origin for this element.

Remarks
By default, the horizontal origin for a OverlayElement is the left edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-based metrics (see setMetricsMode) since in this mode you can't use relative positioning.
For example, if you were using GMM_PIXELS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use GHA_CENTER with a 'left' property of -15.
Note that neither GHA_CENTER or GHA_RIGHT alter the position of the element based on it's width, you have to alter the 'left' to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and right with different 'left' offsets for maximum flexibility.

◆ getHorizontalAlignment()

virtual GuiHorizontalAlignment Ogre::OverlayElement::getHorizontalAlignment ( void  ) const
virtual

Gets the horizontal alignment for this element.

◆ setVerticalAlignment()

virtual void Ogre::OverlayElement::setVerticalAlignment ( GuiVerticalAlignment  gva)
virtual

Sets the vertical origin for this element.

Remarks
By default, the vertical origin for a OverlayElement is the top edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-based metrics (see setMetricsMode) since in this mode you can't use relative positioning.
For example, if you were using GMM_PIXELS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use GHA_CENTER with a 'top' property of -15.
Note that neither GVA_CENTER or GVA_BOTTOM alter the position of the element based on it's height, you have to alter the 'top' to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and bottom with different 'top' offsets for maximum flexibility.

◆ getVerticalAlignment()

virtual GuiVerticalAlignment Ogre::OverlayElement::getVerticalAlignment ( void  ) const
virtual

Gets the vertical alignment for this element.

◆ contains()

virtual bool Ogre::OverlayElement::contains ( Real  x,
Real  y 
) const
virtual

Returns true if xy is within the constraints of the component.

◆ findElementAt()

virtual OverlayElement* Ogre::OverlayElement::findElementAt ( Real  x,
Real  y 
)
virtual

Returns true if xy is within the constraints of the component.

Reimplemented in Ogre::OverlayContainer.

◆ isContainer()

virtual bool Ogre::OverlayElement::isContainer ( ) const
inlinevirtual

returns false as this class is not a container type

Reimplemented in Ogre::OverlayContainer.

◆ isKeyEnabled()

virtual bool Ogre::OverlayElement::isKeyEnabled ( ) const
inlinevirtual

◆ isCloneable()

virtual bool Ogre::OverlayElement::isCloneable ( ) const
inlinevirtual

◆ setCloneable()

virtual void Ogre::OverlayElement::setCloneable ( bool  c)
inlinevirtual

◆ getParent()

OverlayContainer* Ogre::OverlayElement::getParent ( )

Returns the parent container.

◆ _setParent()

void Ogre::OverlayElement::_setParent ( OverlayContainer parent)
inline

◆ getZOrder()

ushort Ogre::OverlayElement::getZOrder ( ) const
inline

Returns the zOrder of the element.

◆ getSquaredViewDepth()

Real Ogre::OverlayElement::getSquaredViewDepth ( const Camera cam) const
inlinevirtual

Overridden from Renderable.

Implements Ogre::Renderable.

Referenced by Ogre::BorderRenderable::getSquaredViewDepth().

◆ getLights()

const LightList& Ogre::OverlayElement::getLights ( void  ) const
inlinevirtual

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks
Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

◆ copyFromTemplate()

virtual void Ogre::OverlayElement::copyFromTemplate ( OverlayElement templateOverlay)
virtual

Reimplemented in Ogre::OverlayContainer.

◆ clone()

virtual OverlayElement* Ogre::OverlayElement::clone ( const String instanceName)
virtual

Reimplemented in Ogre::OverlayContainer.

◆ getSourceTemplate()

const OverlayElement* Ogre::OverlayElement::getSourceTemplate ( ) const
inline

Returns the SourceTemplate for this element.

◆ getParamDictionary() [1/2]

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  )
inlineinherited

Retrieves the parameter dictionary for this class.

Remarks
Only valid to call this after createParamDictionary.
Returns
Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

◆ getParamDictionary() [2/2]

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void  ) const
inlineinherited

◆ getParameters()

const ParameterList& Ogre::StringInterface::getParameters ( void  ) const
inherited

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.

◆ setParameter()

bool Ogre::StringInterface::setParameter ( const String name,
const String value 
)
inherited

Generic parameter setting method.

Remarks
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
nameThe name of the parameter to set
valueString value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.
Returns
true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

◆ setParameterList()

void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
inherited

Generic multiple parameter setting method.

Remarks
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.
Parameters
paramListName/value pair list

◆ getParameter()

String Ogre::StringInterface::getParameter ( const String name) const
inlineinherited

Generic parameter retrieval method.

Remarks
Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.
Parameters
nameThe name of the parameter to get
Returns
String value of parameter, blank if not found

References Ogre::ParamCommand::doGet().

◆ copyParametersTo()

void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlineinherited

Method for copying this object's parameters to another object.

Remarks
This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.
Any unrecognised parameters will be ignored as with setParameter method.
Parameters
destPointer to object to have it's parameters set the same as this object.

References Ogre::StringInterface::setParameter().

◆ cleanupDictionary()

static void Ogre::StringInterface::cleanupDictionary ( )
staticinherited

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.

MaterialManager) initializes.

◆ getTechnique()

virtual Technique* Ogre::Renderable::getTechnique ( void  ) const
inlinevirtualinherited

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks
This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::InstanceBatch, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

◆ getRenderOperation()

◆ preRender()

virtual bool Ogre::Renderable::preRender ( SceneManager sm,
RenderSystem rsys 
)
inlinevirtualinherited

Called just prior to the Renderable being rendered.

Remarks
OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.
This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.
Returns
true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Reimplemented in Ogre::BillboardChain.

◆ postRender()

virtual void Ogre::Renderable::postRender ( SceneManager sm,
RenderSystem rsys 
)
inlinevirtualinherited

Called immediately after the Renderable has been rendered.

◆ getNumWorldTransforms()

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void  ) const
inlinevirtualinherited

Returns the number of world transform matrices this renderable requires.

Remarks
When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.

◆ setUseIdentityProjection()

void Ogre::Renderable::setUseIdentityProjection ( bool  useIdentityProjection)
inlineinherited

Sets whether or not to use an 'identity' projection.

Remarks
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this. The default is false.
See also
Renderable::getUseIdentityProjection

◆ getUseIdentityProjection()

bool Ogre::Renderable::getUseIdentityProjection ( void  ) const
inlineinherited

Returns whether or not to use an 'identity' projection.

Remarks
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this.
See also
Renderable::setUseIdentityProjection

◆ setUseIdentityView()

void Ogre::Renderable::setUseIdentityView ( bool  useIdentityView)
inlineinherited

Sets whether or not to use an 'identity' view.

Remarks
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this. The default is false.
See also
Renderable::getUseIdentityView

◆ getUseIdentityView()

bool Ogre::Renderable::getUseIdentityView ( void  ) const
inlineinherited

Returns whether or not to use an 'identity' view.

Remarks
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this.
See also
Renderable::setUseIdentityView

◆ getCastsShadows()

virtual bool Ogre::Renderable::getCastsShadows ( void  ) const
inlinevirtualinherited

Method which reports whether this renderable would normally cast a shadow.

Remarks
Subclasses should override this if they could have been used to generate a shadow.

Reimplemented in Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

◆ setCustomParameter()

void Ogre::Renderable::setCustomParameter ( size_t  index,
const Vector4 value 
)
inlineinherited

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks
Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.
Parameters
indexThe index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
valueThe value to associate.

◆ removeCustomParameter()

void Ogre::Renderable::removeCustomParameter ( size_t  index)
inlineinherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to remove.
See also
setCustomParameter for full details.

◆ hasCustomParameter()

bool Ogre::Renderable::hasCustomParameter ( size_t  index) const
inlineinherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to check for existence.
See also
setCustomParameter for full details.

◆ getCustomParameter()

const Vector4& Ogre::Renderable::getCustomParameter ( size_t  index) const
inlineinherited

Gets the custom value associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to retrieve.
See also
setCustomParameter for full details.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

◆ _updateCustomGpuParameter()

virtual void Ogre::Renderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry constantEntry,
GpuProgramParameters params 
) const
inlinevirtualinherited

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks
This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.
You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.
Parameters
constantEntryThe auto constant entry referring to the parameter being updated
paramsThe parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.

◆ setPolygonModeOverrideable()

void Ogre::Renderable::setPolygonModeOverrideable ( bool  override)
inlineinherited

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Parameters
overridetrue means that a lower camera detail will override this renderables detail level, false means it won't.

◆ getPolygonModeOverrideable()

bool Ogre::Renderable::getPolygonModeOverrideable ( void  ) const
inlineinherited

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Referenced by Ogre::BorderRenderable::getPolygonModeOverrideable().

◆ setUserAny()

void Ogre::Renderable::setUserAny ( const Any anything)
inlineinherited
Deprecated:
use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

Remarks
This method allows you to associate any user value you like with this Renderable. This can be a pointer back to one of your own classes for instance.

Referenced by Ogre::InstanceBatch::getRenderOperation().

◆ getUserAny()

const Any& Ogre::Renderable::getUserAny ( void  ) const
inlineinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Referenced by Ogre::InstanceBatch::getRenderOperation().

◆ getUserObjectBindings() [1/2]

UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( )
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

◆ getUserObjectBindings() [2/2]

const UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( ) const
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

◆ getRenderSystemData()

const RenderSystemDataPtr& Ogre::Renderable::getRenderSystemData ( ) const
inlineinherited

Gets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

◆ setRenderSystemData()

void Ogre::Renderable::setRenderSystemData ( RenderSystemDataPtr  val) const
inlineinherited

Sets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Member Data Documentation

◆ DEFAULT_RESOURCE_GROUP

const String& Ogre::OverlayElement::DEFAULT_RESOURCE_GROUP
static

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