This class implements an overlay element which contains simple unformatted text. More...

#include <OgreTextAreaOverlayElement.h>

Inheritance diagram for Ogre::v1::TextAreaOverlayElement:

Classes
class	CmdAlignment
	Command object for setting the alignment. More...

class	CmdCaption
	Command object for setting the caption. More...

class	CmdCharHeight
	Command object for setting the char height. More...

class	CmdColour
	Command object for setting the constant colour. More...

class	CmdColourBottom
	Command object for setting the bottom colour. More...

class	CmdColourTop
	Command object for setting the top colour. More...

class	CmdFontName
	Command object for setting the caption. More...

class	CmdSpaceWidth
	Command object for setting the width of a space. More...

Public Types
enum	Alignment { Left , Right , Center }

Public Types inherited from Ogre::Renderable
typedef map< size_t, Vector4 >::type	CustomParameterMap

Public Member Functions
	TextAreaOverlayElement (const String &name)
	Constructor. More...

	~TextAreaOverlayElement () override

void	_releaseManualHardwareResources () override

void	_restoreManualHardwareResources () override

void	_update () override
	Overridden from OverlayElement. More...

Alignment	getAlignment () const

Real	getCharHeight () const

const ColourValue &	getColour () const override
	Gets the colour of the text. More...

const ColourValue &	getColourBottom () const
	Gets the colour of the bottom of the letters. More...

const ColourValue &	getColourTop () const
	Gets the colour of the top of the letters. More...

const String &	getFontName () const

const MaterialPtr &	getMaterial () const
	See Renderable. More...

void	getRenderOperation (v1::RenderOperation &op, bool casterPass) override
	See Renderable. More...

Real	getSpaceWidth () const

const String &	getTypeName () const override
	See OverlayElement. More...

void	initialise () override
	Initialise gui element. More...

void	setAlignment (Alignment a)

void	setCaption (const DisplayString &text) override
	Sets the caption on elements that support it. More...

void	setCharHeight (Real height)

void	setColour (const ColourValue &col) override
	Sets the colour of the text. More...

void	setColourBottom (const ColourValue &col)
	Sets the colour of the bottom of the letters. More...

void	setColourTop (const ColourValue &col)
	Sets the colour of the top of the letters. More...

void	setFontName (const String &font)

void	setMaterialName (const String &matName) override
	Overridden from OverlayElement. More...

void	setMetricsMode (GuiMetricsMode gmm) override
	Overridden from OverlayElement. More...

void	setSpaceWidth (Real width)

Public Member Functions inherited from Ogre::v1::OverlayElement
	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...

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 ()
	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...

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 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 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	setCloneable (bool c)

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	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 ParticleType::ParticleType	getParticleType () const
	Used by ParticleSystemDef to indicate Hlms they want specific shader code. 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

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	resetMaterialLod ()
	Sets mCurrentMaterialLod to 0. 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
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

This class implements an overlay element which contains simple unformatted text.

Member Enumeration Documentation

◆ Alignment

enum Ogre::v1::TextAreaOverlayElement::Alignment

Enumerator
Left
Right
Center

Constructor & Destructor Documentation

◆ TextAreaOverlayElement()

Ogre::v1::TextAreaOverlayElement::TextAreaOverlayElement ( const String & name )

Constructor.

◆ ~TextAreaOverlayElement()

Ogre::v1::TextAreaOverlayElement::~TextAreaOverlayElement ( )

override

Member Function Documentation

◆ _releaseManualHardwareResources()

void Ogre::v1::TextAreaOverlayElement::_releaseManualHardwareResources ( )

overridevirtual

Reimplemented from Ogre::v1::OverlayElement.

◆ _restoreManualHardwareResources()

void Ogre::v1::TextAreaOverlayElement::_restoreManualHardwareResources ( )

overridevirtual

Reimplemented from Ogre::v1::OverlayElement.

◆ _update()

void Ogre::v1::TextAreaOverlayElement::_update ( )

overridevirtual

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ getAlignment()

Alignment Ogre::v1::TextAreaOverlayElement::getAlignment ( ) const

inline

◆ getCharHeight()

Real Ogre::v1::TextAreaOverlayElement::getCharHeight ( ) const

◆ getColour()

const ColourValue& Ogre::v1::TextAreaOverlayElement::getColour ( ) const

overridevirtual

Gets the colour of the text.

Reimplemented from Ogre::v1::OverlayElement.

◆ getColourBottom()

const ColourValue& Ogre::v1::TextAreaOverlayElement::getColourBottom ( ) const

Gets the colour of the bottom of the letters.

◆ getColourTop()

const ColourValue& Ogre::v1::TextAreaOverlayElement::getColourTop ( ) const

Gets the colour of the top of the letters.

◆ getFontName()

const String& Ogre::v1::TextAreaOverlayElement::getFontName ( ) const

◆ getMaterial()

const MaterialPtr& Ogre::v1::TextAreaOverlayElement::getMaterial ( ) const

See Renderable.

◆ getRenderOperation()

void Ogre::v1::TextAreaOverlayElement::getRenderOperation	(	v1::RenderOperation &	op,
		bool	casterPass
	)

overridevirtual

See Renderable.

Implements Ogre::Renderable.

◆ getSpaceWidth()

Real Ogre::v1::TextAreaOverlayElement::getSpaceWidth ( ) const

◆ getTypeName()

const String& Ogre::v1::TextAreaOverlayElement::getTypeName ( ) const

overridevirtual

See OverlayElement.

Implements Ogre::v1::OverlayElement.

◆ initialise()

void Ogre::v1::TextAreaOverlayElement::initialise ( )

overridevirtual

Initialise gui element.

Implements Ogre::v1::OverlayElement.

◆ setAlignment()

void Ogre::v1::TextAreaOverlayElement::setAlignment ( Alignment a )

inline

◆ setCaption()

void Ogre::v1::TextAreaOverlayElement::setCaption ( const DisplayString & text )

overridevirtual

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

◆ setCharHeight()

void Ogre::v1::TextAreaOverlayElement::setCharHeight ( Real height )

◆ setColour()

void Ogre::v1::TextAreaOverlayElement::setColour ( const ColourValue & col )

overridevirtual

Sets the colour of the text.

Remarks: This method establishes a constant colour for the entire text. Also see setColourBottom and setColourTop which allow you to set a colour gradient.

Reimplemented from Ogre::v1::OverlayElement.

◆ setColourBottom()

void Ogre::v1::TextAreaOverlayElement::setColourBottom ( const ColourValue & col )

Sets the colour of the bottom of the letters.

Remarks: By setting a separate top and bottom colour, you can create a text area which has a graduated colour effect to it.

◆ setColourTop()

void Ogre::v1::TextAreaOverlayElement::setColourTop ( const ColourValue & col )

Sets the colour of the top of the letters.

Remarks: By setting a separate top and bottom colour, you can create a text area which has a graduated colour effect to it.

◆ setFontName()

void Ogre::v1::TextAreaOverlayElement::setFontName ( const String & font )

◆ setMaterialName()

void Ogre::v1::TextAreaOverlayElement::setMaterialName ( const String & matName )

overridevirtual

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ setMetricsMode()

void Ogre::v1::TextAreaOverlayElement::setMetricsMode ( GuiMetricsMode gmm )

overridevirtual

Overridden from OverlayElement.

Reimplemented from Ogre::v1::OverlayElement.

◆ setSpaceWidth()

void Ogre::v1::TextAreaOverlayElement::setSpaceWidth ( Real width )

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

OgreTextAreaOverlayElement.h

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Alignment

Constructor & Destructor Documentation

◆ TextAreaOverlayElement()

◆ ~TextAreaOverlayElement()

Member Function Documentation

◆ _releaseManualHardwareResources()

◆ _restoreManualHardwareResources()

◆ _update()

◆ getAlignment()

◆ getCharHeight()

◆ getColour()

◆ getColourBottom()

◆ getColourTop()

◆ getFontName()

◆ getMaterial()

◆ getRenderOperation()

◆ getSpaceWidth()

◆ getTypeName()

◆ initialise()

◆ setAlignment()

◆ setCaption()

◆ setCharHeight()

◆ setColour()

◆ setColourBottom()

◆ setColourTop()

◆ setFontName()

◆ setMaterialName()

◆ setMetricsMode()

◆ setSpaceWidth()