OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::TextAreaOverlayElement Class Reference

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

#include <OgreTextAreaOverlayElement.h>

+ Inheritance diagram for Ogre::TextAreaOverlayElement:
+ Collaboration 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 Member Functions

 TextAreaOverlayElement (const String &name)
 Constructor. More...
 
virtual ~TextAreaOverlayElement ()
 
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...
 
void _update (void)
 Overridden from OverlayElement. 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, Camera *camera, const Camera *lodCamera)
 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 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...
 
Alignment getAlignment () const
 
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...
 
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 Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
const StringgetFontName () const
 
Real getHeight (void) const
 Gets the height of this element in relation to the screen (where 1.0 = screen height) More...
 
uint32 getHlmsCasterHash (void) const
 
uint32 getHlmsHash (void) const
 
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
 
virtual 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...
 
virtual bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
void getRenderOperation (RenderOperation &op)
 See Renderable. More...
 
virtual RenderSystemDatagetRenderSystemData () const
 Gets RenderSystem private data. More...
 
const OverlayElementgetSourceTemplate () const
 Returns the SourceTemplate for this element. More...
 
Real getSpaceWidth () const
 
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
 See OverlayElement. 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...
 
virtual OGRE_DEPRECATED 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)
 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...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
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 setAlignment (Alignment a)
 
virtual void setCaption (const DisplayString &text)
 Sets the caption on elements that support it. More...
 
void setCharHeight (Real height)
 
virtual void setCloneable (bool c)
 
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 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 setFontName (const String &font)
 
void setHeight (Real height)
 Sets the height of this element in relation to the screen (where 1.0 = screen height) More...
 
void setHlms (Hlms *hlms, const HlmsParamVec &params)
 
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 setMaterialName (const String &matName)
 Overridden from OverlayElement. More...
 
void setMetricsMode (GuiMetricsMode gmm)
 Overridden from OverlayElement. 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...
 
virtual 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...
 
virtual void setRenderSystemData (RenderSystemData *val) const
 Sets RenderSystem private data. More...
 
void setSpaceWidth (Real width)
 
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...
 
virtual OGRE_DEPRECATED 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...
 

Protected Types

typedef map< size_t, Vector4 >
::type 
CustomParameterMap
 

Protected Member Functions

void addBaseParameters (void)
 Method for setting up base parameters for this class. More...
 
void checkMemoryAllocation (size_t numChars)
 Internal method to allocate memory, only reallocates when necessary. More...
 
bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
 
virtual void updateColours (void)
 Updates vertex colours. More...
 
virtual void updatePositionGeometry ()
 Inherited function. More...
 
virtual void updateTextureGeometry ()
 Inherited function. More...
 

Protected Attributes

Alignment mAlignment
 The text alignment. More...
 
size_t mAllocSize
 
DisplayString mCaption
 
Real mCharHeight
 
RealRect mClippingRegion
 
bool mCloneable
 
ColourValue mColour
 
ColourValue mColourBottom
 Colours to use for the vertices. More...
 
bool mColoursChanged
 
ColourValue mColourTop
 
CustomParameterMap mCustomParameters
 
Real mDerivedLeft
 
bool mDerivedOutOfDate
 
Real mDerivedTop
 
bool mEnabled
 Is element enabled? More...
 
FontPtr mFont
 
bool mGeomPositionsOutOfDate
 Flag indicating if the vertex positions need recalculating. More...
 
bool mGeomUVsOutOfDate
 Flag indicating if the vertex uvs need recalculating. More...
 
Real mHeight
 
uint32 mHlmsCasterHash
 
uint32 mHlmsHash
 
GuiHorizontalAlignment mHorzAlign
 
bool mInitialised
 Is element initialised? More...
 
Real mLeft
 
MaterialPtr mMaterial
 
String mMaterialName
 
GuiMetricsMode mMetricsMode
 
String mName
 
OverlaymOverlay
 Overlay attached to. More...
 
OverlayContainermParent
 Parent pointer. More...
 
ushort mPixelCharHeight
 
Real mPixelHeight
 
Real mPixelLeft
 
Real mPixelScaleX
 
Real mPixelScaleY
 
ushort mPixelSpaceWidth
 
Real mPixelTop
 
Real mPixelWidth
 
bool mPolygonModeOverrideable
 
RenderOperation mRenderOp
 Render operation. More...
 
RenderSystemDatamRenderSystemData
 User objects binding. More...
 
OverlayElementmSourceTemplate
 Used to see if this element is created from a Template. More...
 
Real mSpaceWidth
 
bool mSpaceWidthOverridden
 
Real mTop
 
bool mTransparent
 Flag indicating if this panel should be visual or just group things. More...
 
bool mUseIdentityProjection
 
bool mUseIdentityView
 
UserObjectBindings mUserObjectBindings
 
GuiVerticalAlignment mVertAlign
 
Real mViewportAspectCoef
 
bool mVisible
 
Real mWidth
 
Matrix4 mXForm
 World transforms. More...
 
ushort mZOrder
 Zorder for when sending to render queue. More...
 

Static Protected Attributes

static
OverlayElementCommands::CmdCaption 
msCaptionCmd
 
static CmdAlignment msCmdAlignment
 
static CmdCharHeight msCmdCharHeight
 
static CmdColour msCmdColour
 
static CmdColourBottom msCmdColourBottom
 
static CmdColourTop msCmdColourTop
 
static CmdFontName msCmdFontName
 
static CmdSpaceWidth msCmdSpaceWidth
 
static
OverlayElementCommands::CmdHeight 
msHeightCmd
 
static
OverlayElementCommands::CmdHorizontalAlign 
msHorizontalAlignCmd
 
static
OverlayElementCommands::CmdLeft 
msLeftCmd
 
static
OverlayElementCommands::CmdMaterial 
msMaterialCmd
 
static
OverlayElementCommands::CmdMetricsMode 
msMetricsModeCmd
 
static
OverlayElementCommands::CmdTop 
msTopCmd
 
static String msTypeName
 
static
OverlayElementCommands::CmdVerticalAlign 
msVerticalAlignCmd
 
static
OverlayElementCommands::CmdVisible 
msVisibleCmd
 
static
OverlayElementCommands::CmdWidth 
msWidthCmd
 

Detailed Description

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

Definition at line 43 of file OgreTextAreaOverlayElement.h.

Member Typedef Documentation

typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap
protectedinherited

Definition at line 422 of file OgreRenderable.h.

Member Enumeration Documentation

Enumerator
Left 
Right 
Center 

Definition at line 46 of file OgreTextAreaOverlayElement.h.

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

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

Gets the clipping region of the element.

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

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

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

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

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

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

Definition at line 260 of file OgreOverlayElement.h.

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

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

Definition at line 254 of file OgreOverlayElement.h.

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

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

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

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

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

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

Definition at line 256 of file OgreOverlayElement.h.

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

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

Definition at line 258 of file OgreOverlayElement.h.

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

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

Reimplemented in Ogre::OverlayContainer.

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

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

Reimplemented in Ogre::OverlayContainer.

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

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

Reimplemented in Ogre::OverlayContainer.

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

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.

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

Tell the object to recalculate.

Reimplemented in Ogre::OverlayContainer.

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

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

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

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

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

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

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

Definition at line 458 of file OgreOverlayElement.h.

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

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

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

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

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

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

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

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

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.

Definition at line 308 of file OgreRenderable.h.

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

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

Updates this elements transform based on it's parent.

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

Internal method to put the contents onto the render queue.

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

void Ogre::TextAreaOverlayElement::addBaseParameters ( void  )
protectedvirtual

Method for setting up base parameters for this class.

Reimplemented from Ogre::OverlayElement.

void Ogre::TextAreaOverlayElement::checkMemoryAllocation ( size_t  numChars)
protected

Internal method to allocate memory, only reallocates when necessary.

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.

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

Reimplemented in Ogre::OverlayContainer.

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

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

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

Reimplemented in Ogre::OverlayContainer.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface dest) const
inlinevirtualinherited

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.

Definition at line 302 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

bool Ogre::StringInterface::createParamDictionary ( const String className)
inlineprotectedinherited

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks
This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).
Parameters
classNamethe name of the class using the dictionary
Returns
true if a new dictionary was created, false if it was already there

Definition at line 185 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

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

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

Reimplemented in Ogre::OverlayContainer.

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

Definition at line 113 of file OgreTextAreaOverlayElement.h.

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

Gets the caption for this element.

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::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 225 of file OgreRenderable.h.

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

Gets the colour of the text.

Reimplemented from Ogre::OverlayElement.

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

Gets the colour of the bottom of the letters.

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

Gets the colour of the top of the letters.

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.

Definition at line 269 of file OgreRenderable.h.

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

const String& Ogre::TextAreaOverlayElement::getFontName ( ) const
Real Ogre::OverlayElement::getHeight ( void  ) const
inherited

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

uint32 Ogre::Renderable::getHlmsCasterHash ( void  ) const
inlineinherited

Definition at line 414 of file OgreRenderable.h.

uint32 Ogre::Renderable::getHlmsHash ( void  ) const
inlineinherited

Definition at line 413 of file OgreRenderable.h.

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

Gets the horizontal alignment for this element.

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

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

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

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.

Definition at line 474 of file OgreOverlayElement.h.

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

See Renderable.

Reimplemented from Ogre::OverlayElement.

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

Gets the name of the material this element uses.

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

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

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

Gets the name of this overlay.

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

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::InstanceBatchShader, and Ogre::InstanceBatchHW.

Definition at line 154 of file OgreRenderable.h.

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.

Definition at line 218 of file OgreStringInterface.h.

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

Definition at line 223 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String name) const
inlinevirtualinherited

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

Definition at line 271 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

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.
OverlayContainer* Ogre::OverlayElement::getParent ( )
inherited

Returns the parent container.

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

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 333 of file OgreRenderable.h.

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

See Renderable.

Implements Ogre::Renderable.

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData ( ) const
inlinevirtualinherited

Gets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 400 of file OgreRenderable.h.

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

Returns the SourceTemplate for this element.

Definition at line 485 of file OgreOverlayElement.h.

Real Ogre::TextAreaOverlayElement::getSpaceWidth ( ) const
Real Ogre::OverlayElement::getSquaredViewDepth ( const Camera cam) const
inlinevirtualinherited

Overridden from Renderable.

Implements Ogre::Renderable.

Definition at line 467 of file OgreOverlayElement.h.

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::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 95 of file OgreRenderable.h.

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

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

virtual const String& Ogre::TextAreaOverlayElement::getTypeName ( void  ) const
virtual
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

Definition at line 179 of file OgreRenderable.h.

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

Definition at line 204 of file OgreRenderable.h.

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny ( void  ) const
inlinevirtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 350 of file OgreRenderable.h.

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.

Definition at line 356 of file OgreRenderable.h.

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.

Definition at line 362 of file OgreRenderable.h.

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

Gets the vertical alignment for this element.

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

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

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

See Renderable.

Implements Ogre::Renderable.

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

Returns the zOrder of the element.

Definition at line 463 of file OgreOverlayElement.h.

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.

Definition at line 260 of file OgreRenderable.h.

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

Hides this element if it was visible.

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

Initialise gui element.

Implements Ogre::OverlayElement.

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

Definition at line 448 of file OgreOverlayElement.h.

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

returns false as this class is not a container type

Reimplemented in Ogre::OverlayContainer.

Definition at line 442 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::isEnabled ( ) const
inherited
virtual bool Ogre::OverlayElement::isKeyEnabled ( ) const
inlinevirtualinherited

Definition at line 445 of file OgreOverlayElement.h.

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

Returns whether or not the element is visible.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

Called immediately after the Renderable has been rendered.

Definition at line 129 of file OgreRenderable.h.

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.

Definition at line 124 of file OgreRenderable.h.

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.

Definition at line 251 of file OgreRenderable.h.

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

Definition at line 108 of file OgreTextAreaOverlayElement.h.

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.

void Ogre::TextAreaOverlayElement::setCharHeight ( Real  height)
virtual void Ogre::OverlayElement::setCloneable ( bool  c)
inlinevirtualinherited

Definition at line 451 of file OgreOverlayElement.h.

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.

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

Definition at line 242 of file OgreRenderable.h.

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

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

virtual void Ogre::OverlayElement::setEnabled ( bool  b)
virtualinherited
void Ogre::TextAreaOverlayElement::setFontName ( const String font)
void Ogre::OverlayElement::setHeight ( Real  height)
inherited

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

void Ogre::Renderable::setHlms ( Hlms hlms,
const HlmsParamVec params 
)
inlineinherited

Definition at line 416 of file OgreRenderable.h.

References Ogre::Hlms::calculateHashFor().

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

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.
void Ogre::OverlayElement::setLeft ( Real  left)
inherited

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

void Ogre::TextAreaOverlayElement::setMaterialName ( const String matName)
virtual

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

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

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

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

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

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList paramList)
virtualinherited

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
virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool  override)
inlinevirtualinherited

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.

Definition at line 325 of file OgreRenderable.h.

void Ogre::OverlayElement::setPosition ( Real  left,
Real  top 
)
inherited

Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height)

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData val) const
inlinevirtualinherited

Sets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 408 of file OgreRenderable.h.

void Ogre::TextAreaOverlayElement::setSpaceWidth ( Real  width)
void Ogre::OverlayElement::setTop ( Real  Top)
inherited

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

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

Definition at line 165 of file OgreRenderable.h.

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

Definition at line 190 of file OgreRenderable.h.

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any anything)
inlinevirtualinherited
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.

Definition at line 345 of file OgreRenderable.h.

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

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.
void Ogre::OverlayElement::setWidth ( Real  width)
inherited

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

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

Shows this element if it was hidden.

virtual void Ogre::TextAreaOverlayElement::updateColours ( void  )
protectedvirtual

Updates vertex colours.

virtual void Ogre::TextAreaOverlayElement::updatePositionGeometry ( )
protectedvirtual

Inherited function.

Implements Ogre::OverlayElement.

virtual void Ogre::TextAreaOverlayElement::updateTextureGeometry ( )
protectedvirtual

Inherited function.

Implements Ogre::OverlayElement.

void Ogre::OverlayElement::visitRenderables ( Renderable::Visitor visitor,
bool  debugRenderables = false 
)
inherited

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.

Member Data Documentation

Alignment Ogre::TextAreaOverlayElement::mAlignment
protected

The text alignment.

Definition at line 207 of file OgreTextAreaOverlayElement.h.

size_t Ogre::TextAreaOverlayElement::mAllocSize
protected

Definition at line 236 of file OgreTextAreaOverlayElement.h.

DisplayString Ogre::OverlayElement::mCaption
protectedinherited

Definition at line 133 of file OgreOverlayElement.h.

Real Ogre::TextAreaOverlayElement::mCharHeight
protected

Definition at line 231 of file OgreTextAreaOverlayElement.h.

RealRect Ogre::OverlayElement::mClippingRegion
protectedinherited

Definition at line 135 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mCloneable
protectedinherited

Definition at line 126 of file OgreOverlayElement.h.

ColourValue Ogre::OverlayElement::mColour
protectedinherited

Definition at line 134 of file OgreOverlayElement.h.

ColourValue Ogre::TextAreaOverlayElement::mColourBottom
protected

Colours to use for the vertices.

Definition at line 240 of file OgreTextAreaOverlayElement.h.

bool Ogre::TextAreaOverlayElement::mColoursChanged
protected

Definition at line 242 of file OgreTextAreaOverlayElement.h.

ColourValue Ogre::TextAreaOverlayElement::mColourTop
protected

Definition at line 241 of file OgreTextAreaOverlayElement.h.

CustomParameterMap Ogre::Renderable::mCustomParameters
protectedinherited

Definition at line 423 of file OgreRenderable.h.

Real Ogre::OverlayElement::mDerivedLeft
protectedinherited

Definition at line 155 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mDerivedOutOfDate
protectedinherited

Definition at line 157 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mDerivedTop
protectedinherited

Definition at line 156 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mEnabled
protectedinherited

Is element enabled?

Definition at line 172 of file OgreOverlayElement.h.

FontPtr Ogre::TextAreaOverlayElement::mFont
protected

Definition at line 230 of file OgreTextAreaOverlayElement.h.

bool Ogre::OverlayElement::mGeomPositionsOutOfDate
protectedinherited

Flag indicating if the vertex positions need recalculating.

Definition at line 160 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mGeomUVsOutOfDate
protectedinherited

Flag indicating if the vertex uvs need recalculating.

Definition at line 162 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mHeight
protectedinherited

Definition at line 130 of file OgreOverlayElement.h.

uint32 Ogre::Renderable::mHlmsCasterHash
protectedinherited

Definition at line 425 of file OgreRenderable.h.

uint32 Ogre::Renderable::mHlmsHash
protectedinherited

Definition at line 424 of file OgreRenderable.h.

GuiHorizontalAlignment Ogre::OverlayElement::mHorzAlign
protectedinherited

Definition at line 138 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mInitialised
protectedinherited

Is element initialised?

Definition at line 175 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mLeft
protectedinherited

Definition at line 127 of file OgreOverlayElement.h.

MaterialPtr Ogre::OverlayElement::mMaterial
protectedinherited

Definition at line 132 of file OgreOverlayElement.h.

String Ogre::OverlayElement::mMaterialName
protectedinherited

Definition at line 131 of file OgreOverlayElement.h.

GuiMetricsMode Ogre::OverlayElement::mMetricsMode
protectedinherited

Definition at line 137 of file OgreOverlayElement.h.

String Ogre::OverlayElement::mName
protectedinherited

Definition at line 124 of file OgreOverlayElement.h.

Overlay* Ogre::OverlayElement::mOverlay
protectedinherited

Overlay attached to.

Definition at line 152 of file OgreOverlayElement.h.

OverlayContainer* Ogre::OverlayElement::mParent
protectedinherited

Parent pointer.

Definition at line 150 of file OgreOverlayElement.h.

ushort Ogre::TextAreaOverlayElement::mPixelCharHeight
protected

Definition at line 232 of file OgreTextAreaOverlayElement.h.

Real Ogre::OverlayElement::mPixelHeight
protectedinherited

Definition at line 145 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mPixelLeft
protectedinherited

Definition at line 143 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mPixelScaleX
protectedinherited

Definition at line 146 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mPixelScaleY
protectedinherited

Definition at line 147 of file OgreOverlayElement.h.

ushort Ogre::TextAreaOverlayElement::mPixelSpaceWidth
protected

Definition at line 235 of file OgreTextAreaOverlayElement.h.

Real Ogre::OverlayElement::mPixelTop
protectedinherited

Definition at line 142 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mPixelWidth
protectedinherited

Definition at line 144 of file OgreOverlayElement.h.

bool Ogre::Renderable::mPolygonModeOverrideable
protectedinherited

Definition at line 426 of file OgreRenderable.h.

RenderOperation Ogre::TextAreaOverlayElement::mRenderOp
protected

Render operation.

Definition at line 213 of file OgreTextAreaOverlayElement.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData
mutableprotectedinherited

User objects binding.

Definition at line 430 of file OgreRenderable.h.

OverlayElementCommands::CmdCaption Ogre::OverlayElement::msCaptionCmd
staticprotectedinherited

Definition at line 117 of file OgreOverlayElement.h.

CmdAlignment Ogre::TextAreaOverlayElement::msCmdAlignment
staticprotected

Definition at line 227 of file OgreTextAreaOverlayElement.h.

CmdCharHeight Ogre::TextAreaOverlayElement::msCmdCharHeight
staticprotected

Definition at line 221 of file OgreTextAreaOverlayElement.h.

CmdColour Ogre::TextAreaOverlayElement::msCmdColour
staticprotected

Definition at line 224 of file OgreTextAreaOverlayElement.h.

CmdColourBottom Ogre::TextAreaOverlayElement::msCmdColourBottom
staticprotected

Definition at line 226 of file OgreTextAreaOverlayElement.h.

CmdColourTop Ogre::TextAreaOverlayElement::msCmdColourTop
staticprotected

Definition at line 225 of file OgreTextAreaOverlayElement.h.

CmdFontName Ogre::TextAreaOverlayElement::msCmdFontName
staticprotected

Definition at line 223 of file OgreTextAreaOverlayElement.h.

CmdSpaceWidth Ogre::TextAreaOverlayElement::msCmdSpaceWidth
staticprotected

Definition at line 222 of file OgreTextAreaOverlayElement.h.

OverlayElementCommands::CmdHeight Ogre::OverlayElement::msHeightCmd
staticprotectedinherited

Definition at line 115 of file OgreOverlayElement.h.

OverlayElementCommands::CmdHorizontalAlign Ogre::OverlayElement::msHorizontalAlignCmd
staticprotectedinherited

Definition at line 119 of file OgreOverlayElement.h.

OverlayElementCommands::CmdLeft Ogre::OverlayElement::msLeftCmd
staticprotectedinherited

Definition at line 112 of file OgreOverlayElement.h.

OverlayElementCommands::CmdMaterial Ogre::OverlayElement::msMaterialCmd
staticprotectedinherited

Definition at line 116 of file OgreOverlayElement.h.

OverlayElementCommands::CmdMetricsMode Ogre::OverlayElement::msMetricsModeCmd
staticprotectedinherited

Definition at line 118 of file OgreOverlayElement.h.

OverlayElement* Ogre::OverlayElement::mSourceTemplate
protectedinherited

Used to see if this element is created from a Template.

Definition at line 178 of file OgreOverlayElement.h.

Real Ogre::TextAreaOverlayElement::mSpaceWidth
protected

Definition at line 234 of file OgreTextAreaOverlayElement.h.

bool Ogre::TextAreaOverlayElement::mSpaceWidthOverridden
protected

Definition at line 233 of file OgreTextAreaOverlayElement.h.

OverlayElementCommands::CmdTop Ogre::OverlayElement::msTopCmd
staticprotectedinherited

Definition at line 113 of file OgreOverlayElement.h.

String Ogre::TextAreaOverlayElement::msTypeName
staticprotected

Definition at line 218 of file OgreTextAreaOverlayElement.h.

OverlayElementCommands::CmdVerticalAlign Ogre::OverlayElement::msVerticalAlignCmd
staticprotectedinherited

Definition at line 120 of file OgreOverlayElement.h.

OverlayElementCommands::CmdVisible Ogre::OverlayElement::msVisibleCmd
staticprotectedinherited

Definition at line 121 of file OgreOverlayElement.h.

OverlayElementCommands::CmdWidth Ogre::OverlayElement::msWidthCmd
staticprotectedinherited

Definition at line 114 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mTop
protectedinherited

Definition at line 128 of file OgreOverlayElement.h.

bool Ogre::TextAreaOverlayElement::mTransparent
protected

Flag indicating if this panel should be visual or just group things.

Definition at line 210 of file OgreTextAreaOverlayElement.h.

bool Ogre::Renderable::mUseIdentityProjection
protectedinherited

Definition at line 427 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView
protectedinherited

Definition at line 428 of file OgreRenderable.h.

UserObjectBindings Ogre::Renderable::mUserObjectBindings
protectedinherited

Definition at line 429 of file OgreRenderable.h.

GuiVerticalAlignment Ogre::OverlayElement::mVertAlign
protectedinherited

Definition at line 139 of file OgreOverlayElement.h.

Real Ogre::TextAreaOverlayElement::mViewportAspectCoef
protected

Definition at line 237 of file OgreTextAreaOverlayElement.h.

bool Ogre::OverlayElement::mVisible
protectedinherited

Definition at line 125 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mWidth
protectedinherited

Definition at line 129 of file OgreOverlayElement.h.

Matrix4 Ogre::OverlayElement::mXForm
protectedinherited

World transforms.

Definition at line 169 of file OgreOverlayElement.h.

ushort Ogre::OverlayElement::mZOrder
protectedinherited

Zorder for when sending to render queue.

Derived from parent

Definition at line 166 of file OgreOverlayElement.h.


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