Ogre::v1::OverlayElement Class Reference

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

#include <OgreOverlayElement.h>

Inheritance diagram for Ogre::v1::OverlayElement:

Public Member Functions
	OverlayElement (const String &name)
	Constructor: do not call direct, use OverlayManager::createElement. More...
	~OverlayElement () override
virtual void	_getClippingRegion (RealRect &clippingRegion)
	Gets the clipping region of the element. More...
virtual Real	_getDerivedLeft ()
	Gets the 'left' position as derived from own left and that of parents. More...
virtual Real	_getDerivedTop ()
	Gets the 'top' position as derived from own left and that of parents. More...
Real	_getHeight () const
	Gets the height of this element in relation to the screen (where 1.0 = screen height) More...
Real	_getLeft () const
	Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...
virtual Real	_getRelativeHeight ()
	Gets the 'height' as derived from own height and metrics mode. More...
virtual Real	_getRelativeWidth ()
	Gets the 'width' as derived from own width and metrics mode. More...
Real	_getTop () const
	Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...
Real	_getWidth () 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	_positionsOutOfDate ()
	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 ()
	Internal method to update the element based on transforms applied. More...
virtual void	_updateFromParent ()
	Updates this elements transform based on it's parent. More...
virtual void	_updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera)
	Internal method to put the contents onto the render queue. More...
virtual OverlayElement *	clone (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)
virtual OverlayElement *	findElementAt (Real x, Real y)
	Returns true if xy is within the constraints of the component. More...
virtual const DisplayString &	getCaption () const
	Gets the caption for this element. More...
virtual const ColourValue &	getColour () const
	Gets the colour for this element. More...
Real	getHeight () const
	Gets the height of this element in relation to the screen (where 1.0 = screen height) More...
virtual GuiHorizontalAlignment	getHorizontalAlignment () const
	Gets the horizontal alignment for this element. More...
Real	getLeft () const
	Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...
const LightList &	getLights () const override
	Gets a list of lights, ordered relative to how close they are to this renderable. More...
const MaterialPtr &	getMaterial () const
	See Renderable. More...
virtual const String &	getMaterialName () const
	Gets the name of the material this element uses. More...
virtual GuiMetricsMode	getMetricsMode () const
	Retrieves the current settings of how the element metrics are interpreted. More...
const String &	getName () const
	Gets the name of this overlay. More...
OverlayContainer *	getParent ()
	Returns the parent container. More...
const OverlayElement *	getSourceTemplate () const
	Returns the SourceTemplate for this element. More...
Real	getTop () const
	Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...
virtual const String &	getTypeName () const =0
	Gets the type name of the element. More...
virtual GuiVerticalAlignment	getVerticalAlignment () const
	Gets the vertical alignment for this element. More...
Real	getWidth () const
	Gets the width of this element in relation to the screen (where 1.0 = screen width) More...
void	getWorldTransforms (Matrix4 *xform) const override
	See Renderable. More...
virtual void	hide ()
	Hides this element if it was visible. More...
virtual void	initialise ()=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 () 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...
virtual void	setMaterialName (const String &matName)
	Sets the name of the material this element will use. 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 ()
	Shows this element if it was hidden. More...
Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()
virtual	~StringInterface ()
	Virtual destructor, see Effective C++. More...
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object. More...
ParamDictionary *	getParamDictionary ()
	Retrieves the parameter dictionary for this class. More...
const ParamDictionary *	getParamDictionary () const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method. More...
const ParameterList &	getParameters () const
	Retrieves a list of parameters valid for this object. More...
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method. More...
virtual 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	_setHlmsHashes (uint32 hash, uint32 casterHash)
	Manually sets the hlms hashes. Don't call this directly. More...
virtual void	_setNullDatablock ()
	Sets the datablock to a null pointer. 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...
void	addPoseWeight (size_t index, float w)
virtual bool	getCastsShadows () const
	Method which reports whether this renderable would normally cast a shadow. More...
uint8	getCurrentMaterialLod () const
const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index. More...
const CustomParameterMap &	getCustomParameters () const
HlmsDatablock *	getDatablock () const
const String &	getDatablockOrMaterialName () const
uint32	getHlmsCasterHash () const
uint32	getHlmsHash () const
MaterialPtr	getMaterial () const
	Retrieves the material this renderable object uses. More...
unsigned short	getNumPoses () const
virtual unsigned short	getNumWorldTransforms () const
	Returns the number of world transform matrices this renderable requires. More...
virtual bool	getPolygonModeOverrideable () const
	Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
bool	getPoseHalfPrecision () const
bool	getPoseNormals () const
TexBufferPacked *	getPoseTexBuffer () const
float	getPoseWeight (size_t index) const
float *	getPoseWeights () const
virtual void	getRenderOperation (v1::RenderOperation &op, bool casterPass)=0
	Gets the render operation required to send this object to the frame buffer. More...
uint8	getRenderQueueSubGroup () const
bool	getUseIdentityProjection () const
	Returns whether or not to use an 'identity' projection. More...
bool	getUseIdentityView () const
	Returns whether or not to use an 'identity' view. More...
virtual bool	getUseIdentityViewProjMatrixIsDynamic () const
	Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization) More...
virtual bool	getUseIdentityWorldMatrix () const
	Returns whether the world matrix is an identity matrix. More...
virtual OGRE_DEPRECATED const Any &	getUserAny () const
UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class. More...
const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class. More...
const VertexArrayObjectArray &	getVaos (VertexPass vertexPass) const
bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index. More...
bool	hasSkeletonAnimation () const
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...
virtual void	setDatablock (HlmsDatablock *datablock)
	Assigns a datablock (i.e. HLMS Material) to this renderable. More...
void	setDatablock (IdString datablockName)
	Assigns a datablock (i.e. More...
void	setDatablockOrMaterialName (String materialName, String groupName)
	First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials. More...
virtual void	setMaterial (const MaterialPtr &material)
	Sets the given material. Overrides HLMS materials. More...
void	setMaterialName (const String &name, const String &groupName)
	Sets the name of the Material to be used. Prefer using HLMS. More...
virtual void	setPolygonModeOverrideable (bool override)
	Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
void	setPoseWeight (size_t index, float w)
void	setRenderQueueSubGroup (uint8 subGroup)
	Sets the render queue sub group. 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...
virtual OGRE_DEPRECATED void	setUserAny (const Any &anything)

Additional Inherited Members
Public Types inherited from Ogre::Renderable
typedef map< size_t, Vector4 >::type	CustomParameterMap
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 Member Functions inherited from Ogre::Renderable
static uint8	getDefaultRenderQueueSubGroup ()
static void	setDefaultRenderQueueSubGroup (uint8 subGroup)
	Sets the default render queue sub group for all future Renderable instances. More...
Public Attributes inherited from Ogre::Renderable
uint8	mCustomParameter
uint32	mHlmsGlobalIndex
	Index in the vector holding this Rendrable reference in the HLMS datablock. More...
bool	mRenderableVisible
	Control visibility at Renderable (e.g. More...

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.

Constructor & Destructor Documentation

OverlayElement()

Ogre::v1::OverlayElement::OverlayElement

(

const String &

name

)

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

~OverlayElement()

Ogre::v1::OverlayElement::~OverlayElement ( )

override

Member Function Documentation

_getClippingRegion()

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

virtual

Gets the clipping region of the element.

_getDerivedLeft()

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

virtual

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

_getDerivedTop()

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

virtual

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

_getHeight()

Real Ogre::v1::OverlayElement::_getHeight ( ) const

inline

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

_getLeft()

Real Ogre::v1::OverlayElement::_getLeft ( ) const

inline

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

_getRelativeHeight()

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

virtual

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

_getRelativeWidth()

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

virtual

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

_getTop()

Real Ogre::v1::OverlayElement::_getTop ( ) const

inline

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

_getWidth()

Real Ogre::v1::OverlayElement::_getWidth ( ) const

inline

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

_notifyParent()

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

virtual

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

Reimplemented in Ogre::v1::OverlayContainer.

_notifyViewport()

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

virtual

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

Reimplemented in Ogre::v1::OverlayContainer.

_positionsOutOfDate()

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

virtual

Tell the object to recalculate.

Reimplemented in Ogre::v1::OverlayContainer.

_releaseManualHardwareResources()

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

inlinevirtual

Notifies that hardware resources were lost.

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

_restoreManualHardwareResources()

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

inlinevirtual

Notifies that hardware resources should be restored.

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

_setDimensions()

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

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

_setHeight()

void Ogre::v1::OverlayElement::_setHeight

(

Real

height

)

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

_setLeft()

void Ogre::v1::OverlayElement::_setLeft

(

Real

left

)

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

_setParent()

void Ogre::v1::OverlayElement::_setParent ( OverlayContainer *  parent )

inline

_setPosition()

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

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

_setTop()

void Ogre::v1::OverlayElement::_setTop

(

Real

top

)

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

_setWidth()

void Ogre::v1::OverlayElement::_setWidth

(

Real

width

)

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

_update()

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

virtual

Internal method to update the element based on transforms applied.

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

_updateFromParent()

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

virtual

Updates this elements transform based on it's parent.

_updateRenderQueue()

virtual void Ogre::v1::OverlayElement::_updateRenderQueue ( RenderQueue *  queue, Camera *  camera, const Camera *  lodCamera  )

virtual

Internal method to put the contents onto the render queue.

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

clone()

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

virtual

Reimplemented in Ogre::v1::OverlayContainer.

contains()

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

virtual

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

copyFromTemplate()

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

virtual

Reimplemented in Ogre::v1::OverlayContainer.

findElementAt()

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

virtual

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

Reimplemented in Ogre::v1::OverlayContainer.

getCaption()

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

virtual

Gets the caption for this element.

getColour()

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

virtual

Gets the colour for this element.

Reimplemented in Ogre::v1::TextAreaOverlayElement.

getHeight()

Real Ogre::v1::OverlayElement::getHeight

(

)

const

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

getHorizontalAlignment()

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

virtual

Gets the horizontal alignment for this element.

getLeft()

Real Ogre::v1::OverlayElement::getLeft

(

)

const

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

getLights()

const LightList& Ogre::v1::OverlayElement::getLights ( ) const

inlineoverridevirtual

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.

getMaterial()

const MaterialPtr& Ogre::v1::OverlayElement::getMaterial

(

)

const

See Renderable.

getMaterialName()

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

virtual

Gets the name of the material this element uses.

getMetricsMode()

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

virtual

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

getName()

const String& Ogre::v1::OverlayElement::getName

(

)

const

Gets the name of this overlay.

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

getParent()

OverlayContainer* Ogre::v1::OverlayElement::getParent

(

)

Returns the parent container.

getSourceTemplate()

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

inline

Returns the SourceTemplate for this element.

getTop()

Real Ogre::v1::OverlayElement::getTop

(

)

const

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

getTypeName()

virtual const String& Ogre::v1::OverlayElement::getTypeName ( ) const

pure virtual

Gets the type name of the element.

All concrete subclasses must implement this.

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

getVerticalAlignment()

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

virtual

Gets the vertical alignment for this element.

getWidth()

Real Ogre::v1::OverlayElement::getWidth

(

)

const

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

getWorldTransforms()

void Ogre::v1::OverlayElement::getWorldTransforms ( Matrix4 *  xform ) const

overridevirtual

See Renderable.

Implements Ogre::Renderable.

Referenced by Ogre::v1::BorderRenderable::getWorldTransforms().

hide()

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

virtual

Hides this element if it was visible.

initialise()

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

pure virtual

Initialise gui element.

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

isCloneable()

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

inlinevirtual

isContainer()

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

inlinevirtual

returns false as this class is not a container type

Reimplemented in Ogre::v1::OverlayContainer.

isEnabled()

bool Ogre::v1::OverlayElement::isEnabled

(

)

const

isKeyEnabled()

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

inlinevirtual

isVisible()

bool Ogre::v1::OverlayElement::isVisible

(

)

const

Returns whether or not the element is visible.

setCaption()

virtual void Ogre::v1::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::v1::TextAreaOverlayElement.

setCloneable()

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

inlinevirtual

setColour()

virtual void Ogre::v1::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::v1::TextAreaOverlayElement.

setDimensions()

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

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

setEnabled()

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

virtual

setHeight()

void Ogre::v1::OverlayElement::setHeight

(

Real

height

)

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

setHorizontalAlignment()

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

setLeft()

void Ogre::v1::OverlayElement::setLeft

(

Real

left

)

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

setMaterialName()

virtual void Ogre::v1::OverlayElement::setMaterialName ( const String &  matName )

virtual

Sets the name of 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.

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

setMetricsMode()

virtual void Ogre::v1::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::v1::TextAreaOverlayElement, and Ogre::v1::BorderPanelOverlayElement.

setPosition()

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

setTop()

void Ogre::v1::OverlayElement::setTop

(

Real

Top

)

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

setVerticalAlignment()

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

setWidth()

void Ogre::v1::OverlayElement::setWidth

(

Real

width

)

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

show()

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

virtual

Shows this element if it was hidden.

---

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

• OgreOverlayElement.h