Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

# Ogre::BorderPanelOverlayElement Class Reference

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

`#include <OgreBorderPanelOverlayElement.h>`

Inheritance diagram for Ogre::BorderPanelOverlayElement:

[legend]
List of all members.

## Public Types
typedef std::map< String, OverlayElement * > | ChildMap
typedef MapIterator< ChildMap > | ChildIterator
typedef std::map< String, OverlayContainer * > | ChildContainerMap
typedef MapIterator< ChildContainerMap > | ChildContainerIterator
## Public Member Functions
| BorderPanelOverlayElement (const String &name)
| Constructor.
virtual | ~BorderPanelOverlayElement ()
virtual void | initialise (void)
| Initialise.
const String & | getTypeName (void) const
| See OverlayElement.
void | setBorderSize (Real size)
| Sets the size of the border.
void | setBorderSize (Real sides, Real topAndBottom)
| Sets the size of the border, with different sizes for vertical and horizontal borders.
void | setBorderSize (Real left, Real right, Real top, Real bottom)
| Sets the size of the border separately for all borders.
Real | getLeftBorderSize (void) const
| Gets the size of the left border.
Real | getRightBorderSize (void) const
| Gets the size of the right border.
Real | getTopBorderSize (void) const
| Gets the size of the top border.
Real | getBottomBorderSize (void) const
| Gets the size of the bottom border.
void | setLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the left edge of the border.
void | setRightBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the right edge of the border.
void | setTopBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the top edge of the border.
void | setBottomBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the bottom edge of the border.
void | setTopLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the top-left corner of the border.
void | setTopRightBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the top-right corner of the border.
void | setBottomLeftBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the bottom-left corner of the border.
void | setBottomRightBorderUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the bottom-right corner of the border.
String | getLeftBorderUVString () const
String | getRightBorderUVString () const
String | getTopBorderUVString () const
String | getBottomBorderUVString () const
String | getTopLeftBorderUVString () const
String | getTopRightBorderUVString () const
String | getBottomLeftBorderUVString () const
String | getBottomRightBorderUVString () const
void | setBorderMaterialName (const String &name)
| Sets the name of the material to use for the borders.
const String & | getBorderMaterialName (void) const
| Gets the name of the material to use for the borders.
void | _updateRenderQueue (RenderQueue *queue)
| Overridden from OverlayContainer.
void | setMetricsMode (GuiMetricsMode gmm)
| Overridden from OverlayElement.
void | _update (void)
| Overridden from OverlayElement.
void | setTiling (Real x, Real y, ushort layer=0)
| Sets the number of times textures should repeat.
Real | getTileX (ushort layer=0) const
Real | getTileY (ushort layer=0) const
| Gets the number of times the texture should repeat vertically.
void | setUV (Real u1, Real v1, Real u2, Real v2)
| Sets the texture coordinates for the panel.
void | getUV (Real &u1, Real &v1, Real &u2, Real &v2) const
| Get the uv coordinates for the panel.
void | setTransparent (bool isTransparent)
| Sets whether this panel is transparent (used only as a grouping level), or if it is actually renderred.
bool | isTransparent (void) const
| Returns whether this panel is transparent.
void | getRenderOperation (RenderOperation &op)
| See Renderable.
void | setMaterialName (const String &matName)
| Overridden from OverlayElement.
virtual void | addChild (OverlayElement *elem)
| Adds another OverlayElement to this container.
virtual void | addChildImpl (OverlayElement *elem)
| Adds another OverlayElement to this container.
virtual void | addChildImpl (OverlayContainer *cont)
| Add a nested container to this container.
virtual void | removeChild (const String &name)
| Removes a named element from this container.
virtual OverlayElement * | getChild (const String &name)
| Gets the named child of this container.
void | _addChild (OverlayElement *elem)
void | _removeChild (OverlayElement *elem)
void | _removeChild (const String &name)
virtual ChildIterator | getChildIterator (void)
| Gets an object for iterating over all the children of this object.
virtual ChildContainerIterator | getChildContainerIterator (void)
| Gets an iterator for just the container children of this object.
virtual void | _positionsOutOfDate (void)
| Tell the object and its children to recalculate.
virtual void | _notifyZOrder (ushort newZOrder)
| Overridden from OverlayElement.
virtual void | _notifyViewport ()
| Overridden from OverlayElement.
virtual void | _notifyWorldTransforms (const Matrix4 &xform)
| Overridden from OverlayElement.
virtual void | _notifyParent (OverlayContainer *parent, Overlay *overlay)
| Overridden from OverlayElement.
bool | isContainer () const
| Overridden from OverlayElement.
virtual bool | isChildrenProcessEvents () const
| Should this container pass events to their children.
virtual void | setChildrenProcessEvents (bool val)
| Should this container pass events to their children.
virtual OverlayElement * | findElementAt (Real x, Real y)
| This returns a OverlayElement at position x,y.
void | copyFromTemplate (OverlayElement *templateOverlay)
virtual OverlayElement * | clone (const String &instanceName)
const String & | getName (void) const
| Gets the name of this overlay.
virtual void | show (void)
| Shows this element if it was hidden.
virtual void | hide (void)
| Hides this element if it was visible.
bool | isVisible (void) const
| Returns whether or not the element is visible.
bool | isEnabled () const
virtual void | setEnabled (bool b)
void | setDimensions (Real width, Real height)
| Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).
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).
void | setWidth (Real width)
| Sets the width of this element in relation to the screen (where 1.0 = screen width).
Real | getWidth (void) const
| Gets the width of this element in relation to the screen (where 1.0 = screen width).
void | setHeight (Real height)
| Sets the height of this element in relation to the screen (where 1.0 = screen height).
Real | getHeight (void) const
| Gets the height of this element in relation to the screen (where 1.0 = screen height).
void | setLeft (Real left)
| Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Real | getLeft (void) const
| Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
void | setTop (Real Top)
| Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
Real | getTop (void) const
| Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
Real | _getLeft (void) const
| Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Real | _getTop (void) const
| Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Real | _getWidth (void) const
| Gets the width of this element in relation to the screen (where 1.0 = screen width).
Real | _getHeight (void) const
| Gets the height of this element in relation to the screen (where 1.0 = screen height).
void | _setLeft (Real left)
| Sets the left of this element in relation to the screen (where 1.0 = screen width).
void | _setTop (Real top)
| Sets the top of this element in relation to the screen (where 1.0 = screen width).
void | _setWidth (Real width)
| Sets the width of this element in relation to the screen (where 1.0 = screen width).
void | _setHeight (Real height)
| Sets the height of this element in relation to the screen (where 1.0 = screen width).
void | _setPosition (Real left, Real top)
| Sets the left and top of this element in relation to the screen (where 1.0 = screen width).
void | _setDimensions (Real width, Real height)
| Sets the width and height of this element in relation to the screen (where 1.0 = screen width).
virtual const String & | getMaterialName (void) const
| Gets the name of the material this element uses.
const MaterialPtr & | getMaterial (void) const
| See Renderable.
void | getWorldTransforms (Matrix4 *xform) const
| See Renderable.
const Quaternion & | getWorldOrientation (void) const
const Vector3 & | getWorldPosition (void) const
virtual void | _updateFromParent (void)
| Updates this elements transform based on it's parent.
virtual Real | _getDerivedLeft (void)
| Gets the 'left' position as derived from own left and that of parents.
virtual Real | _getDerivedTop (void)
| Gets the 'top' position as derived from own left and that of parents.
virtual Real | _getRelativeWidth (void)
| Gets the 'width' as derived from own width and metrics mode.
virtual Real | _getRelativeHeight (void)
| Gets the 'height' as derived from own height and metrics mode.
virtual void | _getClippingRegion (Rectangle &clippingRegion)
| Gets the clipping region of the element.
virtual void | setCaption (const DisplayString &text)
| Sets the caption on elements that support it.
virtual const DisplayString & | getCaption (void) const
| Gets the caption for this element.
virtual void | setColour (const ColourValue &col)
| Sets the colour on elements that support it.
virtual const ColourValue & | getColour (void) const
| Gets the colour for this element.
virtual GuiMetricsMode | getMetricsMode (void) const
| Retrieves the current settings of how the element metrics are interpreted.
virtual void | setHorizontalAlignment (GuiHorizontalAlignment gha)
| Sets the horizontal origin for this element.
virtual GuiHorizontalAlignment | getHorizontalAlignment (void) const
| Gets the horizontal alignment for this element.
virtual void | setVerticalAlignment (GuiVerticalAlignment gva)
| Sets the vertical origin for this element.
virtual GuiVerticalAlignment | getVerticalAlignment (void) const
| Gets the vertical alignment for this element.
virtual bool | contains (Real x, Real y) const
| Returns true if xy is within the constraints of the component.
virtual bool | isKeyEnabled () const
virtual bool | isCloneable () const
virtual void | setCloneable (bool c)
OverlayContainer * | getParent ()
| Returns the parent container.
void | _setParent (OverlayContainer *parent)
ushort | getZOrder () const
| Returns the zOrder of the element.
Real | getSquaredViewDepth (const Camera *cam) const
| Overridden from Renderable.
const LightList & | getLights (void) const
| Remarks: Directional lights, which have no position, will always be first on this list.
const OverlayElement * | getSourceTemplate () const
ParamDictionary * | getParamDictionary (void)
| Retrieves the parameter dictionary for this class.
const ParamDictionary * | getParamDictionary (void) const
const ParameterList & | getParameters (void) const
| Retrieves a list of parameters valid for this object.
virtual bool | setParameter (const String &name, const String &value)
| Generic parameter setting method.
virtual void | setParameterList (const NameValuePairList &paramList)
| Generic multiple parameter setting method.
virtual String | getParameter (const String &name) const
| Generic parameter retrieval method.
virtual void | copyParametersTo (StringInterface *dest) const
| Method for copying this object's parameters to another object.
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses.
virtual unsigned short | getNumWorldTransforms (void) const
| Returns the number of world transform matrices this renderable requires.
void | setUseIdentityProjection (bool useIdentityProjection)
| Sets whether or not to use an 'identity' projection.
bool | getUseIdentityProjection (void) const
| Returns whether or not to use an 'identity' projection.
void | setUseIdentityView (bool useIdentityView)
| Sets whether or not to use an 'identity' view.
bool | getUseIdentityView (void) const
| Returns whether or not to use an 'identity' view.
virtual bool | getNormaliseNormals (void) const
| Returns whether or not this Renderable wishes the hardware to normalise normals.
virtual const PlaneList & | getClipPlanes () const
virtual bool | getCastsShadows (void) const
| Method which reports whether this renderable would normally cast a shadow.
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.
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index.
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
virtual void | setPolygonModeOverrideable (bool override)
| Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual bool | getPolygonModeOverrideable (void) const
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
## 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.
## 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 std::map< size_t, Vector4 > | CustomParameterMap
## Protected Member Functions
void | updatePositionGeometry (void)
| internal method for setting up geometry, called by OverlayElement::update
void | updateTextureGeometry (void)
| internal method for setting up geometry, called by OverlayElement::update
void | addBaseParameters (void)
| Internal method for setting up parameters.
String | getCellUVString (BorderCellIndex idx) const
bool | createParamDictionary (const String &className)
| Internal method for creating a parameter dictionary for the class, if it does not already exist.
## Protected Attributes
Real | mLeftBorderSize
Real | mRightBorderSize
Real | mTopBorderSize
Real | mBottomBorderSize
CellUV | mBorderUV [8]
ushort | mPixelLeftBorderSize
ushort | mPixelRightBorderSize
ushort | mPixelTopBorderSize
ushort | mPixelBottomBorderSize
String | mBorderMaterialName
MaterialPtr | mpBorderMaterial
RenderOperation | mRenderOp2
BorderRenderable * | mBorderRenderable
bool | mTransparent
Real | mTileX [OGRE_MAX_TEXTURE_LAYERS]
Real | mTileY [OGRE_MAX_TEXTURE_LAYERS]
size_t | mNumTexCoordsInBuffer
Real | mU1
Real | mV1
Real | mU2
Real | mV2
RenderOperation | mRenderOp
ChildMap | mChildren
ChildContainerMap | mChildContainers
bool | mChildrenProcessEvents
String | mName
bool | mVisible
bool | mCloneable
Real | mLeft
Real | mTop
Real | mWidth
Real | mHeight
String | mMaterialName
MaterialPtr | mpMaterial
DisplayString | mCaption
ColourValue | mColour
Rectangle | mClippingRegion
GuiMetricsMode | mMetricsMode
GuiHorizontalAlignment | mHorzAlign
GuiVerticalAlignment | mVertAlign
Real | mPixelTop
Real | mPixelLeft
Real | mPixelWidth
Real | mPixelHeight
Real | mPixelScaleX
Real | mPixelScaleY
OverlayContainer * | mParent
Overlay * | mOverlay
Real | mDerivedLeft
Real | mDerivedTop
bool | mDerivedOutOfDate
bool | mGeomPositionsOutOfDate
| Flag indicating if the vertex positons need recalculating.
bool | mGeomUVsOutOfDate
| Flag indicating if the vertex uvs need recalculating.
ushort | mZOrder
Matrix4 | mXForm
bool | mEnabled
bool | mInitialised
OverlayElement * | mSourceTemplate
String | mParamDictName
| Class name for this instance to be used as a lookup (must be initialised by subclasses).
CustomParameterMap | mCustomParameters
bool | mPolygonModeOverrideable
bool | mUseIdentityProjection
bool | mUseIdentityView
## Static Protected Attributes
static String | msTypeName
static CmdBorderSize | msCmdBorderSize
static CmdBorderMaterial | msCmdBorderMaterial
static CmdBorderLeftUV | msCmdBorderLeftUV
static CmdBorderTopUV | msCmdBorderTopUV
static CmdBorderBottomUV | msCmdBorderBottomUV
static CmdBorderRightUV | msCmdBorderRightUV
static CmdBorderTopLeftUV | msCmdBorderTopLeftUV
static CmdBorderBottomLeftUV | msCmdBorderBottomLeftUV
static CmdBorderTopRightUV | msCmdBorderTopRightUV
static CmdBorderBottomRightUV | msCmdBorderBottomRightUV
static CmdTiling | msCmdTiling
static CmdTransparent | msCmdTransparent
static CmdUVCoords | msCmdUVCoords
static OverlayElementCommands::CmdLeft | msLeftCmd
static OverlayElementCommands::CmdTop | msTopCmd
static OverlayElementCommands::CmdWidth | msWidthCmd
static OverlayElementCommands::CmdHeight | msHeightCmd
static OverlayElementCommands::CmdMaterial | msMaterialCmd
static OverlayElementCommands::CmdCaption | msCaptionCmd
static OverlayElementCommands::CmdMetricsMode | msMetricsModeCmd
static OverlayElementCommands::CmdHorizontalAlign | msHorizontalAlignCmd
static OverlayElementCommands::CmdVerticalAlign | msVerticalAlignCmd
static OverlayElementCommands::CmdVisible | msVisibleCmd
static ParamDictionaryMap | msDictionary
| Dictionary of parameters.
static const PlaneList | msDummyPlaneList
## Friends
class | BorderRenderable
## 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...

## 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 52 of file OgreBorderPanelOverlayElement.h.

## Member Typedef Documentation

typedef MapIterator<ChildContainerMap> Ogre::OverlayContainer::ChildContainerIterator`[inherited]`

| Definition at line 57 of file OgreOverlayContainer.h.

typedef std::map<String, OverlayContainer*> Ogre::OverlayContainer::ChildContainerMap`[inherited]`

| Definition at line 56 of file OgreOverlayContainer.h.

typedef MapIterator<ChildMap> Ogre::OverlayContainer::ChildIterator`[inherited]`

| Definition at line 55 of file OgreOverlayContainer.h.

typedef std::map<String, OverlayElement*> Ogre::OverlayContainer::ChildMap`[inherited]`

| Definition at line 54 of file OgreOverlayContainer.h.

typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap`[protected, inherited]`

| Definition at line 285 of file OgreRenderable.h.

## Member Enumeration Documentation

enum Ogre::BorderPanelOverlayElement::BorderCellIndex`[protected]`

  | Enumeration values:
  BCELL_TOP_LEFT |
  BCELL_TOP |
  BCELL_TOP_RIGHT |
  BCELL_LEFT |
  BCELL_RIGHT |
  BCELL_BOTTOM_LEFT |
  BCELL_BOTTOM |
  BCELL_BOTTOM_RIGHT |
Definition at line 280 of file OgreBorderPanelOverlayElement.h.

## Constructor & Destructor Documentation

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

| Constructor.

virtual Ogre::BorderPanelOverlayElement::~BorderPanelOverlayElement | ( |  | ) | `[virtual]`

## Member Function Documentation

void Ogre::OverlayContainer::_addChild | ( | OverlayElement * | elem | ) | `[inherited]`

virtual void Ogre::OverlayElement::_getClippingRegion | ( | Rectangle & | clippingRegion | ) | `[virtual, inherited]`

| Gets the clipping region of the element.

virtual Real Ogre::OverlayElement::_getDerivedLeft | ( | void |  | ) | `[virtual, inherited]`

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

virtual Real Ogre::OverlayElement::_getDerivedTop | ( | void |  | ) | `[virtual, inherited]`

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

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

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

virtual Real Ogre::OverlayElement::_getRelativeHeight | ( | void |  | ) | `[virtual, inherited]`

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

virtual Real Ogre::OverlayElement::_getRelativeWidth | ( | void |  | ) | `[virtual, inherited]`

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

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

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

virtual void Ogre::OverlayContainer::_notifyParent | ( | OverlayContainer * | parent,
|  | Overlay * | overlay
| ) | `[virtual, inherited]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayElement.

virtual void Ogre::OverlayContainer::_notifyViewport | ( |  | ) | `[virtual, inherited]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayElement.

virtual void Ogre::OverlayContainer::_notifyWorldTransforms | ( | const Matrix4 & | xform | ) | `[virtual, inherited]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayElement.

virtual void Ogre::OverlayContainer::_notifyZOrder | ( | ushort | newZOrder | ) | `[virtual, inherited]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayElement.

virtual void Ogre::OverlayContainer::_positionsOutOfDate | ( | void |  | ) | `[virtual, inherited]`

| Tell the object and its children to recalculate. Reimplemented from Ogre::OverlayElement.

void Ogre::OverlayContainer::_removeChild | ( | const String & | name | ) | `[inherited]`

void Ogre::OverlayContainer::_removeChild | ( | OverlayElement * | elem | ) | `[inherited]`

| Definition at line 86 of file OgreOverlayContainer.h.

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 | ) | `[inherited]`

| Definition at line 453 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::BorderPanelOverlayElement::_update | ( | void |  | ) | `[virtual]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayContainer.

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

virtual void Ogre::OverlayElement::_updateFromParent | ( | void |  | ) | `[virtual, inherited]`

| Updates this elements transform based on it's parent.

void Ogre::BorderPanelOverlayElement::_updateRenderQueue | ( | RenderQueue * | queue | ) | `[virtual]`

| Overridden from OverlayContainer. Reimplemented from Ogre::PanelOverlayElement.

void Ogre::BorderPanelOverlayElement::addBaseParameters | ( | void |  | ) | `[protected, virtual]`

| Internal method for setting up parameters. Reimplemented from Ogre::PanelOverlayElement.

virtual void Ogre::OverlayContainer::addChild | ( | OverlayElement * | elem | ) | `[virtual, inherited]`

| Adds another OverlayElement to this container.

virtual void Ogre::OverlayContainer::addChildImpl | ( | OverlayContainer * | cont | ) | `[virtual, inherited]`

| Add a nested container to this container.

virtual void Ogre::OverlayContainer::addChildImpl | ( | OverlayElement * | elem | ) | `[virtual, inherited]`

| Adds another OverlayElement to this container.

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.

virtual OverlayElement* Ogre::OverlayContainer::clone | ( | const String & | instanceName | ) | `[virtual, inherited]`

| Reimplemented from Ogre::OverlayElement.

virtual bool Ogre::OverlayElement::contains | ( | Real | x,
|  | Real | y
| ) | const`[virtual, inherited]`

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

void Ogre::OverlayContainer::copyFromTemplate | ( | OverlayElement * | templateOverlay | ) | `[virtual, inherited]`

| Reimplemented from Ogre::OverlayElement.

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 300 of file OgreStringInterface.h. References Ogre::ParamDictionary::mParamDefs.

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

virtual OverlayElement* Ogre::OverlayContainer::findElementAt | ( | Real | x,
|  | Real | y
| ) | `[virtual, inherited]`

| This returns a OverlayElement at position x,y. Reimplemented from Ogre::OverlayElement.

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

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

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

| Gets the size of the bottom border.

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

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

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

virtual const DisplayString& Ogre::OverlayElement::getCaption | ( | void |  | ) | const`[virtual, inherited]`

| Gets the caption for this element.

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::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity. Definition at line 187 of file OgreRenderable.h.

String Ogre::BorderPanelOverlayElement::getCellUVString | ( | BorderCellIndex | idx | ) | const`[protected]`

virtual OverlayElement* Ogre::OverlayContainer::getChild | ( | const String & | name | ) | `[virtual, inherited]`

| Gets the named child of this container.

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

virtual ChildIterator Ogre::OverlayContainer::getChildIterator | ( | void |  | ) | `[virtual, inherited]`

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

virtual const PlaneList& Ogre::Renderable::getClipPlanes | ( |  | ) | const`[virtual, inherited]`

| Definition at line 179 of file OgreRenderable.h.

virtual const ColourValue& Ogre::OverlayElement::getColour | ( | void |  | ) | const`[virtual, inherited]`

| Gets the colour for this element. Reimplemented in Ogre::TextAreaOverlayElement.

const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const`[inherited]`

  | Gets the custom value associated with this Renderable at the given index. Parameters:
  | @see | setCustomParaemter for full details.
Definition at line 213 of file OgreRenderable.h. References OGRE_EXCEPT.

Real Ogre::OverlayElement::getHeight | ( | void |  | ) | const`[inherited]`

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

virtual GuiHorizontalAlignment Ogre::OverlayElement::getHorizontalAlignment | ( | void |  | ) | const`[virtual, inherited]`

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

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

| Gets the size of the left border.

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

const LightList& Ogre::OverlayElement::getLights | ( | void |  | ) | const`[virtual, inherited]`

| Remarks: Directional lights, which have no position, will always be first on this list. Implements Ogre::Renderable. Definition at line 468 of file OgreOverlayElement.h. References Ogre::LightList.

const MaterialPtr& Ogre::OverlayElement::getMaterial | ( | void |  | ) | const`[virtual, inherited]`

| See Renderable. Implements Ogre::Renderable.

virtual const String& Ogre::OverlayElement::getMaterialName | ( | void |  | ) | const`[virtual, inherited]`

| Gets the name of the material this element uses.

virtual GuiMetricsMode Ogre::OverlayElement::getMetricsMode | ( | void |  | ) | const`[virtual, inherited]`

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

virtual bool Ogre::Renderable::getNormaliseNormals | ( | void |  | ) | const`[virtual, inherited]`

| Returns whether or not this Renderable wishes the hardware to normalise normals. Reimplemented in Ogre::SubEntity. Definition at line 171 of file OgreRenderable.h.

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::InstancedGeometry::GeometryBucket, and Ogre::SubEntity. Definition at line 111 of file OgreRenderable.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void |  | ) | const`[inherited]`

| Definition at line 213 of file OgreStringInterface.h.

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

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 269 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`[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 277 of file OgreRenderable.h.

void Ogre::PanelOverlayElement::getRenderOperation | ( | RenderOperation & | op | ) | `[virtual, inherited]`

| See Renderable. Implements Ogre::Renderable.

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

| Gets the size of the right border.

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

const OverlayElement* Ogre::OverlayElement::getSourceTemplate | ( |  | ) | const`[inherited]`

| Definition at line 479 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::getSquaredViewDepth | ( | const Camera * | cam | ) | const`[virtual, inherited]`

| Overridden from Renderable. Implements Ogre::Renderable. Definition at line 462 of file OgreOverlayElement.h.

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::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity. Definition at line 73 of file OgreRenderable.h.

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

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)

Real Ogre::OverlayElement::getTop | ( | void |  | ) | const`[inherited]`

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

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

| Gets the size of the top border.

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

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

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

const String& Ogre::BorderPanelOverlayElement::getTypeName | ( | void |  | ) | const`[virtual]`

| See OverlayElement. Reimplemented from Ogre::PanelOverlayElement.

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

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

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

| Get the uv coordinates for the panel.

virtual GuiVerticalAlignment Ogre::OverlayElement::getVerticalAlignment | ( | void |  | ) | const`[virtual, inherited]`

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

const Quaternion& Ogre::OverlayElement::getWorldOrientation | ( | void |  | ) | const`[virtual, inherited]`

| Implements Ogre::Renderable.

const Vector3& Ogre::OverlayElement::getWorldPosition | ( | void |  | ) | const`[virtual, inherited]`

| Implements Ogre::Renderable.

void Ogre::OverlayElement::getWorldTransforms | ( | Matrix4 * | xform | ) | const`[virtual, inherited]`

| See Renderable. Implements Ogre::Renderable.

ushort Ogre::OverlayElement::getZOrder | ( |  | ) | const`[inherited]`

| Returns the zOrder of the element. Definition at line 458 of file OgreOverlayElement.h.

virtual void Ogre::OverlayElement::hide | ( | void |  | ) | `[virtual, inherited]`

| Hides this element if it was visible.

virtual void Ogre::BorderPanelOverlayElement::initialise | ( | void |  | ) | `[virtual]`

| Initialise. Reimplemented from Ogre::PanelOverlayElement.

virtual bool Ogre::OverlayContainer::isChildrenProcessEvents | ( |  | ) | const`[virtual, inherited]`

| Should this container pass events to their children. Definition at line 124 of file OgreOverlayContainer.h.

virtual bool Ogre::OverlayElement::isCloneable | ( |  | ) | const`[virtual, inherited]`

| Definition at line 443 of file OgreOverlayElement.h.

bool Ogre::OverlayContainer::isContainer | ( |  | ) | const`[virtual, inherited]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayElement. Definition at line 120 of file OgreOverlayContainer.h.

bool Ogre::OverlayElement::isEnabled | ( |  | ) | const`[inherited]`

virtual bool Ogre::OverlayElement::isKeyEnabled | ( |  | ) | const`[virtual, inherited]`

| Definition at line 440 of file OgreOverlayElement.h.

bool Ogre::PanelOverlayElement::isTransparent | ( | void |  | ) | const`[inherited]`

| Returns whether this panel is transparent.

bool Ogre::OverlayElement::isVisible | ( | void |  | ) | const`[inherited]`

| Returns whether or not the element is visible.

virtual void Ogre::OverlayContainer::removeChild | ( | const String & | name | ) | `[virtual, inherited]`

| Removes a named element from this container.

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

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

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.

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.

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.

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.

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.

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.

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.

virtual void Ogre::OverlayContainer::setChildrenProcessEvents | ( | bool | val | ) | `[virtual, inherited]`

| Should this container pass events to their children. Definition at line 128 of file OgreOverlayContainer.h.

virtual void Ogre::OverlayElement::setCloneable | ( | bool | c | ) | `[virtual, inherited]`

| Definition at line 446 of file OgreOverlayElement.h.

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.

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 204 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 | ) | `[virtual, inherited]`

void Ogre::OverlayElement::setHeight | ( | Real | height | ) | `[inherited]`

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

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.

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

void Ogre::PanelOverlayElement::setMaterialName | ( | const String & | matName | ) | `[virtual, inherited]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayElement.

void Ogre::BorderPanelOverlayElement::setMetricsMode | ( | GuiMetricsMode | gmm | ) | `[virtual]`

| Overridden from OverlayElement. Reimplemented from Ogre::OverlayElement.

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)

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

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

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.

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)

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::BorderPanelOverlayElement::setTopBorderUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) |

| Sets the texture coordinates for the top edge of the border. Remarks: See setLeftBorderUV.

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.

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.

void Ogre::PanelOverlayElement::setTransparent | ( | bool | isTransparent | ) | `[inherited]`

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

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

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

void Ogre::PanelOverlayElement::setUV | ( | Real | u1,
|  | Real | v1,
|  | Real | u2,
|  | Real | v2
| ) | `[inherited]`

| Sets the texture coordinates for the panel.

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.

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 |  | ) | `[virtual, inherited]`

| Shows this element if it was hidden.

void Ogre::BorderPanelOverlayElement::updatePositionGeometry | ( | void |  | ) | `[protected, virtual]`

| internal method for setting up geometry, called by OverlayElement::update Reimplemented from Ogre::PanelOverlayElement.

void Ogre::BorderPanelOverlayElement::updateTextureGeometry | ( | void |  | ) | `[protected, virtual]`

| internal method for setting up geometry, called by OverlayElement::update Reimplemented from Ogre::PanelOverlayElement.

## Friends And Related Function Documentation

friend class BorderRenderable`[friend]`

| Definition at line 54 of file OgreBorderPanelOverlayElement.h.

## Member Data Documentation

String Ogre::BorderPanelOverlayElement::mBorderMaterialName`[protected]`

| Definition at line 265 of file OgreBorderPanelOverlayElement.h.

BorderRenderable* Ogre::BorderPanelOverlayElement::mBorderRenderable`[protected]`

| Definition at line 304 of file OgreBorderPanelOverlayElement.h.

CellUV Ogre::BorderPanelOverlayElement::mBorderUV[8]`[protected]`

| Definition at line 258 of file OgreBorderPanelOverlayElement.h.

Real Ogre::BorderPanelOverlayElement::mBottomBorderSize`[protected]`

| Definition at line 254 of file OgreBorderPanelOverlayElement.h.

DisplayString Ogre::OverlayElement::mCaption`[protected, inherited]`

| Definition at line 131 of file OgreOverlayElement.h.

ChildContainerMap Ogre::OverlayContainer::mChildContainers`[protected, inherited]`

| Definition at line 62 of file OgreOverlayContainer.h.

ChildMap Ogre::OverlayContainer::mChildren`[protected, inherited]`

| Definition at line 60 of file OgreOverlayContainer.h.

bool Ogre::OverlayContainer::mChildrenProcessEvents`[protected, inherited]`

| Definition at line 64 of file OgreOverlayContainer.h.

Rectangle Ogre::OverlayElement::mClippingRegion`[protected, inherited]`

| Definition at line 133 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mCloneable`[protected, inherited]`

| Definition at line 124 of file OgreOverlayElement.h.

ColourValue Ogre::OverlayElement::mColour`[protected, inherited]`

| Definition at line 132 of file OgreOverlayElement.h.

CustomParameterMap Ogre::Renderable::mCustomParameters`[protected, inherited]`

| Definition at line 286 of file OgreRenderable.h.

Real Ogre::OverlayElement::mDerivedLeft`[protected, inherited]`

| Definition at line 153 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mDerivedOutOfDate`[protected, inherited]`

| Definition at line 155 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mDerivedTop`[protected, inherited]`

| Definition at line 154 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mEnabled`[protected, inherited]`

| Definition at line 170 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mGeomPositionsOutOfDate`[protected, inherited]`

| Flag indicating if the vertex positons need recalculating. Definition at line 158 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mGeomUVsOutOfDate`[protected, inherited]`

| Flag indicating if the vertex uvs need recalculating. Definition at line 160 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mHeight`[protected, inherited]`

| Definition at line 128 of file OgreOverlayElement.h.

GuiHorizontalAlignment Ogre::OverlayElement::mHorzAlign`[protected, inherited]`

| Definition at line 136 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mInitialised`[protected, inherited]`

| Definition at line 173 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mLeft`[protected, inherited]`

| Definition at line 125 of file OgreOverlayElement.h.

Real Ogre::BorderPanelOverlayElement::mLeftBorderSize`[protected]`

| Definition at line 251 of file OgreBorderPanelOverlayElement.h.

String Ogre::OverlayElement::mMaterialName`[protected, inherited]`

| Definition at line 129 of file OgreOverlayElement.h.

GuiMetricsMode Ogre::OverlayElement::mMetricsMode`[protected, inherited]`

| Definition at line 135 of file OgreOverlayElement.h.

String Ogre::OverlayElement::mName`[protected, inherited]`

| Definition at line 122 of file OgreOverlayElement.h.

size_t Ogre::PanelOverlayElement::mNumTexCoordsInBuffer`[protected, inherited]`

| Definition at line 129 of file OgrePanelOverlayElement.h.

Overlay* Ogre::OverlayElement::mOverlay`[protected, inherited]`

| Definition at line 150 of file OgreOverlayElement.h.

String Ogre::StringInterface::mParamDictName`[protected, inherited]`

| Class name for this instance to be used as a lookup (must be initialised by subclasses). Definition at line 164 of file OgreStringInterface.h.

OverlayContainer* Ogre::OverlayElement::mParent`[protected, inherited]`

| Definition at line 148 of file OgreOverlayElement.h.

MaterialPtr Ogre::BorderPanelOverlayElement::mpBorderMaterial`[protected]`

| Definition at line 266 of file OgreBorderPanelOverlayElement.h.

ushort Ogre::BorderPanelOverlayElement::mPixelBottomBorderSize`[protected]`

| Definition at line 263 of file OgreBorderPanelOverlayElement.h.

Real Ogre::OverlayElement::mPixelHeight`[protected, inherited]`

| Definition at line 143 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mPixelLeft`[protected, inherited]`

| Definition at line 141 of file OgreOverlayElement.h.

ushort Ogre::BorderPanelOverlayElement::mPixelLeftBorderSize`[protected]`

| Definition at line 260 of file OgreBorderPanelOverlayElement.h.

ushort Ogre::BorderPanelOverlayElement::mPixelRightBorderSize`[protected]`

| Definition at line 261 of file OgreBorderPanelOverlayElement.h.

Real Ogre::OverlayElement::mPixelScaleX`[protected, inherited]`

| Definition at line 144 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mPixelScaleY`[protected, inherited]`

| Definition at line 145 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mPixelTop`[protected, inherited]`

| Definition at line 140 of file OgreOverlayElement.h.

ushort Ogre::BorderPanelOverlayElement::mPixelTopBorderSize`[protected]`

| Definition at line 262 of file OgreBorderPanelOverlayElement.h.

Real Ogre::OverlayElement::mPixelWidth`[protected, inherited]`

| Definition at line 142 of file OgreOverlayElement.h.

MaterialPtr Ogre::OverlayElement::mpMaterial`[protected, inherited]`

| Definition at line 130 of file OgreOverlayElement.h.

bool Ogre::Renderable::mPolygonModeOverrideable`[protected, inherited]`

| Definition at line 287 of file OgreRenderable.h.

RenderOperation Ogre::PanelOverlayElement::mRenderOp`[protected, inherited]`

| Definition at line 132 of file OgrePanelOverlayElement.h.

RenderOperation Ogre::BorderPanelOverlayElement::mRenderOp2`[protected]`

| Definition at line 269 of file OgreBorderPanelOverlayElement.h.

Real Ogre::BorderPanelOverlayElement::mRightBorderSize`[protected]`

| Definition at line 252 of file OgreBorderPanelOverlayElement.h.

OverlayElementCommands::CmdCaption Ogre::OverlayElement::msCaptionCmd`[static, protected, inherited]`

| Definition at line 115 of file OgreOverlayElement.h.

CmdBorderBottomLeftUV Ogre::BorderPanelOverlayElement::msCmdBorderBottomLeftUV`[static, protected]`

| Definition at line 300 of file OgreBorderPanelOverlayElement.h.

CmdBorderBottomRightUV Ogre::BorderPanelOverlayElement::msCmdBorderBottomRightUV`[static, protected]`

| Definition at line 302 of file OgreBorderPanelOverlayElement.h.

CmdBorderBottomUV Ogre::BorderPanelOverlayElement::msCmdBorderBottomUV`[static, protected]`

| Definition at line 297 of file OgreBorderPanelOverlayElement.h.

CmdBorderLeftUV Ogre::BorderPanelOverlayElement::msCmdBorderLeftUV`[static, protected]`

| Definition at line 295 of file OgreBorderPanelOverlayElement.h.

CmdBorderMaterial Ogre::BorderPanelOverlayElement::msCmdBorderMaterial`[static, protected]`

| Definition at line 294 of file OgreBorderPanelOverlayElement.h.

CmdBorderRightUV Ogre::BorderPanelOverlayElement::msCmdBorderRightUV`[static, protected]`

| Definition at line 298 of file OgreBorderPanelOverlayElement.h.

CmdBorderSize Ogre::BorderPanelOverlayElement::msCmdBorderSize`[static, protected]`

| Definition at line 293 of file OgreBorderPanelOverlayElement.h.

CmdBorderTopLeftUV Ogre::BorderPanelOverlayElement::msCmdBorderTopLeftUV`[static, protected]`

| Definition at line 299 of file OgreBorderPanelOverlayElement.h.

CmdBorderTopRightUV Ogre::BorderPanelOverlayElement::msCmdBorderTopRightUV`[static, protected]`

| Definition at line 301 of file OgreBorderPanelOverlayElement.h.

CmdBorderTopUV Ogre::BorderPanelOverlayElement::msCmdBorderTopUV`[static, protected]`

| Definition at line 296 of file OgreBorderPanelOverlayElement.h.

CmdTiling Ogre::PanelOverlayElement::msCmdTiling`[static, protected, inherited]`

| Definition at line 146 of file OgrePanelOverlayElement.h.

CmdTransparent Ogre::PanelOverlayElement::msCmdTransparent`[static, protected, inherited]`

| Definition at line 147 of file OgrePanelOverlayElement.h.

CmdUVCoords Ogre::PanelOverlayElement::msCmdUVCoords`[static, protected, inherited]`

| Definition at line 148 of file OgrePanelOverlayElement.h.

ParamDictionaryMap Ogre::StringInterface::msDictionary`[static, protected, inherited]`

| Dictionary of parameters. Definition at line 161 of file OgreStringInterface.h.

const PlaneList Ogre::Renderable::msDummyPlaneList`[static, protected, inherited]`

| Definition at line 284 of file OgreRenderable.h.

OverlayElementCommands::CmdHeight Ogre::OverlayElement::msHeightCmd`[static, protected, inherited]`

| Definition at line 113 of file OgreOverlayElement.h.

OverlayElementCommands::CmdHorizontalAlign Ogre::OverlayElement::msHorizontalAlignCmd`[static, protected, inherited]`

| Definition at line 117 of file OgreOverlayElement.h.

OverlayElementCommands::CmdLeft Ogre::OverlayElement::msLeftCmd`[static, protected, inherited]`

| Definition at line 110 of file OgreOverlayElement.h.

OverlayElementCommands::CmdMaterial Ogre::OverlayElement::msMaterialCmd`[static, protected, inherited]`

| Definition at line 114 of file OgreOverlayElement.h.

OverlayElementCommands::CmdMetricsMode Ogre::OverlayElement::msMetricsModeCmd`[static, protected, inherited]`

| Definition at line 116 of file OgreOverlayElement.h.

OverlayElement* Ogre::OverlayElement::mSourceTemplate`[protected, inherited]`

| Definition at line 176 of file OgreOverlayElement.h.

OverlayElementCommands::CmdTop Ogre::OverlayElement::msTopCmd`[static, protected, inherited]`

| Definition at line 111 of file OgreOverlayElement.h.

String Ogre::BorderPanelOverlayElement::msTypeName`[static, protected]`

| Reimplemented from Ogre::PanelOverlayElement. Definition at line 271 of file OgreBorderPanelOverlayElement.h.

OverlayElementCommands::CmdVerticalAlign Ogre::OverlayElement::msVerticalAlignCmd`[static, protected, inherited]`

| Definition at line 118 of file OgreOverlayElement.h.

OverlayElementCommands::CmdVisible Ogre::OverlayElement::msVisibleCmd`[static, protected, inherited]`

| Definition at line 119 of file OgreOverlayElement.h.

OverlayElementCommands::CmdWidth Ogre::OverlayElement::msWidthCmd`[static, protected, inherited]`

| Definition at line 112 of file OgreOverlayElement.h.

Real Ogre::PanelOverlayElement::mTileX[OGRE_MAX_TEXTURE_LAYERS]`[protected, inherited]`

| Definition at line 127 of file OgrePanelOverlayElement.h.

Real Ogre::PanelOverlayElement::mTileY[OGRE_MAX_TEXTURE_LAYERS]`[protected, inherited]`

| Definition at line 128 of file OgrePanelOverlayElement.h.

Real Ogre::OverlayElement::mTop`[protected, inherited]`

| Definition at line 126 of file OgreOverlayElement.h.

Real Ogre::BorderPanelOverlayElement::mTopBorderSize`[protected]`

| Definition at line 253 of file OgreBorderPanelOverlayElement.h.

bool Ogre::PanelOverlayElement::mTransparent`[protected, inherited]`

| Definition at line 125 of file OgrePanelOverlayElement.h.

Real Ogre::PanelOverlayElement::mU1`[protected, inherited]`

| Definition at line 130 of file OgrePanelOverlayElement.h.

Real Ogre::PanelOverlayElement::mU2`[protected, inherited]`

| Definition at line 130 of file OgrePanelOverlayElement.h.

bool Ogre::Renderable::mUseIdentityProjection`[protected, inherited]`

| Definition at line 288 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView`[protected, inherited]`

| Definition at line 289 of file OgreRenderable.h.

Real Ogre::PanelOverlayElement::mV1`[protected, inherited]`

| Definition at line 130 of file OgrePanelOverlayElement.h.

Real Ogre::PanelOverlayElement::mV2`[protected, inherited]`

| Definition at line 130 of file OgrePanelOverlayElement.h.

GuiVerticalAlignment Ogre::OverlayElement::mVertAlign`[protected, inherited]`

| Definition at line 137 of file OgreOverlayElement.h.

bool Ogre::OverlayElement::mVisible`[protected, inherited]`

| Definition at line 123 of file OgreOverlayElement.h.

Real Ogre::OverlayElement::mWidth`[protected, inherited]`

| Definition at line 127 of file OgreOverlayElement.h.

Matrix4 Ogre::OverlayElement::mXForm`[protected, inherited]`

| Definition at line 167 of file OgreOverlayElement.h.

ushort Ogre::OverlayElement::mZOrder`[protected, inherited]`

| Definition at line 164 of file OgreOverlayElement.h.

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

- OgreBorderPanelOverlayElement.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 30 10:51:06 2007