OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::TextAreaOverlayElement Class Reference

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

#include <OgreTextAreaOverlayElement.h>

+ Inheritance diagram for Ogre::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
enum  { DEFAULT_PRIORITY = 100 }
 
typedef SharedPtr< RenderSystemDataRenderSystemDataPtr
 

Public Member Functions

 TextAreaOverlayElement (const String &name)
 Constructor. More...
 
virtual ~TextAreaOverlayElement ()
 
virtual void _releaseManualHardwareResources ()
 Notifies that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies that hardware resources should be restored. More...
 
void _update (void)
 Overridden from OverlayElement. More...
 
Alignment getAlignment () const
 
Real getCharHeight () const
 
const ColourValuegetColour (void) const
 Gets the colour of the text. More...
 
const ColourValuegetColourBottom (void) const
 Gets the colour of the bottom of the letters. More...
 
const ColourValuegetColourTop (void) const
 Gets the colour of the top of the letters. More...
 
const FontPtrgetFont () const
 
const StringgetFontName () const
 
const MaterialPtrgetMaterial (void) const
 See Renderable. More...
 
void getRenderOperation (RenderOperation &op)
 See Renderable. More...
 
Real getSpaceWidth () const
 
virtual const StringgetTypeName (void) const
 See OverlayElement. More...
 
virtual void initialise (void)
 Initialise gui element. More...
 
void setAlignment (Alignment a)
 
virtual void setCaption (const DisplayString &text)
 Sets the caption on elements that support it. More...
 
void setCharHeight (Real height)
 
void setColour (const ColourValue &col)
 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, const String &group=DEFAULT_RESOURCE_GROUP)
 
void setMetricsMode (GuiMetricsMode gmm)
 Overridden from OverlayElement. More...
 
void setSpaceWidth (Real width)
 
- Public Member Functions inherited from Ogre::OverlayElement
 OverlayElement (const String &name)
 Constructor: do not call direct, use OverlayManager::createElement. More...
 
virtual ~OverlayElement ()
 
virtual void _getClippingRegion (RealRect &clippingRegion)
 Gets the clipping region of the element. More...
 
virtual Real _getDerivedLeft (void)
 Gets the 'left' position as derived from own left and that of parents. More...
 
virtual Real _getDerivedTop (void)
 Gets the 'top' position as derived from own left and that of parents. More...
 
Real _getHeight (void) const
 Gets the height of this element in relation to the screen (where 1.0 = screen height)
More...
 
Real _getLeft (void) const
 Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
virtual Real _getRelativeHeight (void)
 Gets the 'height' as derived from own height and metrics mode. More...
 
virtual Real _getRelativeWidth (void)
 Gets the 'width' as derived from own width and metrics mode. More...
 
Real _getTop (void) const
 Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right)
More...
 
Real _getWidth (void) const
 Gets the width of this element in relation to the screen (where 1.0 = screen width)
More...
 
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...
 
void _setDimensions (Real width, Real height)
 Sets the width and height of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setHeight (Real height)
 Sets the height of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setLeft (Real left)
 Sets the left of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setParent (OverlayContainer *parent)
 
void _setPosition (Real left, Real top)
 Sets the left and top of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setTop (Real top)
 Sets the top of this element in relation to the screen (where 1.0 = screen width) More...
 
void _setWidth (Real width)
 Sets the width of this element in relation to the screen (where 1.0 = screen width) More...
 
virtual void _updateFromParent (void)
 Updates this elements transform based on it's parent. More...
 
virtual 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)
 
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...
 
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...
 
virtual const StringgetMaterialName (void) const
 Gets the name of the material this element uses. More...
 
virtual GuiMetricsMode getMetricsMode (void) const
 Retrieves the current settings of how the element metrics are interpreted. More...
 
const StringgetName (void) const
 Gets the name of this overlay. More...
 
OverlayContainergetParent ()
 Returns the parent container. More...
 
const OverlayElementgetSourceTemplate () const
 Returns the SourceTemplate for this element. More...
 
Real getSquaredViewDepth (const Camera *cam) const
 Overridden from Renderable. More...
 
Real getTop (void) const
 Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
More...
 
virtual GuiVerticalAlignment getVerticalAlignment (void) const
 Gets the vertical alignment for this element. More...
 
Real getWidth (void) const
 Gets the width of this element in relation to the screen (where 1.0 = screen width) More...
 
void getWorldTransforms (Matrix4 *xform) const
 See Renderable. More...
 
ushort getZOrder () const
 Returns the zOrder of the element. More...
 
virtual void hide (void)
 Hides this element if it was visible. More...
 
virtual bool isCloneable () const
 
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 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 setMaterial (const MaterialPtr &mat)
 Sets the the material this element will use. More...
 
void setMaterialName (const String &matName, const String &group=DEFAULT_RESOURCE_GROUP)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setPosition (Real left, Real top)
 Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height) More...
 
void setTop (Real Top)
 Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...
 
virtual void setVerticalAlignment (GuiVerticalAlignment gva)
 Sets the vertical origin for this element. More...
 
void setWidth (Real width)
 Sets the width of this element in relation to the screen (where 1.0 = screen width) More...
 
virtual void show (void)
 Shows this element if it was hidden. More...
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 
- Public Member Functions inherited from Ogre::StringInterface
 StringInterface ()
 
virtual ~StringInterface ()
 Virtual destructor, see Effective C++. More...
 
void copyParametersTo (StringInterface *dest) const
 Method for copying this object's parameters to another object. More...
 
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class. More...
 
const ParamDictionarygetParamDictionary (void) const
 
String getParameter (const String &name) const
 Generic parameter retrieval method. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 
bool setParameter (const String &name, const String &value)
 Generic parameter setting method. More...
 
void setParameterList (const NameValuePairList &paramList)
 Generic multiple parameter setting method. More...
 
- Public Member Functions inherited from Ogre::Renderable
 Renderable ()
 
virtual ~Renderable ()
 Virtual destructor needed as class has virtual methods. More...
 
virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...
 
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
const RenderSystemDataPtrgetRenderSystemData () const
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection. More...
 
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view. More...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. More...
 
void setCustomParameter (size_t index, const Vector4 &value)
 Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...
 
void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
void setRenderSystemData (RenderSystemDataPtr val) const
 
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection. More...
 
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view. More...
 
void setUserAny (const Any &anything)
 

Additional Inherited Members

- Static Public Member Functions inherited from Ogre::StringInterface
static void cleanupDictionary ()
 Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More...
 
- Static Public Attributes inherited from Ogre::OverlayElement
static const StringDEFAULT_RESOURCE_GROUP
 

Detailed Description

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

Member Enumeration Documentation

◆ Alignment

Enumerator
Left 
Right 
Center 

Constructor & Destructor Documentation

◆ TextAreaOverlayElement()

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

Constructor.

◆ ~TextAreaOverlayElement()

virtual Ogre::TextAreaOverlayElement::~TextAreaOverlayElement ( )
virtual

Member Function Documentation

◆ initialise()

virtual void Ogre::TextAreaOverlayElement::initialise ( void  )
virtual

Initialise gui element.

Implements Ogre::OverlayElement.

◆ _releaseManualHardwareResources()

virtual void Ogre::TextAreaOverlayElement::_releaseManualHardwareResources ( )
virtual

Notifies that hardware resources were lost.

Reimplemented from Ogre::OverlayElement.

◆ _restoreManualHardwareResources()

virtual void Ogre::TextAreaOverlayElement::_restoreManualHardwareResources ( )
virtual

Notifies that hardware resources should be restored.

Reimplemented from Ogre::OverlayElement.

◆ setCaption()

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

◆ setCharHeight()

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

◆ getCharHeight()

Real Ogre::TextAreaOverlayElement::getCharHeight ( ) const

◆ setSpaceWidth()

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

◆ getSpaceWidth()

Real Ogre::TextAreaOverlayElement::getSpaceWidth ( ) const

◆ setFontName()

void Ogre::TextAreaOverlayElement::setFontName ( const String font,
const String group = DEFAULT_RESOURCE_GROUP 
)

◆ getFontName()

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

◆ getFont()

const FontPtr& Ogre::TextAreaOverlayElement::getFont ( ) const
inline

◆ getTypeName()

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

◆ getMaterial()

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

See Renderable.

Reimplemented from Ogre::OverlayElement.

◆ getRenderOperation()

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

See Renderable.

Implements Ogre::Renderable.

◆ setColour()

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

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

◆ getColour()

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

Gets the colour of the text.

Reimplemented from Ogre::OverlayElement.

◆ setColourBottom()

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

◆ getColourBottom()

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

Gets the colour of the bottom of the letters.

◆ setColourTop()

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

◆ getColourTop()

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

Gets the colour of the top of the letters.

◆ setAlignment()

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

◆ getAlignment()

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

◆ setMetricsMode()

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

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

◆ _update()

void Ogre::TextAreaOverlayElement::_update ( void  )
virtual

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.


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