Ogre::BorderPanelOverlayElement Class Reference
Core » Overlays

A specialisation of the PanelOverlayElement to provide a panel with a border. More...

`#include <OgreBorderPanelOverlayElement.h>`

Inheritance diagram for Ogre::BorderPanelOverlayElement:
[legend]

## Classes

struct | CellUV
class | CmdBorderBottomLeftUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | CmdBorderBottomRightUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | CmdBorderBottomUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | CmdBorderLeftUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | CmdBorderMaterial
| Command object for specifying the Material for the border (see ParamCommand). More...
class | CmdBorderRightUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | CmdBorderSize
| Command object for specifying border sizes (see ParamCommand). More...
class | CmdBorderTopLeftUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | CmdBorderTopRightUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...
class | CmdBorderTopUV
| Command object for specifying texture coordinates for the border (see ParamCommand). More...

## Public Types

typedef MapIterator< ChildContainerMap > | ChildContainerIterator
typedef map< String, OverlayContainer * >::type | ChildContainerMap
typedef MapIterator< ChildMap > | ChildIterator
typedef map< String, OverlayElement * >::type | ChildMap

## Public Member Functions

| BorderPanelOverlayElement (const String &name)
| Constructor. More...
virtual | ~BorderPanelOverlayElement ()
void | _addChild (OverlayElement *elem)
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)
| Overridden from OverlayElement. More...
virtual void | _notifyViewport ()
| Overridden from OverlayElement. More...
virtual void | _notifyWorldTransforms (const Matrix4 &xform)
| Overridden from OverlayElement. More...
virtual ushort | _notifyZOrder (ushort newZOrder)
| Overridden from OverlayElement. More...
virtual void | _positionsOutOfDate (void)
| Tell the object and its children to recalculate. More...
void | _removeChild (OverlayElement *elem)
void | _removeChild (const String &name)
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)
| Internal method to update the element based on transforms applied. More...
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...
virtual void | _updateFromParent (void)
| Updates this elements transform based on it's parent. More...
void | _updateRenderQueue (RenderQueue *queue)
| Overridden from OverlayElement. More...
virtual void | addChild (OverlayElement *elem)
| Adds another OverlayElement to this container. More...
virtual void | addChildImpl (OverlayElement *elem)
| Adds another OverlayElement to this container. More...
virtual void | addChildImpl (OverlayContainer *cont)
| Add a nested container to this container. 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...
void | copyFromTemplate (OverlayElement *templateOverlay)
virtual void | copyParametersTo (StringInterface *dest) const
| Method for copying this object's parameters to another object. More...
virtual OverlayElement * | findElementAt (Real x, Real y)
| This returns a OverlayElement at position x,y. More...
const String & | getBorderMaterialName (void) const
| Gets the name of the material to use for the borders. More...
Real | getBottomBorderSize (void) const
| Gets the size of the bottom border. More...
String | getBottomBorderUVString () const
String | getBottomLeftBorderUVString () const
String | getBottomRightBorderUVString () const
virtual const DisplayString & | getCaption (void) const
| Gets the caption for this element. More...
virtual bool | getCastsShadows (void) const
| Method which reports whether this renderable would normally cast a shadow. More...
virtual OverlayElement * | getChild (const String &name)
| Gets the named child of this container. More...
virtual ChildContainerIterator | getChildContainerIterator (void)
| Gets an iterator for just the container children of this object. More...
virtual ChildIterator | getChildIterator (void)
| Gets an object for iterating over all the children of this object. More...
virtual const ColourValue & | getColour (void) const
| Gets the colour for this element. More...
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index. More...
Real | getHeight (void) const
| Gets the height of this element in relation to the screen (where 1.0 = screen height) More...
virtual GuiHorizontalAlignment | getHorizontalAlignment (void) const
| Gets the horizontal alignment for this element. More...
Real | getLeft (void) const
| Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...
Real | getLeftBorderSize (void) const
| Gets the size of the left border. More...
String | getLeftBorderUVString () const
const LightList & | getLights (void) const
| Gets a list of lights, ordered relative to how close they are to this renderable. More...
const MaterialPtr & | getMaterial (void) const
| See Renderable. More...
virtual const String & | getMaterialName (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 String & | getName (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...
ParamDictionary * | getParamDictionary (void)
| Retrieves the parameter dictionary for this class. More...
const ParamDictionary * | getParamDictionary (void) const
virtual String | getParameter (const String &name) const
| Generic parameter retrieval method. More...
const ParameterList & | getParameters (void) const
| Retrieves a list of parameters valid for this object. More...
OverlayContainer * | getParent ()
| 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 RenderSystemData * | getRenderSystemData () const
| Gets RenderSystem private data. More...
Real | getRightBorderSize (void) const
| Gets the size of the right border. More...
String | getRightBorderUVString () const
const OverlayElement * | getSourceTemplate () const
| Returns the SourceTemplate for this element. More...
Real | getSquaredViewDepth (const Camera *cam) const
| Overridden from Renderable. More...
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses. More...
Real | getTileX (ushort layer=0) const
Real | getTileY (ushort layer=0) const
| Gets the number of times the texture should repeat vertically. More...
Real | getTop (void) const
| Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...
Real | getTopBorderSize (void) const
| Gets the size of the top border. More...
String | getTopBorderUVString () const
String | getTopLeftBorderUVString () const
String | getTopRightBorderUVString () const
const String & | getTypeName (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 Any & | getUserAny (void) 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...
void | getUV (Real &u1, Real &v1, Real &u2, Real &v2) const
| Get the uv coordinates for the panel. 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. More...
virtual bool | isChildrenProcessEvents () const
| Should this container pass events to their children. More...
virtual bool | isCloneable () const
bool | isContainer () const
| Overridden from OverlayElement. More...
bool | isEnabled () const
virtual bool | isKeyEnabled () const
bool | isTransparent (void) const
| Returns whether this panel is transparent. More...
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...
virtual void | removeChild (const String &name)
| Removes a named element from this container. More...
void | removeCustomParameter (size_t index)
| Removes a custom value which is associated with this Renderable at the given index. More...
void | setBorderMaterialName (const String &name)
| Sets the name of the material to use for the borders. More...
void | setBorderSize (Real size)
| Sets the size of the border. More...
void | setBorderSize (Real sides, Real topAndBottom)
| Sets the size of the border, with different sizes for vertical and horizontal borders. More...
void | setBorderSize (Real left, Real right, Real top, Real bottom)
| Sets the size of the border separately for all borders. More...
void | setBottomBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the bottom edge of the border. More...
void | setBottomLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the bottom-left corner of the border. More...
void | setBottomRightBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the bottom-right corner of the border. More...
virtual void | setCaption (const DisplayString &text)
| Sets the caption on elements that support it. More...
virtual void | setChildrenProcessEvents (bool val)
| Should this container pass events to their children. More...
virtual void | setCloneable (bool c)
virtual void | setColour (const ColourValue &col)
| Sets the colour on elements that support it. More...
void | setCustomParameter (size_t index, const Vector4 &value)
| Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...
void | setDimensions (Real width, Real height)
| Sets the dimensions of this element in relation to the screen (1.0 = screen width/height). More...
virtual void | setEnabled (bool b)
void | setHeight (Real height)
| Sets the height of this element in relation to the screen (where 1.0 = screen height) More...
virtual void | setHorizontalAlignment (GuiHorizontalAlignment gha)
| Sets the horizontal origin for this element. More...
void | setLeft (Real left)
| Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right) More...
void | setLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the left edge of the border. More...
void | setMaterialName (const String &matName)
| Overridden from OverlayElement. More...
void | setMetricsMode (GuiMetricsMode gmm)
| Tells this element how to interpret the position and dimension values it is given. 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 | setRightBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the right edge of the border. More...
void | setTiling (Real x, Real y, ushort layer=0)
| Sets the number of times textures should repeat. More...
void | setTop (Real Top)
| Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More...
void | setTopBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the top edge of the border. More...
void | setTopLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the top-left corner of the border. More...
void | setTopRightBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the top-right corner of the border. More...
void | setTransparent (bool isTransparent)
| Sets whether this panel is transparent (used only as a grouping level), or if it is actually rendered. 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)
void | setUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the panel. 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...

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

enum | BorderCellIndex { BCELL_TOP_LEFT = 0, BCELL_TOP = 1, BCELL_TOP_RIGHT = 2, BCELL_LEFT = 3, BCELL_RIGHT = 4, BCELL_BOTTOM_LEFT = 5, BCELL_BOTTOM = 6, BCELL_BOTTOM_RIGHT = 7 }
typedef map< size_t, Vector4 >::type | CustomParameterMap

## Protected Member Functions

void | addBaseParameters (void)
| Internal method for setting up parameters. More...
bool | createParamDictionary (const String &className)
| Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
String | getCellUVString (BorderCellIndex idx) const
void | updatePositionGeometry (void)
| internal method for setting up geometry, called by OverlayElement::update More...
void | updateTextureGeometry (void)
| internal method for setting up geometry, called by OverlayElement::update More...

## Protected Attributes

MaterialPtr | mBorderMaterial
String | mBorderMaterialName
BorderRenderable * | mBorderRenderable
CellUV | mBorderUV [8]
Real | mBottomBorderSize
DisplayString | mCaption
ChildContainerMap | mChildContainers
| Map of container children (subset of mChildren) More...
ChildMap | mChildren
| Map of all children. More...
bool | mChildrenProcessEvents
RealRect | mClippingRegion
bool | mCloneable
ColourValue | mColour
CustomParameterMap | mCustomParameters
Real | mDerivedLeft
bool | mDerivedOutOfDate
Real | mDerivedTop
bool | mEnabled
| Is element enabled? More...
bool | mGeomPositionsOutOfDate
| Flag indicating if the vertex positions need recalculating. More...
bool | mGeomUVsOutOfDate
| Flag indicating if the vertex uvs need recalculating. More...
Real | mHeight
GuiHorizontalAlignment | mHorzAlign
bool | mInitialised
| Is element initialised? More...
Real | mLeft
Real | mLeftBorderSize
MaterialPtr | mMaterial
String | mMaterialName
GuiMetricsMode | mMetricsMode
String | mName
size_t | mNumTexCoordsInBuffer
Overlay * | mOverlay
| Overlay attached to. More...
OverlayContainer * | mParent
| Parent pointer. More...
ushort | mPixelBottomBorderSize
Real | mPixelHeight
Real | mPixelLeft
ushort | mPixelLeftBorderSize
ushort | mPixelRightBorderSize
Real | mPixelScaleX
Real | mPixelScaleY
Real | mPixelTop
ushort | mPixelTopBorderSize
Real | mPixelWidth
bool | mPolygonModeOverrideable
RenderOperation | mRenderOp
RenderOperation | mRenderOp2
| Render operation for the border area. More...
RenderSystemData * | mRenderSystemData
| User objects binding. More...
Real | mRightBorderSize
OverlayElement * | mSourceTemplate
| Used to see if this element is created from a Template. More...
Real | mTileX [OGRE_MAX_TEXTURE_LAYERS]
Real | mTileY [OGRE_MAX_TEXTURE_LAYERS]
Real | mTop
Real | mTopBorderSize
bool | mTransparent
| Flag indicating if this panel should be visual or just group things. More...
Real | mU1
Real | mU2
bool | mUseIdentityProjection
bool | mUseIdentityView
UserObjectBindings | mUserObjectBindings
Real | mV1
Real | mV2
GuiVerticalAlignment | mVertAlign
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 CmdBorderBottomLeftUV | msCmdBorderBottomLeftUV
static CmdBorderBottomRightUV | msCmdBorderBottomRightUV
static CmdBorderBottomUV | msCmdBorderBottomUV
static CmdBorderLeftUV | msCmdBorderLeftUV
static CmdBorderMaterial | msCmdBorderMaterial
static CmdBorderRightUV | msCmdBorderRightUV
static CmdBorderSize | msCmdBorderSize
static CmdBorderTopLeftUV | msCmdBorderTopLeftUV
static CmdBorderTopRightUV | msCmdBorderTopRightUV
static CmdBorderTopUV | msCmdBorderTopUV
static CmdTiling | msCmdTiling
static CmdTransparent | msCmdTransparent
static CmdUVCoords | msCmdUVCoords
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

## Friends

class | BorderRenderable

## Detailed Description

A specialisation of the PanelOverlayElement to provide a panel with a border.

Remarks
  Whilst the standard panel can use a single tiled material, this class allows panels with a tileable backdrop plus a border texture. This is handy for large panels that are too big to use a single large texture with a border, or for multiple different size panels where you want the border a constant width but the center to repeat.

  In addition to the usual PanelOverlayElement properties, this class has a 'border material', which specifies the material used for the edges of the panel, a border width (which can either be constant all the way around, or specified per edge), and the texture coordinates for each of the border sections.

Definition at line 57 of file OgreBorderPanelOverlayElement.h.

## Member Typedef Documentation

## ChildContainerIterator

typedef MapIterator<ChildContainerMap> Ogre::OverlayContainer::ChildContainerIterator

inherited

Definition at line 62 of file OgreOverlayContainer.h.

## ChildContainerMap

typedef map<String, OverlayContainer*>::type Ogre::OverlayContainer::ChildContainerMap

inherited

Definition at line 61 of file OgreOverlayContainer.h.

## ChildIterator

typedef MapIterator<ChildMap> Ogre::OverlayContainer::ChildIterator

inherited

Definition at line 60 of file OgreOverlayContainer.h.

## ChildMap

typedef map<String, OverlayElement*>::type Ogre::OverlayContainer::ChildMap

inherited

Definition at line 59 of file OgreOverlayContainer.h.

## CustomParameterMap

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

protected inherited

Definition at line 414 of file OgreRenderable.h.

## Member Enumeration Documentation

## BorderCellIndex

enum Ogre::BorderPanelOverlayElement::BorderCellIndex

protected

Enumerator
BCELL_TOP_LEFT |
BCELL_TOP |
BCELL_TOP_RIGHT |
BCELL_LEFT |
BCELL_RIGHT |
BCELL_BOTTOM_LEFT |
BCELL_BOTTOM |
BCELL_BOTTOM_RIGHT |

Definition at line 288 of file OgreBorderPanelOverlayElement.h.

## Constructor & Destructor Documentation

## BorderPanelOverlayElement()

Ogre::BorderPanelOverlayElement::BorderPanelOverlayElement | ( | const String & | name | ) |

Constructor.

## ~BorderPanelOverlayElement()

virtual Ogre::BorderPanelOverlayElement::~BorderPanelOverlayElement | ( |  | ) |

virtual

## Member Function Documentation

## _addChild()

void Ogre::OverlayContainer::_addChild | ( | OverlayElement * | elem | ) |

inherited

## _getClippingRegion()

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

virtual inherited

Gets the clipping region of the element.

## _getDerivedLeft()

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

virtual inherited

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

## _getDerivedTop()

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

virtual inherited

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

## _getHeight()

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

inherited

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

Definition at line 262 of file OgreOverlayElement.h.

## _getLeft()

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)

Definition at line 256 of file OgreOverlayElement.h.

## _getRelativeHeight()

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

virtual inherited

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

## _getRelativeWidth()

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

virtual inherited

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

## _getTop()

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

inherited

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

Definition at line 258 of file OgreOverlayElement.h.

## _getWidth()

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

inherited

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

Definition at line 260 of file OgreOverlayElement.h.

## _notifyParent()

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

virtual inherited

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

## _notifyViewport()

virtual void Ogre::OverlayContainer::_notifyViewport | ( |  | ) |

virtual inherited

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

## _notifyWorldTransforms()

virtual void Ogre::OverlayContainer::_notifyWorldTransforms | ( | const Matrix4 & | xform | ) |

virtual inherited

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

## _notifyZOrder()

virtual ushort Ogre::OverlayContainer::_notifyZOrder | ( | ushort | newZOrder | ) |

virtual inherited

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

## _positionsOutOfDate()

virtual void Ogre::OverlayContainer::_positionsOutOfDate | ( | void |  | ) |

virtual inherited

Tell the object and its children to recalculate.

Reimplemented from Ogre::OverlayElement.

## _removeChild() [1/2]

void Ogre::OverlayContainer::_removeChild | ( | OverlayElement * | elem | ) |

inherited

Definition at line 91 of file OgreOverlayContainer.h.

References Ogre::OverlayContainer::_removeChild(), and Ogre::OverlayElement::getName().

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

## _removeChild() [2/2]

void Ogre::OverlayContainer::_removeChild | ( | const String & | name | ) |

inherited

## _setDimensions()

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)

## _setHeight()

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

inherited

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

## _setLeft()

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

inherited

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

## _setParent()

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

inherited

Definition at line 460 of file OgreOverlayElement.h.

## _setPosition()

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)

## _setTop()

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

inherited

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

## _setWidth()

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

inherited

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

## _update()

void Ogre::BorderPanelOverlayElement::_update | ( | void |  | ) |

virtual

Internal method to update the element based on transforms applied.

Reimplemented from Ogre::OverlayContainer.

## _updateCustomGpuParameter()

virtual void Ogre::Renderable::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry,
|  | GpuProgramParameters * | params
| ) |  | const

virtual inherited

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

  constantEntry | The auto constant entry referring to the parameter being updated
  params | The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

Definition at line 307 of file OgreRenderable.h.

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

## _updateFromParent()

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

virtual inherited

Updates this elements transform based on it's parent.

## _updateRenderQueue()

void Ogre::BorderPanelOverlayElement::_updateRenderQueue | ( | RenderQueue * | queue | ) |

virtual

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayContainer.

## addBaseParameters()

void Ogre::BorderPanelOverlayElement::addBaseParameters | ( | void |  | ) |

protected virtual

Internal method for setting up parameters.

Reimplemented from Ogre::OverlayElement.

## addChild()

virtual void Ogre::OverlayContainer::addChild | ( | OverlayElement * | elem | ) |

virtual inherited

Adds another OverlayElement to this container.

## addChildImpl() [1/2]

virtual void Ogre::OverlayContainer::addChildImpl | ( | OverlayElement * | elem | ) |

virtual inherited

Adds another OverlayElement to this container.

## addChildImpl() [2/2]

virtual void Ogre::OverlayContainer::addChildImpl | ( | OverlayContainer * | cont | ) |

virtual inherited

Add a nested container to this container.

## cleanupDictionary()

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

static inherited

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.

## clone()

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

virtual inherited

Reimplemented from Ogre::OverlayElement.

## contains()

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

virtual inherited

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

## copyFromTemplate()

void Ogre::OverlayContainer::copyFromTemplate | ( | OverlayElement * | templateOverlay | ) |

virtual inherited

Reimplemented from Ogre::OverlayElement.

## copyParametersTo()

virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const

virtual inherited

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

  dest | Pointer to object to have it's parameters set the same as this object.

Definition at line 303 of file OgreStringInterface.h.

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

## createParamDictionary()

bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) |

protected inherited

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

  className | the name of the class using the dictionary

Returns
  true if a new dictionary was created, false if it was already there

Definition at line 186 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

## findElementAt()

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

virtual inherited

This returns a OverlayElement at position x,y.

Reimplemented from Ogre::OverlayElement.

## getBorderMaterialName()

const String& Ogre::BorderPanelOverlayElement::getBorderMaterialName | ( | void |  | ) | const

Gets the name of the material to use for the borders.

## getBottomBorderSize()

Real Ogre::BorderPanelOverlayElement::getBottomBorderSize | ( | void |  | ) | const

Gets the size of the bottom border.

## getBottomBorderUVString()

String Ogre::BorderPanelOverlayElement::getBottomBorderUVString | ( |  | ) | const

## getBottomLeftBorderUVString()

String Ogre::BorderPanelOverlayElement::getBottomLeftBorderUVString | ( |  | ) | const

## getBottomRightBorderUVString()

String Ogre::BorderPanelOverlayElement::getBottomRightBorderUVString | ( |  | ) | const

## getCaption()

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

virtual inherited

Gets the caption for this element.

## getCastsShadows()

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

virtual inherited

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

Definition at line 224 of file OgreRenderable.h.

## getCellUVString()

String Ogre::BorderPanelOverlayElement::getCellUVString | ( | BorderCellIndex | idx | ) | const

protected

## getChild()

virtual OverlayElement* Ogre::OverlayContainer::getChild | ( | const String & | name | ) |

virtual inherited

Gets the named child of this container.

## getChildContainerIterator()

virtual ChildContainerIterator Ogre::OverlayContainer::getChildContainerIterator | ( | void |  | ) |

virtual inherited

Gets an iterator for just the container children of this object.

Remarks
  Good for cascading updates without having to use RTTI

## getChildIterator()

virtual ChildIterator Ogre::OverlayContainer::getChildIterator | ( | void |  | ) |

virtual inherited

Gets an object for iterating over all the children of this object.

## getColour()

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

virtual inherited

Gets the colour for this element.

Reimplemented in Ogre::TextAreaOverlayElement.

## getCustomParameter()

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

inherited

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

Parameters

  index | Index of the parameter to retrieve.

See also
  setCustomParameter for full details.

Definition at line 268 of file OgreRenderable.h.

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

## getHeight()

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

inherited

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

## getHorizontalAlignment()

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

virtual inherited

Gets the horizontal alignment for this element.

## getLeft()

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)

## getLeftBorderSize()

Real Ogre::BorderPanelOverlayElement::getLeftBorderSize | ( | void |  | ) | const

Gets the size of the left border.

## getLeftBorderUVString()

String Ogre::BorderPanelOverlayElement::getLeftBorderUVString | ( |  | ) | const

## getLights()

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

virtual inherited

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 476 of file OgreOverlayElement.h.

## getMaterial()

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

virtual inherited

See Renderable.

Implements Ogre::Renderable.

Reimplemented in Ogre::TextAreaOverlayElement.

## getMaterialName()

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

virtual inherited

Gets the name of the material this element uses.

## getMetricsMode()

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

virtual inherited

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

## getName()

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

inherited

Gets the name of this overlay.

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

## getNumWorldTransforms()

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

virtual inherited

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

Definition at line 153 of file OgreRenderable.h.

## getParamDictionary() [1/2]

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

inherited

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 219 of file OgreStringInterface.h.

## getParamDictionary() [2/2]

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

inherited

Definition at line 224 of file OgreStringInterface.h.

## getParameter()

virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const

virtual inherited

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

  name | The name of the parameter to get

Returns
  String value of parameter, blank if not found

Definition at line 272 of file OgreStringInterface.h.

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

## getParameters()

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

inherited

Retrieves a list of parameters valid for this object.

Returns
  A reference to a static list of ParameterDef objects.

## getParent()

OverlayContainer* Ogre::OverlayElement::getParent | ( |  | ) |

inherited

Returns the parent container.

## getPolygonModeOverrideable()

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

virtual inherited

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 332 of file OgreRenderable.h.

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

## getRenderOperation()

void Ogre::PanelOverlayElement::getRenderOperation | ( | RenderOperation & | op | ) |

virtual inherited

See Renderable.

Implements Ogre::Renderable.

## getRenderSystemData()

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

virtual inherited

Gets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 399 of file OgreRenderable.h.

## getRightBorderSize()

Real Ogre::BorderPanelOverlayElement::getRightBorderSize | ( | void |  | ) | const

Gets the size of the right border.

## getRightBorderUVString()

String Ogre::BorderPanelOverlayElement::getRightBorderUVString | ( |  | ) | const

## getSourceTemplate()

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

inherited

Returns the SourceTemplate for this element.

Definition at line 487 of file OgreOverlayElement.h.

## getSquaredViewDepth()

Real Ogre::OverlayElement::getSquaredViewDepth | ( | const Camera * | cam | ) | const

virtual inherited

Overridden from Renderable.

Implements Ogre::Renderable.

Definition at line 469 of file OgreOverlayElement.h.

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

## getTechnique()

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

virtual inherited

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

Definition at line 94 of file OgreRenderable.h.

## getTileX()

Real Ogre::PanelOverlayElement::getTileX | ( | ushort | layer = `0` | ) | const

inherited

## getTileY()

Real Ogre::PanelOverlayElement::getTileY | ( | ushort | layer = `0` | ) | const

inherited

Gets the number of times the texture should repeat vertically.

Parameters

  layer | The texture layer to specify (only needs to be altered if you're using a multi-texture layer material)

## getTop()

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

inherited

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

## getTopBorderSize()

Real Ogre::BorderPanelOverlayElement::getTopBorderSize | ( | void |  | ) | const

Gets the size of the top border.

## getTopBorderUVString()

String Ogre::BorderPanelOverlayElement::getTopBorderUVString | ( |  | ) | const

## getTopLeftBorderUVString()

String Ogre::BorderPanelOverlayElement::getTopLeftBorderUVString | ( |  | ) | const

## getTopRightBorderUVString()

String Ogre::BorderPanelOverlayElement::getTopRightBorderUVString | ( |  | ) | const

## getTypeName()

const String& Ogre::BorderPanelOverlayElement::getTypeName | ( | void |  | ) | const

virtual

See OverlayElement.

Reimplemented from Ogre::PanelOverlayElement.

## getUseIdentityProjection()

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

inherited

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 178 of file OgreRenderable.h.

## getUseIdentityView()

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

inherited

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 203 of file OgreRenderable.h.

## getUserAny()

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny | ( | void |  | ) | const

virtual inherited

Deprecated:
  use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 349 of file OgreRenderable.h.

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

## getUserObjectBindings() [1/2]

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

inherited

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 355 of file OgreRenderable.h.

## getUserObjectBindings() [2/2]

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

inherited

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 361 of file OgreRenderable.h.

## getUV()

void Ogre::PanelOverlayElement::getUV | ( | Real & | u1,
|  | Real & | v1,
|  | Real & | u2,
|  | Real & | v2
| ) |  | const

inherited

Get the uv coordinates for the panel.

## getVerticalAlignment()

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

virtual inherited

Gets the vertical alignment for this element.

## getWidth()

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

inherited

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

## getWorldTransforms()

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

virtual inherited

See Renderable.

Implements Ogre::Renderable.

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

## getZOrder()

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

inherited

Returns the zOrder of the element.

Definition at line 465 of file OgreOverlayElement.h.

## hasCustomParameter()

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

inherited

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

Parameters

  index | Index of the parameter to check for existence.

See also
  setCustomParameter for full details.

Definition at line 259 of file OgreRenderable.h.

## hide()

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

virtual inherited

Hides this element if it was visible.

## initialise()

virtual void Ogre::BorderPanelOverlayElement::initialise | ( | void |  | ) |

virtual

Initialise.

Reimplemented from Ogre::PanelOverlayElement.

## isChildrenProcessEvents()

virtual bool Ogre::OverlayContainer::isChildrenProcessEvents | ( |  | ) | const

virtual inherited

Should this container pass events to their children.

Definition at line 129 of file OgreOverlayContainer.h.

## isCloneable()

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

virtual inherited

Definition at line 450 of file OgreOverlayElement.h.

## isContainer()

bool Ogre::OverlayContainer::isContainer | ( |  | ) | const

virtual inherited

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

Definition at line 125 of file OgreOverlayContainer.h.

## isEnabled()

bool Ogre::OverlayElement::isEnabled | ( |  | ) | const

inherited

## isKeyEnabled()

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

virtual inherited

Definition at line 447 of file OgreOverlayElement.h.

## isTransparent()

bool Ogre::PanelOverlayElement::isTransparent | ( | void |  | ) | const

inherited

Returns whether this panel is transparent.

## isVisible()

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

inherited

Returns whether or not the element is visible.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## postRender()

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

virtual inherited

Called immediately after the Renderable has been rendered.

Definition at line 128 of file OgreRenderable.h.

## preRender()

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

virtual inherited

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 123 of file OgreRenderable.h.

## removeChild()

virtual void Ogre::OverlayContainer::removeChild | ( | const String & | name | ) |

virtual inherited

Removes a named element from this container.

## removeCustomParameter()

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

inherited

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

Parameters

  index | Index of the parameter to remove.

See also
  setCustomParameter for full details.

Definition at line 250 of file OgreRenderable.h.

## setBorderMaterialName()

void Ogre::BorderPanelOverlayElement::setBorderMaterialName | ( | const String & | name | ) |

Sets the name of the material to use for the borders.

## setBorderSize() [1/3]

void Ogre::BorderPanelOverlayElement::setBorderSize | ( | Real | size | ) |

Sets the size of the border.

Remarks
  This method sets a constant size for all borders. There are also alternative methods which allow you to set border widths for individual edges separately. Remember that the dimensions specified here are in relation to the size of the screen, so 0.1 is 1/10th of the screen width or height. Also note that because most screen resolutions are 1.333:1 width:height ratio that using the same border size will look slightly bigger across than up.

Parameters

  size | The size of the border as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.

## setBorderSize() [2/3]

void Ogre::BorderPanelOverlayElement::setBorderSize | ( | Real | sides,
|  | Real | topAndBottom
| ) |  |

Sets the size of the border, with different sizes for vertical and horizontal borders.

Remarks
  This method sets a size for the side and top / bottom borders separately. Remember that the dimensions specified here are in relation to the size of the screen, so 0.1 is 1/10th of the screen width or height. Also note that because most screen resolutions are 1.333:1 width:height ratio that using the same border size will look slightly bigger across than up.

Parameters

  sides | The size of the side borders as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.
  topAndBottom | The size of the top and bottom borders as a factor of the screen dimensions.

## setBorderSize() [3/3]

void Ogre::BorderPanelOverlayElement::setBorderSize | ( | Real | left,
|  | Real | right,
|  | Real | top,
|  | Real | bottom
| ) |  |

Sets the size of the border separately for all borders.

Remarks
  This method sets a size all borders separately. Remember that the dimensions specified here are in relation to the size of the screen, so 0.1 is 1/10th of the screen width or height. Also note that because most screen resolutions are 1.333:1 width:height ratio that using the same border size will look slightly bigger across than up.

Parameters

  left | The size of the left border as a factor of the screen dimensions ie 0.2 is one-fifth of the screen size.
  right | The size of the left border as a factor of the screen dimensions.
  top | The size of the top border as a factor of the screen dimensions.
  bottom | The size of the bottom border as a factor of the screen dimensions.

## setBottomBorderUV()

void Ogre::BorderPanelOverlayElement::setBottomBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the bottom edge of the border.

Remarks
  See setLeftBorderUV.

## setBottomLeftBorderUV()

void Ogre::BorderPanelOverlayElement::setBottomLeftBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the bottom-left corner of the border.

Remarks
  See setLeftBorderUV.

## setBottomRightBorderUV()

void Ogre::BorderPanelOverlayElement::setBottomRightBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the bottom-right corner of the border.

Remarks
  See setLeftBorderUV.

## setCaption()

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

virtual inherited

Sets the caption on elements that support it.

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

Reimplemented in Ogre::TextAreaOverlayElement.

## setChildrenProcessEvents()

virtual void Ogre::OverlayContainer::setChildrenProcessEvents | ( | bool | val | ) |

virtual inherited

Should this container pass events to their children.

Definition at line 133 of file OgreOverlayContainer.h.

## setCloneable()

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

virtual inherited

Definition at line 453 of file OgreOverlayElement.h.

## setColour()

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

virtual inherited

Sets the colour on elements that support it.

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

Reimplemented in Ogre::TextAreaOverlayElement.

## setCustomParameter()

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

inherited

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

  index | The 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.
  value | The value to associate.

Definition at line 241 of file OgreRenderable.h.

## setDimensions()

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

## setEnabled()

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

virtual inherited

## setHeight()

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

inherited

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

## setHorizontalAlignment()

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

virtual inherited

Sets the horizontal origin for this element.

Remarks
  By default, the horizontal origin for a OverlayElement is the left edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-based metrics (see setMetricsMode) since in this mode you can't use relative positioning.

  For example, if you were using GMM_PIXELS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use GHA_CENTER with a 'left' property of -15.

  Note that neither GHA_CENTER or GHA_RIGHT alter the position of the element based on it's width, you have to alter the 'left' to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and right with different 'left' offsets for maximum flexibility.

## setLeft()

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

inherited

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

## setLeftBorderUV()

void Ogre::BorderPanelOverlayElement::setLeftBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the left edge of the border.

Remarks
  The border panel uses 8 panels for the border (9 including the center). Imagine a table with 3 rows and 3 columns. The corners are always the same size, but the edges stretch depending on how big the panel is. Those who have done resizable HTML tables will be familiar with this approach.

  We only require 2 sets of uv coordinates, one for the top-left and one for the bottom-right of the panel, since it is assumed the sections are aligned on the texture.

## setMaterialName()

void Ogre::PanelOverlayElement::setMaterialName | ( | const String & | matName | ) |

virtual inherited

Overridden from OverlayElement.

Reimplemented from Ogre::OverlayElement.

## setMetricsMode()

void Ogre::BorderPanelOverlayElement::setMetricsMode | ( | GuiMetricsMode | gmm | ) |

virtual

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

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

Reimplemented from Ogre::OverlayElement.

## setParameter()

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

virtual inherited

Generic parameter setting method.

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

Parameters

  name | The name of the parameter to set
  value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns
  true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

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

## setParameterList()

virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) |

virtual inherited

Generic multiple parameter setting method.

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

Parameters

  paramList | Name/value pair list

## setPolygonModeOverrideable()

virtual void Ogre::Renderable::setPolygonModeOverrideable | ( | bool | override | ) |

virtual inherited

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

Parameters

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

Definition at line 324 of file OgreRenderable.h.

## setPosition()

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)

## setRenderSystemData()

virtual void Ogre::Renderable::setRenderSystemData | ( | RenderSystemData * | val | ) | const

virtual inherited

Sets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 407 of file OgreRenderable.h.

## setRightBorderUV()

void Ogre::BorderPanelOverlayElement::setRightBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the right edge of the border.

Remarks
  See setLeftBorderUV.

## setTiling()

void Ogre::PanelOverlayElement::setTiling | ( | Real | x,
|  | Real | y,
|  | ushort | layer = `0`
| ) |  |

inherited

Sets the number of times textures should repeat.

Parameters

  x | The number of times the texture should repeat horizontally
  y | The number of times the texture should repeat vertically
  layer | The texture layer to specify (only needs to be altered if you're using a multi-texture layer material)

## setTop()

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

inherited

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

## setTopBorderUV()

void Ogre::BorderPanelOverlayElement::setTopBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the top edge of the border.

Remarks
  See setLeftBorderUV.

## setTopLeftBorderUV()

void Ogre::BorderPanelOverlayElement::setTopLeftBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the top-left corner of the border.

Remarks
  See setLeftBorderUV.

## setTopRightBorderUV()

void Ogre::BorderPanelOverlayElement::setTopRightBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

Sets the texture coordinates for the top-right corner of the border.

Remarks
  See setLeftBorderUV.

## setTransparent()

void Ogre::PanelOverlayElement::setTransparent | ( | bool | isTransparent | ) |

inherited

Sets whether this panel is transparent (used only as a grouping level), or if it is actually rendered.

## setUseIdentityProjection()

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

inherited

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 164 of file OgreRenderable.h.

## setUseIdentityView()

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

inherited

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 189 of file OgreRenderable.h.

## setUserAny()

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny | ( | const Any & | anything | ) |

virtual inherited

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 344 of file OgreRenderable.h.

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

## setUV()

void Ogre::PanelOverlayElement::setUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |  |

inherited

Sets the texture coordinates for the panel.

## setVerticalAlignment()

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

virtual inherited

Sets the vertical origin for this element.

Remarks
  By default, the vertical origin for a OverlayElement is the top edge of the parent container (or the screen if this is a root element). You can alter this by calling this method, which is especially useful when you want to use pixel-based metrics (see setMetricsMode) since in this mode you can't use relative positioning.

  For example, if you were using GMM_PIXELS metrics mode, and you wanted to place a 30x30 pixel crosshair in the center of the screen, you would use GHA_CENTER with a 'top' property of -15.

  Note that neither GVA_CENTER or GVA_BOTTOM alter the position of the element based on it's height, you have to alter the 'top' to a negative number to do that; all this does is establish the origin. This is because this way you can align multiple things in the center and bottom with different 'top' offsets for maximum flexibility.

## setWidth()

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

inherited

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

## show()

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

virtual inherited

Shows this element if it was hidden.

## updatePositionGeometry()

void Ogre::BorderPanelOverlayElement::updatePositionGeometry | ( | void |  | ) |

protected virtual

internal method for setting up geometry, called by OverlayElement::update

Reimplemented from Ogre::PanelOverlayElement.

## updateTextureGeometry()

void Ogre::BorderPanelOverlayElement::updateTextureGeometry | ( | void |  | ) |

protected virtual

internal method for setting up geometry, called by OverlayElement::update

Reimplemented from Ogre::PanelOverlayElement.

## visitRenderables()

void Ogre::BorderPanelOverlayElement::visitRenderables | ( | Renderable::Visitor * | visitor,
|  | bool | debugRenderables = `false`
| ) |  |

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters

  visitor | Pointer 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.
  debugRenderables | If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

## Friends And Related Function Documentation

## BorderRenderable

friend class BorderRenderable

friend

Definition at line 59 of file OgreBorderPanelOverlayElement.h.

## Member Data Documentation

## mBorderMaterial

MaterialPtr Ogre::BorderPanelOverlayElement::mBorderMaterial

protected

Definition at line 274 of file OgreBorderPanelOverlayElement.h.

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

## mBorderMaterialName

String Ogre::BorderPanelOverlayElement::mBorderMaterialName

protected

Definition at line 273 of file OgreBorderPanelOverlayElement.h.

## mBorderRenderable

BorderRenderable* Ogre::BorderPanelOverlayElement::mBorderRenderable

protected

Definition at line 312 of file OgreBorderPanelOverlayElement.h.

## mBorderUV

CellUV Ogre::BorderPanelOverlayElement::mBorderUV[8]

protected

Definition at line 266 of file OgreBorderPanelOverlayElement.h.

## mBottomBorderSize

Real Ogre::BorderPanelOverlayElement::mBottomBorderSize

protected

Definition at line 262 of file OgreBorderPanelOverlayElement.h.

## mCaption

DisplayString Ogre::OverlayElement::mCaption

protected inherited

Definition at line 135 of file OgreOverlayElement.h.

## mChildContainers

ChildContainerMap Ogre::OverlayContainer::mChildContainers

protected inherited

Map of container children (subset of mChildren)

Definition at line 67 of file OgreOverlayContainer.h.

## mChildren

ChildMap Ogre::OverlayContainer::mChildren

protected inherited

Map of all children.

Definition at line 65 of file OgreOverlayContainer.h.

## mChildrenProcessEvents

bool Ogre::OverlayContainer::mChildrenProcessEvents

protected inherited

Definition at line 69 of file OgreOverlayContainer.h.

## mClippingRegion

RealRect Ogre::OverlayElement::mClippingRegion

protected inherited

Definition at line 137 of file OgreOverlayElement.h.

## mCloneable

bool Ogre::OverlayElement::mCloneable

protected inherited

Definition at line 128 of file OgreOverlayElement.h.

## mColour

ColourValue Ogre::OverlayElement::mColour

protected inherited

Definition at line 136 of file OgreOverlayElement.h.

## mCustomParameters

CustomParameterMap Ogre::Renderable::mCustomParameters

protected inherited

Definition at line 415 of file OgreRenderable.h.

## mDerivedLeft

Real Ogre::OverlayElement::mDerivedLeft

protected inherited

Definition at line 157 of file OgreOverlayElement.h.

## mDerivedOutOfDate

bool Ogre::OverlayElement::mDerivedOutOfDate

protected inherited

Definition at line 159 of file OgreOverlayElement.h.

## mDerivedTop

Real Ogre::OverlayElement::mDerivedTop

protected inherited

Definition at line 158 of file OgreOverlayElement.h.

## mEnabled

bool Ogre::OverlayElement::mEnabled

protected inherited

Is element enabled?

Definition at line 174 of file OgreOverlayElement.h.

## mGeomPositionsOutOfDate

bool Ogre::OverlayElement::mGeomPositionsOutOfDate

protected inherited

Flag indicating if the vertex positions need recalculating.

Definition at line 162 of file OgreOverlayElement.h.

## mGeomUVsOutOfDate

bool Ogre::OverlayElement::mGeomUVsOutOfDate

protected inherited

Flag indicating if the vertex uvs need recalculating.

Definition at line 164 of file OgreOverlayElement.h.

## mHeight

Real Ogre::OverlayElement::mHeight

protected inherited

Definition at line 132 of file OgreOverlayElement.h.

## mHorzAlign

GuiHorizontalAlignment Ogre::OverlayElement::mHorzAlign

protected inherited

Definition at line 140 of file OgreOverlayElement.h.

## mInitialised

bool Ogre::OverlayElement::mInitialised

protected inherited

Is element initialised?

Definition at line 177 of file OgreOverlayElement.h.

## mLeft

Real Ogre::OverlayElement::mLeft

protected inherited

Definition at line 129 of file OgreOverlayElement.h.

## mLeftBorderSize

Real Ogre::BorderPanelOverlayElement::mLeftBorderSize

protected

Definition at line 259 of file OgreBorderPanelOverlayElement.h.

## mMaterial

MaterialPtr Ogre::OverlayElement::mMaterial

protected inherited

Definition at line 134 of file OgreOverlayElement.h.

## mMaterialName

String Ogre::OverlayElement::mMaterialName

protected inherited

Definition at line 133 of file OgreOverlayElement.h.

## mMetricsMode

GuiMetricsMode Ogre::OverlayElement::mMetricsMode

protected inherited

Definition at line 139 of file OgreOverlayElement.h.

## mName

String Ogre::OverlayElement::mName

protected inherited

Definition at line 126 of file OgreOverlayElement.h.

## mNumTexCoordsInBuffer

size_t Ogre::PanelOverlayElement::mNumTexCoordsInBuffer

protected inherited

Definition at line 134 of file OgrePanelOverlayElement.h.

## mOverlay

Overlay* Ogre::OverlayElement::mOverlay

protected inherited

Overlay attached to.

Definition at line 154 of file OgreOverlayElement.h.

## mParent

OverlayContainer* Ogre::OverlayElement::mParent

protected inherited

Parent pointer.

Definition at line 152 of file OgreOverlayElement.h.

## mPixelBottomBorderSize

ushort Ogre::BorderPanelOverlayElement::mPixelBottomBorderSize

protected

Definition at line 271 of file OgreBorderPanelOverlayElement.h.

## mPixelHeight

Real Ogre::OverlayElement::mPixelHeight

protected inherited

Definition at line 147 of file OgreOverlayElement.h.

## mPixelLeft

Real Ogre::OverlayElement::mPixelLeft

protected inherited

Definition at line 145 of file OgreOverlayElement.h.

## mPixelLeftBorderSize

ushort Ogre::BorderPanelOverlayElement::mPixelLeftBorderSize

protected

Definition at line 268 of file OgreBorderPanelOverlayElement.h.

## mPixelRightBorderSize

ushort Ogre::BorderPanelOverlayElement::mPixelRightBorderSize

protected

Definition at line 269 of file OgreBorderPanelOverlayElement.h.

## mPixelScaleX

Real Ogre::OverlayElement::mPixelScaleX

protected inherited

Definition at line 148 of file OgreOverlayElement.h.

## mPixelScaleY

Real Ogre::OverlayElement::mPixelScaleY

protected inherited

Definition at line 149 of file OgreOverlayElement.h.

## mPixelTop

Real Ogre::OverlayElement::mPixelTop

protected inherited

Definition at line 144 of file OgreOverlayElement.h.

## mPixelTopBorderSize

ushort Ogre::BorderPanelOverlayElement::mPixelTopBorderSize

protected

Definition at line 270 of file OgreBorderPanelOverlayElement.h.

## mPixelWidth

Real Ogre::OverlayElement::mPixelWidth

protected inherited

Definition at line 146 of file OgreOverlayElement.h.

## mPolygonModeOverrideable

bool Ogre::Renderable::mPolygonModeOverrideable

protected inherited

Definition at line 416 of file OgreRenderable.h.

## mRenderOp

RenderOperation Ogre::PanelOverlayElement::mRenderOp

protected inherited

Definition at line 137 of file OgrePanelOverlayElement.h.

## mRenderOp2

RenderOperation Ogre::BorderPanelOverlayElement::mRenderOp2

protected

Render operation for the border area.

Definition at line 277 of file OgreBorderPanelOverlayElement.h.

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

## mRenderSystemData

RenderSystemData* Ogre::Renderable::mRenderSystemData

mutable protected inherited

User objects binding.

Definition at line 420 of file OgreRenderable.h.

## mRightBorderSize

Real Ogre::BorderPanelOverlayElement::mRightBorderSize

protected

Definition at line 260 of file OgreBorderPanelOverlayElement.h.

## msCaptionCmd

OverlayElementCommands::CmdCaption Ogre::OverlayElement::msCaptionCmd

static protected inherited

Definition at line 119 of file OgreOverlayElement.h.

## msCmdBorderBottomLeftUV

CmdBorderBottomLeftUV Ogre::BorderPanelOverlayElement::msCmdBorderBottomLeftUV

static protected

Definition at line 308 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderBottomRightUV

CmdBorderBottomRightUV Ogre::BorderPanelOverlayElement::msCmdBorderBottomRightUV

static protected

Definition at line 310 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderBottomUV

CmdBorderBottomUV Ogre::BorderPanelOverlayElement::msCmdBorderBottomUV

static protected

Definition at line 305 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderLeftUV

CmdBorderLeftUV Ogre::BorderPanelOverlayElement::msCmdBorderLeftUV

static protected

Definition at line 303 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderMaterial

CmdBorderMaterial Ogre::BorderPanelOverlayElement::msCmdBorderMaterial

static protected

Definition at line 302 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderRightUV

CmdBorderRightUV Ogre::BorderPanelOverlayElement::msCmdBorderRightUV

static protected

Definition at line 306 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderSize

CmdBorderSize Ogre::BorderPanelOverlayElement::msCmdBorderSize

static protected

Definition at line 301 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderTopLeftUV

CmdBorderTopLeftUV Ogre::BorderPanelOverlayElement::msCmdBorderTopLeftUV

static protected

Definition at line 307 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderTopRightUV

CmdBorderTopRightUV Ogre::BorderPanelOverlayElement::msCmdBorderTopRightUV

static protected

Definition at line 309 of file OgreBorderPanelOverlayElement.h.

## msCmdBorderTopUV

CmdBorderTopUV Ogre::BorderPanelOverlayElement::msCmdBorderTopUV

static protected

Definition at line 304 of file OgreBorderPanelOverlayElement.h.

## msCmdTiling

CmdTiling Ogre::PanelOverlayElement::msCmdTiling

static protected inherited

Definition at line 151 of file OgrePanelOverlayElement.h.

## msCmdTransparent

CmdTransparent Ogre::PanelOverlayElement::msCmdTransparent

static protected inherited

Definition at line 152 of file OgrePanelOverlayElement.h.

## msCmdUVCoords

CmdUVCoords Ogre::PanelOverlayElement::msCmdUVCoords

static protected inherited

Definition at line 153 of file OgrePanelOverlayElement.h.

## msHeightCmd

OverlayElementCommands::CmdHeight Ogre::OverlayElement::msHeightCmd

static protected inherited

Definition at line 117 of file OgreOverlayElement.h.

## msHorizontalAlignCmd

OverlayElementCommands::CmdHorizontalAlign Ogre::OverlayElement::msHorizontalAlignCmd

static protected inherited

Definition at line 121 of file OgreOverlayElement.h.

## msLeftCmd

OverlayElementCommands::CmdLeft Ogre::OverlayElement::msLeftCmd

static protected inherited

Definition at line 114 of file OgreOverlayElement.h.

## msMaterialCmd

OverlayElementCommands::CmdMaterial Ogre::OverlayElement::msMaterialCmd

static protected inherited

Definition at line 118 of file OgreOverlayElement.h.

## msMetricsModeCmd

OverlayElementCommands::CmdMetricsMode Ogre::OverlayElement::msMetricsModeCmd

static protected inherited

Definition at line 120 of file OgreOverlayElement.h.

## mSourceTemplate

OverlayElement* Ogre::OverlayElement::mSourceTemplate

protected inherited

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

Definition at line 180 of file OgreOverlayElement.h.

## msTopCmd

OverlayElementCommands::CmdTop Ogre::OverlayElement::msTopCmd

static protected inherited

Definition at line 115 of file OgreOverlayElement.h.

## msTypeName

String Ogre::BorderPanelOverlayElement::msTypeName

static protected

Definition at line 279 of file OgreBorderPanelOverlayElement.h.

## msVerticalAlignCmd

OverlayElementCommands::CmdVerticalAlign Ogre::OverlayElement::msVerticalAlignCmd

static protected inherited

Definition at line 122 of file OgreOverlayElement.h.

## msVisibleCmd

OverlayElementCommands::CmdVisible Ogre::OverlayElement::msVisibleCmd

static protected inherited

Definition at line 123 of file OgreOverlayElement.h.

## msWidthCmd

OverlayElementCommands::CmdWidth Ogre::OverlayElement::msWidthCmd

static protected inherited

Definition at line 116 of file OgreOverlayElement.h.

## mTileX

Real Ogre::PanelOverlayElement::mTileX[OGRE_MAX_TEXTURE_LAYERS]

protected inherited

Definition at line 132 of file OgrePanelOverlayElement.h.

## mTileY

Real Ogre::PanelOverlayElement::mTileY[OGRE_MAX_TEXTURE_LAYERS]

protected inherited

Definition at line 133 of file OgrePanelOverlayElement.h.

## mTop

Real Ogre::OverlayElement::mTop

protected inherited

Definition at line 130 of file OgreOverlayElement.h.

## mTopBorderSize

Real Ogre::BorderPanelOverlayElement::mTopBorderSize

protected

Definition at line 261 of file OgreBorderPanelOverlayElement.h.

## mTransparent

bool Ogre::PanelOverlayElement::mTransparent

protected inherited

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

Definition at line 130 of file OgrePanelOverlayElement.h.

## mU1

Real Ogre::PanelOverlayElement::mU1

protected inherited

Definition at line 135 of file OgrePanelOverlayElement.h.

## mU2

Real Ogre::PanelOverlayElement::mU2

protected inherited

Definition at line 135 of file OgrePanelOverlayElement.h.

## mUseIdentityProjection

bool Ogre::Renderable::mUseIdentityProjection

protected inherited

Definition at line 417 of file OgreRenderable.h.

## mUseIdentityView

bool Ogre::Renderable::mUseIdentityView

protected inherited

Definition at line 418 of file OgreRenderable.h.

## mUserObjectBindings

UserObjectBindings Ogre::Renderable::mUserObjectBindings

protected inherited

Definition at line 419 of file OgreRenderable.h.

## mV1

Real Ogre::PanelOverlayElement::mV1

protected inherited

Definition at line 135 of file OgrePanelOverlayElement.h.

## mV2

Real Ogre::PanelOverlayElement::mV2

protected inherited

Definition at line 135 of file OgrePanelOverlayElement.h.

## mVertAlign

GuiVerticalAlignment Ogre::OverlayElement::mVertAlign

protected inherited

Definition at line 141 of file OgreOverlayElement.h.

## mVisible

bool Ogre::OverlayElement::mVisible

protected inherited

Definition at line 127 of file OgreOverlayElement.h.

## mWidth

Real Ogre::OverlayElement::mWidth

protected inherited

Definition at line 131 of file OgreOverlayElement.h.

## mXForm

Matrix4 Ogre::OverlayElement::mXForm

protected inherited

World transforms.

Definition at line 171 of file OgreOverlayElement.h.

## mZOrder

ushort Ogre::OverlayElement::mZOrder

protected inherited

Zorder for when sending to render queue.

Derived from parent

Definition at line 168 of file OgreOverlayElement.h.

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

- OgreBorderPanelOverlayElement.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.