Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

# Ogre::CursorGuiElement Class Reference

GuiElement representing a visual cursor. More...

`#include <OgreCursorGuiElement.h>`

Inheritance diagram for Ogre::CursorGuiElement:

[legend]
List of all members.

## Public Types

typedef std::map< String, GuiElement * > | ChildMap
typedef MapIterator< ChildMap > | ChildIterator
typedef std::map< String, GuiContainer * > | ChildContainerMap
typedef MapIterator< ChildContainerMap > | ChildContainerIterator

## Public Methods

| CursorGuiElement (const String &name)
const String & | getTypeName (void) const
| See GuiElement.
void | show (void)
| Inherited from PanelGuiElement, should only be called from the OverlayManager.
void | hide (void)
| Hides this element if it was visible.
void | setOffsetX (Real x)
| Used to set the cursor's hot spot X coordinate.
void | setOffsetY (Real y)
| Used to set the cursor's hot spot Y coordinate.
Real | getOffsetX (void) const
| Used to get the cursor's hot spot X coordinate.
Real | getOffsetY (void) const
| Used to get the cursor's hot spot Y coordinate.
void | mouseMoved (MouseEvent *e)
| Used to update the location of the cursor on screen, should only be called from the OverlayManager.
void | mouseDragged (MouseEvent *e)
| Used to update the location of the cursor on screen, should only be called from the OverlayManager.
float | getViewDepth (Camera *) const
GuiElement * | findElementAt (Real x, Real y)
| This returns a GuiElement at position x,y.
virtual void | initialise (void)
| Initialise.
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 | 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 GuiElement.
void | _updateRenderQueue (RenderQueue *queue)
| Overridden from GuiContainer.
virtual void | addChild (GuiElement *elem)
| Adds another GuiElement to this container.
virtual void | addChildImpl (GuiElement *elem)
| Adds another GuiElement to this container.
virtual void | addChildImpl (GuiContainer *cont)
| Add a nested container to this container.
virtual void | removeChild (const String &name)
| Removes a named element from this container.
virtual GuiElement * | getChild (const String &name)
| Gets the named child of this container.
void | _addChild (GuiElement *elem)
void | _removeChild (GuiElement *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 | _update (void)
| Overridden from GuiElement.
virtual void | _notifyZOrder (ushort newZOrder)
| Overridden from GuiElement.
virtual void | _notifyViewport ()
| Overridden from GuiElement.
virtual void | _notifyWorldTransforms (const Matrix4 &xform)
| Overridden from GuiElement.
virtual void | _notifyParent (GuiContainer *parent, Overlay *overlay)
| Overridden from GuiElement.
bool | isContainer () const
| Overridden from GuiElement.
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.
void | copyFromTemplate (GuiElement *templateGui)
virtual GuiElement * | clone (const String &instanceName)
const String & | getName (void) const
| Gets the name of this overlay.
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.
Material * | getMaterial (void) const
| See Renderable.
void | getWorldTransforms (Matrix4 *xform) const
| See Renderable.
const Quaternion & | getWorldOrientation (void) const
| @copydoc Renderable::getWorldOrientation
const Vector3 & | getWorldPosition (void) const
| @copydoc Renderable::getWorldPosition
bool | useIdentityProjection (void) const
| See Renderable.
bool | useIdentityView (void) const
| See Renderable.
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 void | _getClippingRegion (Rectangle &clippingRegion)
| Gets the clipping region of the element.
virtual void | setCaption (const String &text)
| Sets the caption on elements that support it.
virtual const String & | 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 void | setMetricsMode (GuiMetricsMode gmm)
| Tells this element how to interpret the position and dimension values it is given.
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 void | processEvent (InputEvent *e)
| Processes events occurring on this component.
virtual bool | isKeyEnabled () const
virtual bool | isCloneable () const
virtual void | setCloneable (bool c)
PositionTarget * | getPositionTargetParent () const
| Returns the parent container.
GuiContainer * | getParent ()
| Returns the parent container.
void | _setParent (GuiContainer *parent)
ushort | getZOrder () const
| Returns the zOrder of the element.
Real | getSquaredViewDepth (const Camera *cam) const
| Overridden from Renderable.
const LightList & | getLights (void) const
| @copydoc Renderable::getLights
const GuiElement * | 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 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.
virtual SceneDetailLevel | getRenderDetail () const
| Returns the preferred rasterisation mode of this renderable.
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.
void | processMouseEvent (MouseEvent *e)
void | addMouseListener (MouseListener *l)
void | removeMouseListener (MouseListener *l)
bool | isMouseWithin () const
void | processMouseMotionEvent (MouseEvent *e)
void | addMouseMotionListener (MouseMotionListener *l)
void | removeMouseMotionListener (MouseMotionListener *l)
void | processActionEvent (ActionEvent *e)
void | addActionListener (ActionListener *l)
void | removeActionListener (ActionListener *l)
virtual void | mouseDragMoved (MouseEvent *e)
| sent to target
virtual bool | isMulticaster () const
| Returns whether or not the listener is a multicaster.

## Static Public Methods

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

typedef std::map< size_t, Vector4 > | CustomParameterMap

## Protected Methods

void | addBaseParameters ()
| Method for setting up base parameters for this class.
virtual void | updatePositionGeometry (void)
| internal method for setting up geometry, called by GuiElement::update
virtual void | updateTextureGeometry (void)
| Called to update the texture coords when layers change.
bool | createParamDictionary (const String &className)
| Internal method for creating a parameter dictionary for the class, if it does not already exist.

## Protected Attributes

Real | mOffsetX
| The current X coordinate of the cursor's hot spot.
Real | mOffsetY
| The current Y coordinate of the cursor's hot spot.
bool | mTransparent
Real | mTileX [OGRE_MAX_TEXTURE_LAYERS]
Real | mTileY [OGRE_MAX_TEXTURE_LAYERS]
size_t | mNumTexCoordsInBuffer
RenderOperation | mRenderOp
ChildMap | mChildren
ChildContainerMap | mChildContainers
bool | mChildrenProcessEvents
String | mName
bool | mVisible
bool | mCloneable
Real | mLeft
Real | mTop
Real | mWidth
Real | mHeight
String | mMaterialName
Material * | mpMaterial
String | mCaption
ColourValue | mColour
Rectangle | mClippingRegion
GuiMetricsMode | mMetricsMode
GuiHorizontalAlignment | mHorzAlign
GuiVerticalAlignment | mVertAlign
Real | mPixelTop
Real | mPixelLeft
Real | mPixelWidth
Real | mPixelHeight
Real | mPixelScaleX
Real | mPixelScaleY
GuiContainer * | mParent
Overlay * | mOverlay
Real | mDerivedLeft
Real | mDerivedTop
bool | mDerivedOutOfDate
bool | mGeomPositionsOutOfDate
| Falg indicating if the vertex positons need recalculating.
ushort | mZOrder
Matrix4 | mXForm
bool | mEnabled
GuiElement * | mSourceTemplate
String | mParamDictName
| Class name for this instance to be used as a lookup (must be initialised by subclasses).
CustomParameterMap | mCustomParameters
MouseListener * | mMouseListener
bool | mMouseWithin
MouseMotionListener * | mMouseMotionListener
ActionListener * | mActionListener

## Static Protected Attributes

String | msTypeName = "Cursor"
CmdOffsetX | msCmdOffsetX
CmdOffsetY | msCmdOffsetY
CmdTiling | msCmdTiling
CmdTransparent | msCmdTransparent
GuiElementCommands::CmdLeft | msLeftCmd
GuiElementCommands::CmdTop | msTopCmd
GuiElementCommands::CmdWidth | msWidthCmd
GuiElementCommands::CmdHeight | msHeightCmd
GuiElementCommands::CmdMaterial | msMaterialCmd
GuiElementCommands::CmdCaption | msCaptionCmd
GuiElementCommands::CmdMetricsMode | msMetricsModeCmd
GuiElementCommands::CmdHorizontalAlign | msHorizontalAlignCmd
GuiElementCommands::CmdVerticalAlign | msVerticalAlignCmd
GuiElementCommands::CmdVisible | msVisibleCmd
ParamDictionaryMap | msDictionary
| Dictionary of parameters.
const PlaneList | msDummyPlaneList

## Detailed Description

GuiElement representing a visual cursor.

Remarks:
  The CursorGuiElement may be used to create visible cursors for use with the OverlayManager's cursor facility.

  The CursorGuiElements class is sub-classed from the the PanelGuiElement class. The element size, material and other attributes may be specified to define the appearance of the cursor.

  In addition, the CursorGuiElement class provide a mechanism for specifing the cursor's hot spot in relation to the PanelGuiClass's visual area. This is specified by setting the x_offset and y_offset attributes of the cursor.

  To use a cursor, it must first be created (typically from an overlay script) and then be passed as both parameters to the overlayManager's setCursorGui method. The OverlayManager will activate the cursor by calling it's show method. In response, the cursor will position itself with the hot spot over the current mouse coordinates. All further mouse cursor events from the OverlayManager will then be sent to the new cursor, causing it to track with the mouse.

  Any previous cursor maintained by the OverlayManager is deactivated (by calling it's hide method) and subsequently discarded. If the previous cursor is to be retained for further use, then the OverlayManager's getCursorGui method should be called to retrieve it prior to calling setCursorGui.

  Unlike most other Gui elements, cursor's are created with the mVisible attribute initially set to false.

See also:
  OverlayManager::getCursorGui. , OverlayManager::setCursorGui.

Definition at line 68 of file OgreCursorGuiElement.h.

## Member Typedef Documentation

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

| Definition at line 53 of file OgreGuiContainer.h. Referenced by Ogre::GuiContainer::getChildContainerIterator().

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

| Definition at line 52 of file OgreGuiContainer.h.

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

Definition at line 51 of file OgreGuiContainer.h.

Referenced by Ogre::GuiContainer::_notifyParent(), Ogre::GuiContainer::_notifyViewport(), Ogre::GuiContainer::_notifyWorldTransforms(), Ogre::GuiContainer::_notifyZOrder(), Ogre::GuiContainer::_positionsOutOfDate(), Ogre::GuiContainer::_update(), Ogre::PanelGuiElement::_updateRenderQueue(), Ogre::GuiContainer::_updateRenderQueue(), Ogre::GuiContainer::clone(), Ogre::GuiContainer::getChildIterator(), Ogre::PopupMenuGuiElement::layoutItems(), Ogre::ListGuiElement::layoutItems(), Ogre::ListGuiElement::setSelectedIndex(), Ogre::ButtonGuiElement::updateMaterials(), and Ogre::BorderButtonGuiElement::updateMaterials().

typedef std::map<String, GuiElement*> Ogre::GuiContainer::ChildMap`[inherited]`

| Definition at line 50 of file OgreGuiContainer.h.

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

| Definition at line 232 of file OgreRenderable.h.

## Constructor & Destructor Documentation

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

| Definition at line 41 of file OgreCursorGuiElement.cpp. References addBaseParameters(), Ogre::StringInterface::createParamDictionary(), Ogre::GuiElement::mVisible, Ogre::GuiElement::setHeight(), Ogre::GuiElement::setWidth(), and Ogre::String.

## Member Function Documentation

void Ogre::GuiContainer::_addChild | ( | GuiElement * | elem | ) | `[inherited]`

| Definition at line 133 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::addChildImpl(), and Ogre::GuiElement::isContainer(). Referenced by Ogre::GuiContainer::clone().

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

| Gets the clipping region of the element. Definition at line 521 of file OgreGuiElement.cpp. References Ogre::GuiElement::_updateFromParent(), and Ogre::GuiElement::mClippingRegion. Referenced by Ogre::GuiElement::_updateFromParent().

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

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

Definition at line 503 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::mDerivedLeft, and Ogre::Real.

Referenced by Ogre::GuiElement::_updateFromParent(), Ogre::TextAreaGuiElement::updateGeometry(), Ogre::PanelGuiElement::updatePositionGeometry(), Ogre::BorderPanelGuiElement::updatePositionGeometry(), and Ogre::TTYGuiElement::updateWindowGeometry().

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

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

Definition at line 512 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::mDerivedTop, and Ogre::Real.

Referenced by Ogre::GuiElement::_updateFromParent(), Ogre::ListGuiElement::mouseDragged(), Ogre::TextAreaGuiElement::updateGeometry(), Ogre::PanelGuiElement::updatePositionGeometry(), Ogre::BorderPanelGuiElement::updatePositionGeometry(), and Ogre::TTYGuiElement::updateWindowGeometry().

Real Ogre::GuiElement::_getHeight | ( | void |  | ) | const`[inherited]`

| Gets the height of this element in relation to the screen (where 1.0 = screen height). Definition at line 240 of file OgreGuiElement.h. References Ogre::Real.

Real Ogre::GuiElement::_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 234 of file OgreGuiElement.h. References Ogre::Real.

Real Ogre::GuiElement::_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 236 of file OgreGuiElement.h. References Ogre::Real.

Real Ogre::GuiElement::_getWidth | ( | void |  | ) | const`[inherited]`

| Gets the width of this element in relation to the screen (where 1.0 = screen width). Definition at line 238 of file OgreGuiElement.h. References Ogre::Real.

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

| Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 252 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::ChildIterator, and Ogre::GuiContainer::getChildIterator(). Referenced by Ogre::Overlay::add2D().

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

| Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 240 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::ChildIterator, and Ogre::GuiContainer::getChildIterator(). Referenced by Ogre::Overlay::add2D().

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

| Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 228 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::ChildIterator, and Ogre::GuiContainer::getChildIterator(). Referenced by Ogre::Overlay::add2D().

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

| Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 215 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::ChildIterator, Ogre::GuiContainer::getChildIterator(), and Ogre::ushort. Referenced by Ogre::Overlay::add2D().

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

| Tell the object and its children to recalculate. Reimplemented from Ogre::GuiElement. Definition at line 188 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::ChildIterator, and Ogre::GuiContainer::getChildIterator().

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

| Definition at line 145 of file OgreGuiContainer.cpp. References Ogre::GuiElement::_setParent(), Except, Ogre::GuiContainer::mChildContainers, Ogre::GuiContainer::mChildren, and Ogre::String.

void Ogre::GuiContainer::_removeChild | ( | GuiElement * | elem | ) | `[inherited]`

| Definition at line 79 of file OgreGuiContainer.h. References Ogre::GuiElement::getName(). Referenced by Ogre::GuiManager::destroyAllGuiElementsImpl().

void Ogre::GuiElement::_setDimensions | ( | Real | width,
|  | Real | height
| ) | `[inherited]`

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

Definition at line 295 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mHeight, Ogre::GuiElement::mPixelHeight, Ogre::GuiElement::mPixelScaleX, Ogre::GuiElement::mPixelScaleY, Ogre::GuiElement::mPixelWidth, Ogre::GuiElement::mWidth, and Ogre::Real.

void Ogre::GuiElement::_setHeight | ( | Real | height | ) | `[inherited]`

| Sets the height of this element in relation to the screen (where 1.0 = screen width). Definition at line 275 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mHeight, Ogre::GuiElement::mPixelHeight, Ogre::GuiElement::mPixelScaleY, and Ogre::Real.

void Ogre::GuiElement::_setLeft | ( | Real | left | ) | `[inherited]`

| Sets the left of this element in relation to the screen (where 1.0 = screen width). Definition at line 248 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mLeft, Ogre::GuiElement::mPixelLeft, Ogre::GuiElement::mPixelScaleX, and Ogre::Real.

void Ogre::GuiElement::_setParent | ( | GuiContainer * | parent | ) | `[inherited]`

| Definition at line 448 of file OgreGuiElement.h. Referenced by Ogre::GuiContainer::_removeChild(), Ogre::GuiContainer::removeChild(), and Ogre::GuiContainer::~GuiContainer().

void Ogre::GuiElement::_setPosition | ( | Real | left,
|  | Real | top
| ) | `[inherited]`

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

Definition at line 284 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mLeft, Ogre::GuiElement::mPixelLeft, Ogre::GuiElement::mPixelScaleX, Ogre::GuiElement::mPixelScaleY, Ogre::GuiElement::mPixelTop, Ogre::GuiElement::mTop, and Ogre::Real.

void Ogre::GuiElement::_setTop | ( | Real | top | ) | `[inherited]`

| Sets the top of this element in relation to the screen (where 1.0 = screen width). Definition at line 257 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mPixelScaleY, Ogre::GuiElement::mPixelTop, Ogre::GuiElement::mTop, and Ogre::Real.

void Ogre::GuiElement::_setWidth | ( | Real | width | ) | `[inherited]`

| Sets the width of this element in relation to the screen (where 1.0 = screen width). Definition at line 266 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mPixelScaleX, Ogre::GuiElement::mPixelWidth, Ogre::GuiElement::mWidth, and Ogre::Real.

void Ogre::GuiContainer::_update | ( | void |  | ) | `[virtual, inherited]`

| Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Reimplemented in Ogre::BorderPanelGuiElement. Definition at line 200 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::ChildIterator, and Ogre::GuiContainer::getChildIterator(). Referenced by Ogre::PopupMenuGuiElement::layoutItems().

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

Definition at line 218 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::index, params, and Ogre::GpuProgramParameters::setConstant().

Referenced by Ogre::GpuProgramParameters::_updateAutoParamsNoLights().

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

Updates this elements transform based on it's parent.

Definition at line 418 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_getClippingRegion(), Ogre::GuiElement::_getDerivedLeft(), Ogre::GuiElement::_getDerivedTop(), Ogre::Rectangle::bottom, Ogre::GuiElement::getHeight(), Ogre::GuiElement::getWidth(), Ogre::GHA_CENTER, Ogre::GHA_LEFT, Ogre::GHA_RIGHT, Ogre::GVA_BOTTOM, Ogre::GVA_CENTER, Ogre::GVA_TOP, Ogre::intersect(), Ogre::Rectangle::left, Ogre::GuiElement::mClippingRegion, Ogre::GuiElement::mDerivedLeft, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mDerivedTop, Ogre::GuiElement::mHeight, Ogre::GuiElement::mHorzAlign, Ogre::GuiElement::mLeft, Ogre::GuiElement::mParent, Ogre::GuiElement::mTop, Ogre::GuiElement::mVertAlign, Ogre::GuiElement::mWidth, Ogre::Real, Ogre::Rectangle::right, and Ogre::Rectangle::top.

Referenced by Ogre::GuiElement::_getClippingRegion(), Ogre::GuiElement::_getDerivedLeft(), Ogre::GuiElement::_getDerivedTop(), and Ogre::GuiElement::_update().

void Ogre::PanelGuiElement::_updateRenderQueue | ( | RenderQueue * | queue | ) | `[virtual, inherited]`

| Overridden from GuiContainer. Reimplemented from Ogre::GuiContainer. Reimplemented in Ogre::BorderPanelGuiElement. Definition at line 148 of file OgrePanelGuiElement.cpp. References Ogre::GuiContainer::ChildIterator, Ogre::GuiContainer::getChildIterator(), Ogre::GuiElement::mpMaterial, and Ogre::PanelGuiElement::mTransparent.

void Ogre::ActionTarget::addActionListener | ( | ActionListener * | l | ) | `[inherited]`

| Definition at line 62 of file OgreActionTarget.cpp. References Ogre::ActionTarget::mActionListener. Referenced by Ogre::ScrollBarGuiElement::setDownButtonName(), and Ogre::ScrollBarGuiElement::setUpButtonName().

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

| Method for setting up base parameters for this class. Reimplemented from Ogre::PanelGuiElement. Definition at line 108 of file OgreCursorGuiElement.cpp. References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::getParamDictionary(), msCmdOffsetX, msCmdOffsetY, and Ogre::PT_STRING. Referenced by CursorGuiElement().

void Ogre::GuiContainer::addChild | ( | GuiElement * | elem | ) | `[virtual, inherited]`

Adds another GuiElement to this container.

Definition at line 52 of file OgreGuiContainer.cpp.

References Ogre::GuiContainer::addChildImpl(), and Ogre::GuiElement::isContainer().

Referenced by Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::GuiContainer::copyFromTemplate(), Ogre::Profiler::initialize(), Ogre::OverlayManager::parseNewElement(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::ButtonGuiElement::setButtonCaption(), Ogre::BorderButtonGuiElement::setButtonCaption(), Ogre::ScrollBarGuiElement::setDownButtonName(), Ogre::ListGuiElement::setScrollBarName(), Ogre::ScrollBarGuiElement::setScrollBitName(), Ogre::TextBoxGuiElement::setTextArea(), and Ogre::ScrollBarGuiElement::setUpButtonName().

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

| Add a nested container to this container. Definition at line 84 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::addChildImpl(), Ogre::GuiElement::getName(), and Ogre::GuiContainer::mChildContainers.

void Ogre::GuiContainer::addChildImpl | ( | GuiElement * | elem | ) | `[virtual, inherited]`

Adds another GuiElement to this container.

Definition at line 65 of file OgreGuiContainer.cpp.

References Ogre::GuiElement::_notifyParent(), Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_notifyWorldTransforms(), Ogre::GuiElement::_notifyZOrder(), Except, Ogre::GuiElement::getName(), Ogre::GuiContainer::mChildren, Ogre::GuiElement::mOverlay, Ogre::GuiElement::mXForm, Ogre::GuiElement::mZOrder, and Ogre::String.

Referenced by Ogre::GuiContainer::_addChild(), Ogre::GuiContainer::addChild(), and Ogre::GuiContainer::addChildImpl().

void Ogre::MouseTarget::addMouseListener | ( | MouseListener * | l | ) | `[inherited]`

| Definition at line 87 of file OgreMouseTarget.cpp. References Ogre::MouseTarget::mMouseListener. Referenced by Ogre::ListGuiElement::addListItem(), Ogre::ScrollBarGuiElement::setScrollBitName(), and Ogre::GuiPressable::setSource().

void Ogre::MouseMotionTarget::addMouseMotionListener | ( | MouseMotionListener * | l | ) | `[inherited]`

| Definition at line 66 of file OgreMouseMotionTarget.cpp. References Ogre::MouseMotionTarget::mMouseMotionListener. Referenced by Ogre::InputReader::addCursorMoveListener(), Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::PopupMenuGuiElement(), and Ogre::ScrollBarGuiElement::setScrollBitName().

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. Definition at line 53 of file OgreStringInterface.cpp. References Ogre::StringInterface::msDictionary.

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

| Reimplemented from Ogre::GuiElement. Definition at line 341 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::_addChild(), Ogre::GuiContainer::ChildIterator, Ogre::GuiElement::clone(), Ogre::GuiContainer::getChildIterator(), Ogre::GuiElement::isCloneable(), and Ogre::String.

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

| Returns true if xy is within the constraints of the component. Definition at line 759 of file OgreGuiElement.cpp. References Ogre::Rectangle::inside(), Ogre::GuiElement::mClippingRegion, and Ogre::Real.

void Ogre::GuiContainer::copyFromTemplate | ( | GuiElement * | templateGui | ) | `[inherited]`

| Reimplemented from Ogre::GuiElement. Definition at line 320 of file OgreGuiContainer.cpp. References Ogre::GuiContainer::addChild(), Ogre::StringInterface::copyParametersTo(), Ogre::GuiElement::getName(), Ogre::GuiElement::getTypeName(), Ogre::GuiElement::isCloneable(), Ogre::GuiContainer::isContainer(), Ogre::GuiElement::isContainer(), and Ogre::GuiElement::mName.

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

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

Referenced by Ogre::GuiElement::clone(), Ogre::GuiElement::copyFromTemplate(), Ogre::GuiContainer::copyFromTemplate(), and Ogre::ParticleSystem::operator=().

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

References Ogre::String.

Referenced by Ogre::ExternalTextureSource::addBaseParams(), Ogre::BorderButtonGuiElement::BorderButtonGuiElement(), Ogre::BorderPanelGuiElement::BorderPanelGuiElement(), Ogre::ButtonGuiElement::ButtonGuiElement(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), CursorGuiElement(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::GLSLProgram::GLSLProgram(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::ListGuiElement::ListGuiElement(), Ogre::PanelGuiElement::PanelGuiElement(), Ogre::PointEmitter::PointEmitter(), Ogre::PopupMenuGuiElement::PopupMenuGuiElement(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), Ogre::ScrollBarGuiElement::ScrollBarGuiElement(), Ogre::TextAreaGuiElement::TextAreaGuiElement(), Ogre::TextBoxGuiElement::TextBoxGuiElement(), and Ogre::TTYGuiElement::TTYGuiElement().

GuiElement * Ogre::CursorGuiElement::findElementAt | ( | Real | x,
|  | Real | y
| ) | `[virtual]`

| This returns a GuiElement at position x,y. Reimplemented from Ogre::GuiContainer. Definition at line 92 of file OgreCursorGuiElement.cpp. References Ogre::Real.

const String & Ogre::GuiElement::getCaption | ( | void |  | ) | const`[virtual, inherited]`

Gets the caption for this element.

Reimplemented in Ogre::TextAreaGuiElement, Ogre::TextBoxGuiElement, and Ogre::TTYGuiElement.

Definition at line 650 of file OgreGuiElement.cpp.

References Ogre::GuiElement::mCaption, and Ogre::String.

Referenced by Ogre::ButtonGuiElement::getButtonCaption(), Ogre::BorderButtonGuiElement::getButtonCaption(), Ogre::ListGuiElement::getSelectedIndex(), Ogre::ListGuiElement::getSelectedItem(), and Ogre::PopupMenuGuiElement::mouseReleased().

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

Definition at line 153 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::validateRenderableForRendering().

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

| Gets the named child of this container. Definition at line 165 of file OgreGuiContainer.cpp. References Except, Ogre::GuiContainer::mChildren, and Ogre::String. Referenced by Ogre::ListGuiElement::removeListItem(), Ogre::PopupMenuGuiElement::removeMenuItem(), and Ogre::ListGuiElement::setSelectedItem().

GuiContainer::ChildContainerIterator Ogre::GuiContainer::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

Definition at line 182 of file OgreGuiContainer.cpp.

References Ogre::GuiContainer::ChildContainerIterator, and Ogre::GuiContainer::mChildContainers.

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

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

Definition at line 177 of file OgreGuiContainer.cpp.

References Ogre::GuiContainer::ChildIterator, and Ogre::GuiContainer::mChildren.

Referenced by Ogre::GuiContainer::_notifyParent(), Ogre::GuiContainer::_notifyViewport(), Ogre::GuiContainer::_notifyWorldTransforms(), Ogre::GuiContainer::_notifyZOrder(), Ogre::GuiContainer::_positionsOutOfDate(), Ogre::GuiContainer::_update(), Ogre::PanelGuiElement::_updateRenderQueue(), Ogre::GuiContainer::_updateRenderQueue(), Ogre::GuiContainer::clone(), Ogre::PopupMenuGuiElement::layoutItems(), Ogre::ListGuiElement::layoutItems(), Ogre::ListGuiElement::mouseDragged(), Ogre::ListGuiElement::mousePressed(), Ogre::ListGuiElement::setSelectedIndex(), Ogre::ButtonGuiElement::updateMaterials(), Ogre::BorderButtonGuiElement::updateMaterials(), and Ogre::GuiContainer::~GuiContainer().

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

| Definition at line 145 of file OgreRenderable.h. References Ogre::PlaneList. Referenced by Ogre::SceneManager::renderSingleObject().

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

| Gets the colour for this element. Reimplemented in Ogre::TextAreaGuiElement, and Ogre::TTYGuiElement. Definition at line 660 of file OgreGuiElement.cpp. References Ogre::GuiElement::mColour.

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

References Except.

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

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

Definition at line 183 of file OgreGuiElement.cpp.

References Ogre::GMM_RELATIVE, Ogre::GuiElement::mHeight, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelHeight, and Ogre::Real.

Referenced by Ogre::GuiElement::_updateFromParent(), Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::ButtonGuiElement::changeChild(), Ogre::BorderButtonGuiElement::changeChild(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::PopupMenuGuiElement::layoutItems(), Ogre::ListGuiElement::layoutItems(), Ogre::ListGuiElement::mouseDragged(), Ogre::ScrollBarGuiElement::moveScrollBitTo(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::ListGuiElement::setScrollBarName(), and Ogre::ScrollBarGuiElement::updateScrollBit().

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

| Gets the horizontal alignment for this element. Definition at line 740 of file OgreGuiElement.cpp. References Ogre::GuiHorizontalAlignment, and Ogre::GuiElement::mHorzAlign.

Real Ogre::GuiElement::getLeft | ( | void |  | ) | const`[virtual, inherited]`

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

Implements Ogre::PositionTarget.

Definition at line 209 of file OgreGuiElement.cpp.

References Ogre::GMM_RELATIVE, Ogre::GuiElement::mLeft, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelLeft, and Ogre::Real.

Referenced by Ogre::ButtonGuiElement::changeChild(), and Ogre::BorderButtonGuiElement::changeChild().

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

| @copydoc Renderable::getLights Implements Ogre::Renderable. Definition at line 463 of file OgreGuiElement.h. References Ogre::LightList.

Material * Ogre::GuiElement::getMaterial | ( | void |  | ) | const`[virtual, inherited]`

| See Renderable. Implements Ogre::Renderable. Definition at line 326 of file OgreGuiElement.cpp. References Ogre::GuiElement::mpMaterial.

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

| Gets the name of the material this element uses. Definition at line 306 of file OgreGuiElement.cpp. References Ogre::GuiElement::mMaterialName, and Ogre::String.

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

| Retrieves the current settings of how the element metrics are interpreted. Definition at line 729 of file OgreGuiElement.cpp. References Ogre::GuiMetricsMode, and Ogre::GuiElement::mMetricsMode.

const String & Ogre::GuiElement::getName | ( | void |  | ) | const`[inherited]`

Gets the name of this overlay.

Definition at line 90 of file OgreGuiElement.cpp.

References Ogre::GuiElement::mName, and Ogre::String.

Referenced by Ogre::GuiContainer::_removeChild(), Ogre::ScrollBarGuiElement::actionPerformed(), Ogre::GuiContainer::addChildImpl(), Ogre::GuiContainer::copyFromTemplate(), Ogre::GuiManager::destroyAllGuiElementsImpl(), Ogre::GuiManager::destroyGuiElement(), Ogre::TTYGuiElement::CmdScrollBar::doGet(), Ogre::ListGuiElement::getScrollBarName(), Ogre::ListGuiElement::layoutItems(), Ogre::PopupMenuGuiElement::mouseReleased(), Ogre::OverlayManager::parseChildren(), Ogre::OverlayManager::parseElementAttrib(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::ButtonGuiElement::setButtonCaption(), Ogre::BorderButtonGuiElement::setButtonCaption(), Ogre::ListGuiElement::setScrollBarName(), Ogre::ListGuiElement::setSelectedIndex(), and Ogre::TextBoxGuiElement::setTextArea().

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 137 of file OgreRenderable.h. Referenced by Ogre::SceneManager::renderSingleObject().

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::SubEntity, and Ogre::BorderRenderable.

Definition at line 103 of file OgreRenderable.h.

Referenced by Ogre::AutoParamDataSource::getWorldMatrix(), Ogre::AutoParamDataSource::getWorldMatrixArray(), Ogre::AutoParamDataSource::getWorldMatrixCount(), and Ogre::SceneManager::renderSingleObject().

Real Ogre::CursorGuiElement::getOffsetX | ( | void |  | ) | const

| Used to get the cursor's hot spot X coordinate. Definition at line 84 of file OgreCursorGuiElement.h. References mOffsetX, and Ogre::Real. Referenced by Ogre::CursorGuiElement::CmdOffsetX::doGet().

Real Ogre::CursorGuiElement::getOffsetY | ( | void |  | ) | const

| Used to get the cursor's hot spot Y coordinate. Definition at line 86 of file OgreCursorGuiElement.h. References mOffsetY, and Ogre::Real. Referenced by Ogre::CursorGuiElement::CmdOffsetY::doGet().

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

| Definition at line 206 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 193 of file OgreStringInterface.h.

Referenced by Ogre::TTYGuiElement::addBaseParameters(), Ogre::TextBoxGuiElement::addBaseParameters(), Ogre::TextAreaGuiElement::addBaseParameters(), Ogre::ScrollBarGuiElement::addBaseParameters(), Ogre::PopupMenuGuiElement::addBaseParameters(), Ogre::ParticleEmitter::addBaseParameters(), Ogre::PanelGuiElement::addBaseParameters(), Ogre::ListGuiElement::addBaseParameters(), Ogre::GuiElement::addBaseParameters(), addBaseParameters(), Ogre::ButtonGuiElement::addBaseParameters(), Ogre::BorderPanelGuiElement::addBaseParameters(), Ogre::BorderButtonGuiElement::addBaseParameters(), Ogre::ExternalTextureSource::addBaseParams(), Ogre::CgProgram::CgProgram(), Ogre::ColourFaderAffector::ColourFaderAffector(), Ogre::ColourFaderAffector2::ColourFaderAffector2(), Ogre::ColourImageAffector::ColourImageAffector(), Ogre::ColourInterpolatorAffector::ColourInterpolatorAffector(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), Ogre::GLSLProgram::GLSLProgram(), Ogre::HollowEllipsoidEmitter::HollowEllipsoidEmitter(), Ogre::AreaEmitter::initDefaults(), Ogre::ParticleSystem::initParameters(), Ogre::LinearForceAffector::LinearForceAffector(), Ogre::RingEmitter::RingEmitter(), Ogre::RotationAffector::RotationAffector(), Ogre::ScaleAffector::ScaleAffector(), and Ogre::StringInterface::setParameter().

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

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

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.

Definition at line 224 of file OgreStringInterface.h.

References Ogre::ParamDictionary::getParameters(), and Ogre::ParameterList.

GuiContainer * Ogre::GuiElement::getParent | ( |  | ) | `[inherited]`

| Returns the parent container. Definition at line 812 of file OgreGuiElement.cpp. References Ogre::GuiElement::mParent. Referenced by Ogre::GuiManager::destroyAllGuiElementsImpl(), Ogre::ListGuiElement::mouseDragged(), Ogre::PopupMenuGuiElement::setSelectedItem(), and Ogre::ListGuiElement::setSelectedItem().

PositionTarget * Ogre::GuiElement::getPositionTargetParent | ( |  | ) | const`[virtual, inherited]`

| Returns the parent container. Implements Ogre::PositionTarget. Definition at line 807 of file OgreGuiElement.cpp.

virtual SceneDetailLevel Ogre::Renderable::getRenderDetail | ( |  | ) | const`[virtual, inherited]`

| Returns the preferred rasterisation mode of this renderable. Reimplemented in Ogre::SubEntity. Definition at line 134 of file OgreRenderable.h. References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID. Referenced by Ogre::SceneManager::renderSingleObject().

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

| See Renderable. Implements Ogre::Renderable. Definition at line 137 of file OgrePanelGuiElement.cpp. References Ogre::PanelGuiElement::mRenderOp.

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

| Definition at line 474 of file OgreGuiElement.h.

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

| Overridden from Renderable. Implements Ogre::Renderable. Definition at line 457 of file OgreGuiElement.h. References Ogre::Real. Referenced by Ogre::BorderRenderable::getSquaredViewDepth().

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

Definition at line 68 of file OgreRenderable.h.

Referenced by Ogre::RenderPriorityGroup::addRenderable().

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

| Definition at line 112 of file OgrePanelGuiElement.cpp. References Ogre::PanelGuiElement::mTileX, Ogre::Real, and Ogre::ushort. Referenced by Ogre::PanelGuiElement::CmdTiling::doGet().

Real Ogre::PanelGuiElement::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)

Definition at line 117 of file OgrePanelGuiElement.cpp.

References Ogre::PanelGuiElement::mTileY, Ogre::Real, and Ogre::ushort.

Referenced by Ogre::PanelGuiElement::CmdTiling::doGet().

Real Ogre::GuiElement::getTop | ( | void |  | ) | const`[virtual, inherited]`

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

Implements Ogre::PositionTarget.

Definition at line 236 of file OgreGuiElement.cpp.

References Ogre::GMM_RELATIVE, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelTop, Ogre::GuiElement::mTop, and Ogre::Real.

Referenced by Ogre::ButtonGuiElement::changeChild(), Ogre::BorderButtonGuiElement::changeChild(), Ogre::ScrollBarGuiElement::mouseDragged(), Ogre::ScrollBarGuiElement::mousePressed(), and Ogre::ScrollBarGuiElement::moveScrollBitTo().

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

| See GuiElement. Reimplemented from Ogre::PanelGuiElement. Definition at line 55 of file OgreCursorGuiElement.cpp. References msTypeName, and Ogre::String.

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

| Gets the vertical alignment for this element. Definition at line 751 of file OgreGuiElement.cpp. References Ogre::GuiVerticalAlignment, and Ogre::GuiElement::mVertAlign.

float Ogre::CursorGuiElement::getViewDepth | ( | Camera * |  | ) | const

| Definition at line 93 of file OgreCursorGuiElement.h.

Real Ogre::GuiElement::getWidth | ( | void |  | ) | const`[inherited]`

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

Definition at line 157 of file OgreGuiElement.cpp.

References Ogre::GMM_RELATIVE, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelWidth, Ogre::GuiElement::mWidth, and Ogre::Real.

Referenced by Ogre::GuiElement::_updateFromParent(), Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::ButtonGuiElement::changeChild(), Ogre::BorderButtonGuiElement::changeChild(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::ScrollBarGuiElement::mouseDragged(), Ogre::ScrollBarGuiElement::mousePressed(), Ogre::ScrollBarGuiElement::moveScrollBitTo(), Ogre::TextBoxGuiElement::processEvent(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::ScrollBarGuiElement::setDownButtonName(), Ogre::ListGuiElement::setScrollBarName(), Ogre::ScrollBarGuiElement::setScrollBitName(), Ogre::ScrollBarGuiElement::setUpButtonName(), Ogre::TextAreaGuiElement::updateGeometry(), and Ogre::ScrollBarGuiElement::updateScrollBit().

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

| @copydoc Renderable::getWorldOrientation Implements Ogre::Renderable. Definition at line 336 of file OgreGuiElement.cpp. References Ogre::Overlay::getWorldOrientation(), and Ogre::GuiElement::mOverlay.

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

| @copydoc Renderable::getWorldPosition Implements Ogre::Renderable. Definition at line 341 of file OgreGuiElement.cpp. References Ogre::Overlay::getWorldPosition(), and Ogre::GuiElement::mOverlay.

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

| See Renderable. Implements Ogre::Renderable. Definition at line 331 of file OgreGuiElement.cpp. References Ogre::Overlay::_getWorldTransforms(), and Ogre::GuiElement::mOverlay. Referenced by Ogre::BorderRenderable::getWorldTransforms().

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

| Returns the zOrder of the element. Definition at line 453 of file OgreGuiElement.h. References Ogre::ushort. Referenced by Ogre::Overlay::findElementAt(), and Ogre::GuiContainer::findElementAt().

void Ogre::CursorGuiElement::hide | ( | void |  | ) | `[virtual]`

| Hides this element if it was visible. Reimplemented from Ogre::GuiElement. Definition at line 71 of file OgreCursorGuiElement.cpp. References Ogre::OverlayManager::removeMouseMotionListener().

void Ogre::PanelGuiElement::initialise | ( | void |  | ) | `[virtual, inherited]`

Initialise.

Implements Ogre::GuiElement.

Reimplemented in Ogre::BorderPanelGuiElement.

Definition at line 73 of file OgrePanelGuiElement.cpp.

References Ogre::VertexDeclaration::addElement(), Ogre::VertexDeclaration::getVertexSize(), Ogre::PanelGuiElement::mRenderOp, Ogre::RenderOperation::operationType, POSITION_BINDING, Ogre::VertexBufferBinding::setBinding(), Ogre::RenderOperation::useIndexes, Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::RenderOperation::vertexData, Ogre::VertexData::vertexDeclaration, Ogre::VertexData::vertexStart, Ogre::VES_POSITION, and Ogre::VET_FLOAT3.

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

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

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

| Definition at line 433 of file OgreGuiElement.h. Referenced by Ogre::GuiContainer::clone(), and Ogre::GuiContainer::copyFromTemplate().

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

| Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 113 of file OgreGuiContainer.h. Referenced by Ogre::GuiContainer::copyFromTemplate().

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

| Definition at line 835 of file OgreGuiElement.cpp. References Ogre::GuiElement::mEnabled. Referenced by Ogre::GuiContainer::findElementAt(), and Ogre::ButtonGuiElement::updateMaterials().

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

| Implements Ogre::PositionTarget. Reimplemented in Ogre::TextBoxGuiElement. Definition at line 430 of file OgreGuiElement.h.

bool Ogre::MouseTarget::isMouseWithin | ( |  | ) | const`[inherited]`

| Definition at line 106 of file OgreMouseTarget.cpp. References Ogre::MouseTarget::mMouseWithin. Referenced by Ogre::ButtonGuiElement::updateMaterials(), and Ogre::BorderButtonGuiElement::updateMaterials().

virtual bool Ogre::EventListener::isMulticaster | ( |  | ) | const`[virtual, inherited]`

| Returns whether or not the listener is a multicaster. Reimplemented in Ogre::EventMulticaster. Definition at line 65 of file OgreEventListeners.h. Referenced by Ogre::EventMulticaster::convertListenerToMulti(), and Ogre::EventMulticaster::removeInternal().

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

| Returns whether this panel is transparent. Definition at line 127 of file OgrePanelGuiElement.cpp. References Ogre::PanelGuiElement::mTransparent. Referenced by Ogre::PanelGuiElement::CmdTransparent::doGet(), and Ogre::PanelGuiElement::setTransparent().

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

| Returns whether or not the element is visible. Definition at line 105 of file OgreGuiElement.cpp. References Ogre::GuiElement::mVisible. Referenced by Ogre::GuiContainer::findElementAt().

void Ogre::CursorGuiElement::mouseDragged | ( | MouseEvent * | e | ) | `[virtual]`

| Used to update the location of the cursor on screen, should only be called from the OverlayManager. Implements Ogre::MouseMotionListener. Definition at line 103 of file OgreCursorGuiElement.cpp. References mouseMoved().

virtual void Ogre::MouseMotionListener::mouseDragMoved | ( | MouseEvent * | e | ) | `[virtual, inherited]`

| sent to target Definition at line 154 of file OgreEventListeners.h. Referenced by Ogre::MouseMotionTarget::processMouseMotionEvent().

void Ogre::CursorGuiElement::mouseMoved | ( | MouseEvent * | e | ) | `[virtual]`

| Used to update the location of the cursor on screen, should only be called from the OverlayManager. Implements Ogre::MouseMotionListener. Definition at line 97 of file OgreCursorGuiElement.cpp. References Ogre::MouseEvent::getX(), Ogre::MouseEvent::getY(), mOffsetX, mOffsetY, Ogre::GuiElement::setLeft(), and Ogre::GuiElement::setTop(). Referenced by mouseDragged().

void Ogre::ActionTarget::processActionEvent | ( | ActionEvent * | e | ) | `[inherited]`

| Definition at line 46 of file OgreActionTarget.cpp. References Ogre::ActionListener::actionPerformed(), Ogre::InputEvent::getID(), and Ogre::ActionTarget::mActionListener. Referenced by Ogre::TextBoxGuiElement::processEvent(), Ogre::GuiElement::processEvent(), and Ogre::GuiControl::processEvent().

void Ogre::GuiElement::processEvent | ( | InputEvent * | e | ) | `[virtual, inherited]`

Processes events occurring on this component.

By default this method calls the appropriate process event method

Implements Ogre::EventTarget.

Reimplemented in Ogre::BorderButtonGuiElement, Ogre::ButtonGuiElement, Ogre::ScrollBarGuiElement, and Ogre::TextBoxGuiElement.

Definition at line 776 of file OgreGuiElement.cpp.

References Ogre::InputEvent::getID(), Ogre::InputEvent::isConsumed(), Ogre::GuiElement::mEnabled, Ogre::ActionTarget::processActionEvent(), Ogre::MouseTarget::processMouseEvent(), and Ogre::MouseMotionTarget::processMouseMotionEvent().

Referenced by Ogre::GuiPressable::fireActionPerformed().

void Ogre::MouseTarget::processMouseEvent | ( | MouseEvent * | e | ) | `[inherited]`

Definition at line 47 of file OgreMouseTarget.cpp.

References Ogre::InputEvent::getID(), Ogre::MouseTarget::mMouseListener, Ogre::MouseTarget::mMouseWithin, Ogre::MouseListener::mouseClicked(), Ogre::MouseListener::mouseDragDropped(), Ogre::MouseListener::mouseDragEntered(), Ogre::MouseListener::mouseDragExited(), Ogre::MouseListener::mouseEntered(), Ogre::MouseListener::mouseExited(), Ogre::MouseListener::mousePressed(), and Ogre::MouseListener::mouseReleased().

Referenced by Ogre::GuiElement::processEvent(), Ogre::EventProcessor::processEvent(), and Ogre::Cursor::processEvent().

void Ogre::MouseMotionTarget::processMouseMotionEvent | ( | MouseEvent * | e | ) | `[inherited]`

| Definition at line 45 of file OgreMouseMotionTarget.cpp. References Ogre::InputEvent::getID(), Ogre::MouseMotionTarget::mMouseMotionListener, Ogre::MouseMotionListener::mouseDragged(), Ogre::MouseMotionListener::mouseDragMoved(), and Ogre::MouseMotionListener::mouseMoved(). Referenced by Ogre::GuiElement::processEvent(), Ogre::EventProcessor::processEvent(), and Ogre::Cursor::processEvent().

void Ogre::ActionTarget::removeActionListener | ( | ActionListener * | l | ) | `[inherited]`

| Definition at line 72 of file OgreActionTarget.cpp. References Ogre::ActionTarget::mActionListener.

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

Removes a named element from this container.

Definition at line 113 of file OgreGuiContainer.cpp.

References Ogre::GuiElement::_setParent(), Except, Ogre::GuiContainer::mChildContainers, Ogre::GuiContainer::mChildren, and Ogre::String.

Referenced by Ogre::ListGuiElement::removeListItem(), Ogre::PopupMenuGuiElement::removeMenuItem(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::ButtonGuiElement::setButtonCaption(), Ogre::BorderButtonGuiElement::setButtonCaption(), Ogre::ListGuiElement::setScrollBarName(), and Ogre::TextBoxGuiElement::setTextArea().

void Ogre::MouseTarget::removeMouseListener | ( | MouseListener * | l | ) | `[inherited]`

| Definition at line 96 of file OgreMouseTarget.cpp. References Ogre::MouseTarget::mMouseListener.

void Ogre::MouseMotionTarget::removeMouseMotionListener | ( | MouseMotionListener * | l | ) | `[inherited]`

| Definition at line 75 of file OgreMouseMotionTarget.cpp. References Ogre::MouseMotionTarget::mMouseMotionListener. Referenced by Ogre::InputReader::removeCursorMoveListener().

void Ogre::GuiElement::setCaption | ( | const String & | 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::TextAreaGuiElement, Ogre::TextBoxGuiElement, and Ogre::TTYGuiElement.

Definition at line 644 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiElement::mCaption, and Ogre::String.

Referenced by Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::Profiler::createTextArea(), Ogre::Profiler::displayResults(), Ogre::ButtonGuiElement::setButtonCaption(), and Ogre::BorderButtonGuiElement::setButtonCaption().

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

| Should this container pass events to their children. Definition at line 121 of file OgreGuiContainer.h. Referenced by Ogre::ListGuiElement::addListItem().

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

| Definition at line 436 of file OgreGuiElement.h. Referenced by Ogre::TextBoxGuiElement::setBackPanel(), Ogre::ButtonGuiElement::setButtonCaption(), Ogre::BorderButtonGuiElement::setButtonCaption(), Ogre::ScrollBarGuiElement::setDownButtonName(), Ogre::ScrollBarGuiElement::setScrollBitName(), Ogre::TextBoxGuiElement::setTextArea(), and Ogre::ScrollBarGuiElement::setUpButtonName().

void Ogre::GuiElement::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::TextAreaGuiElement, and Ogre::TTYGuiElement.

Definition at line 655 of file OgreGuiElement.cpp.

References Ogre::GuiElement::mColour.

Referenced by Ogre::ButtonGuiElement::updateMaterials().

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

void Ogre::GuiElement::setDimensions | ( | Real | width,
|  | Real | height
| ) | `[inherited]`

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

Definition at line 110 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_RELATIVE, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mHeight, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelHeight, Ogre::GuiElement::mPixelWidth, Ogre::GuiElement::mWidth, and Ogre::Real.

Referenced by Ogre::TextBoxGuiElement::setBackPanel().

void Ogre::GuiElement::setEnabled | ( | bool | b | ) | `[virtual, inherited]`

| Definition at line 841 of file OgreGuiElement.cpp. References Ogre::GuiElement::mEnabled.

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

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

Definition at line 169 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_RELATIVE, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mHeight, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelHeight, and Ogre::Real.

Referenced by Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::ButtonGuiElement::changeChild(), Ogre::BorderButtonGuiElement::changeChild(), Ogre::Profiler::createContainer(), Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), CursorGuiElement(), Ogre::Profiler::displayResults(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::PopupMenuGuiElement::layoutItems(), and Ogre::ListGuiElement::setScrollBarName().

void Ogre::GuiElement::setHorizontalAlignment | ( | GuiHorizontalAlignment | gha | ) | `[virtual, inherited]`

Sets the horizontal origin for this element.

Remarks:
  By default, the horizontal origin for a GuiElement 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.

Definition at line 734 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiHorizontalAlignment, and Ogre::GuiElement::mHorzAlign.

void Ogre::GuiElement::setLeft | ( | Real | left | ) | `[inherited]`

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

Definition at line 195 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_RELATIVE, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mLeft, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelLeft, and Ogre::Real.

Referenced by Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::ButtonGuiElement::changeChild(), Ogre::BorderButtonGuiElement::changeChild(), Ogre::Profiler::createContainer(), Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), Ogre::Profiler::displayResults(), Ogre::ScrollBarGuiElement::layoutItems(), mouseMoved(), Ogre::TextBoxGuiElement::setBackPanel(), setOffsetX(), Ogre::ListGuiElement::setScrollBarName(), Ogre::TextBoxGuiElement::setTextArea(), and show().

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

| Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 142 of file OgrePanelGuiElement.cpp. References Ogre::String, and Ogre::PanelGuiElement::updateTextureGeometry().

void Ogre::GuiElement::setMetricsMode | ( | GuiMetricsMode | gmm | ) | `[virtual, inherited]`

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

Remarks:
  By default, GuiElements 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 in Ogre::BorderPanelGuiElement, Ogre::TextAreaGuiElement, and Ogre::TTYGuiElement.

Definition at line 665 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::OverlayManager::getViewportHeight(), Ogre::OverlayManager::getViewportWidth(), Ogre::GMM_PIXELS, Ogre::GMM_RELATIVE, Ogre::GMM_RELATIVE_ASPECT_ADJUSTED, Ogre::GuiMetricsMode, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mHeight, Ogre::GuiElement::mLeft, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelHeight, Ogre::GuiElement::mPixelLeft, Ogre::GuiElement::mPixelScaleX, Ogre::GuiElement::mPixelScaleY, Ogre::GuiElement::mPixelTop, Ogre::GuiElement::mPixelWidth, Ogre::GuiElement::mTop, Ogre::GuiElement::mWidth, and Ogre::Real.

Referenced by Ogre::Profiler::createContainer(), Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), and Ogre::Profiler::displayResults().

void Ogre::CursorGuiElement::setOffsetX | ( | Real | x | ) |

| Used to set the cursor's hot spot X coordinate. Definition at line 80 of file OgreCursorGuiElement.cpp. References Ogre::GuiElement::mLeft, mOffsetX, Ogre::Real, and Ogre::GuiElement::setLeft().

void Ogre::CursorGuiElement::setOffsetY | ( | Real | y | ) |

| Used to set the cursor's hot spot Y coordinate. Definition at line 86 of file OgreCursorGuiElement.cpp. References mOffsetY, Ogre::GuiElement::mTop, Ogre::Real, and Ogre::GuiElement::setTop().

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)

Definition at line 33 of file OgreStringInterface.cpp.

References Ogre::ParamCommand::doSet(), Ogre::ParamDictionary::getParamCommand(), Ogre::StringInterface::getParamDictionary(), and Ogre::String.

Referenced by Ogre::StringInterface::copyParametersTo(), Ogre::Profiler::createContainer(), Ogre::Profiler::createTextArea(), Ogre::MaterialSerializer::finishProgramDefinition(), Ogre::ParticleSystemManager::parseAffectorAttrib(), Ogre::ParticleSystemManager::parseAttrib(), Ogre::OverlayManager::parseElementAttrib(), and Ogre::ParticleSystemManager::parseEmitterAttrib().

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

Definition at line 126 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_RELATIVE, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mLeft, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelLeft, Ogre::GuiElement::mPixelTop, Ogre::GuiElement::mTop, and Ogre::Real.

void Ogre::PanelGuiElement::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)

Definition at line 100 of file OgrePanelGuiElement.cpp.

References Ogre::PanelGuiElement::mTileX, Ogre::PanelGuiElement::mTileY, OGRE_MAX_TEXTURE_COORD_SETS, Ogre::Real, Ogre::PanelGuiElement::updateTextureGeometry(), and Ogre::ushort.

void Ogre::GuiElement::setTop | ( | Real | Top | ) | `[inherited]`

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

Definition at line 221 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_RELATIVE, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelTop, Ogre::GuiElement::mTop, and Ogre::Real.

Referenced by Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::ButtonGuiElement::changeChild(), Ogre::BorderButtonGuiElement::changeChild(), Ogre::Profiler::createContainer(), Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), Ogre::Profiler::displayResults(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::PopupMenuGuiElement::layoutItems(), Ogre::ListGuiElement::layoutItems(), mouseMoved(), Ogre::ScrollBarGuiElement::moveScrollBitTo(), Ogre::TextBoxGuiElement::setBackPanel(), setOffsetY(), Ogre::ListGuiElement::setScrollBarName(), Ogre::TextBoxGuiElement::setTextArea(), show(), and Ogre::ScrollBarGuiElement::updateScrollBit().

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

| Sets whether this panel is transparent (used only as a grouping level), or if it is actually renderred. Definition at line 122 of file OgrePanelGuiElement.cpp. References Ogre::PanelGuiElement::isTransparent(), and Ogre::PanelGuiElement::mTransparent. Referenced by Ogre::TextBoxGuiElement::TextBoxGuiElement().

void Ogre::GuiElement::setVerticalAlignment | ( | GuiVerticalAlignment | gva | ) | `[virtual, inherited]`

Sets the vertical origin for this element.

Remarks:
  By default, the vertical origin for a GuiElement 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.

Definition at line 745 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GuiVerticalAlignment, and Ogre::GuiElement::mVertAlign.

void Ogre::GuiElement::setWidth | ( | Real | width | ) | `[inherited]`

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

Definition at line 143 of file OgreGuiElement.cpp.

References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_RELATIVE, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelWidth, Ogre::GuiElement::mWidth, and Ogre::Real.

Referenced by Ogre::ListGuiElement::addListItem(), Ogre::PopupMenuGuiElement::addMenuItem(), Ogre::ButtonGuiElement::changeChild(), Ogre::BorderButtonGuiElement::changeChild(), Ogre::Profiler::createContainer(), Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), CursorGuiElement(), Ogre::Profiler::displayResults(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::TextBoxGuiElement::setBackPanel(), and Ogre::TextAreaGuiElement::updateGeometry().

void Ogre::CursorGuiElement::show | ( | void |  | ) | `[virtual]`

Inherited from PanelGuiElement, should only be called from the OverlayManager.

Reimplemented from Ogre::GuiElement.

Definition at line 60 of file OgreCursorGuiElement.cpp.

References Ogre::OverlayManager::addMouseMotionListener(), Ogre::OverlayManager::getMouseX(), Ogre::OverlayManager::getMouseY(), mOffsetX, mOffsetY, Ogre::GuiElement::mVisible, Ogre::GuiElement::setLeft(), and Ogre::GuiElement::setTop().

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

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

Implements Ogre::GuiElement.

Reimplemented in Ogre::BorderPanelGuiElement.

Definition at line 168 of file OgrePanelGuiElement.cpp.

References Ogre::GuiElement::_getDerivedLeft(), Ogre::GuiElement::_getDerivedTop(), Ogre::VertexBufferBinding::getBuffer(), Ogre::GuiElement::mHeight, Ogre::PanelGuiElement::mRenderOp, Ogre::GuiElement::mWidth, POSITION_BINDING, Ogre::Real, Ogre::VertexData::vertexBufferBinding, and Ogre::RenderOperation::vertexData.

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

Called to update the texture coords when layers change.

Definition at line 218 of file OgrePanelGuiElement.cpp.

References Ogre::VertexDeclaration::addElement(), Ogre::VertexBufferBinding::getBuffer(), Ogre::Pass::getNumTextureUnitStates(), Ogre::Technique::getPass(), Ogre::Material::getTechnique(), Ogre::VertexDeclaration::getVertexSize(), Ogre::PanelGuiElement::mNumTexCoordsInBuffer, Ogre::GuiElement::mpMaterial, Ogre::PanelGuiElement::mRenderOp, Ogre::PanelGuiElement::mTileX, Ogre::PanelGuiElement::mTileY, Ogre::Real, Ogre::VertexDeclaration::removeElement(), Ogre::VertexBufferBinding::setBinding(), TEXCOORD_BINDING, Ogre::ushort, Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::RenderOperation::vertexData, Ogre::VertexData::vertexDeclaration, Ogre::VES_TEXTURE_COORDINATES, and Ogre::VET_FLOAT2.

Referenced by Ogre::PanelGuiElement::setMaterialName(), and Ogre::PanelGuiElement::setTiling().

bool Ogre::GuiElement::useIdentityProjection | ( | void |  | ) | const`[virtual, inherited]`

| See Renderable. Reimplemented from Ogre::Renderable. Definition at line 346 of file OgreGuiElement.cpp.

bool Ogre::GuiElement::useIdentityView | ( | void |  | ) | const`[virtual, inherited]`

| See Renderable. Reimplemented from Ogre::Renderable. Definition at line 351 of file OgreGuiElement.cpp.

## Member Data Documentation

ActionListener* Ogre::ActionTarget::mActionListener`[protected, inherited]`

| Definition at line 58 of file OgreActionTarget.h. Referenced by Ogre::ActionTarget::ActionTarget(), Ogre::ActionTarget::addActionListener(), Ogre::ActionTarget::processActionEvent(), and Ogre::ActionTarget::removeActionListener().

String Ogre::GuiElement::mCaption`[protected, inherited]`

Definition at line 123 of file OgreGuiElement.h.

Referenced by Ogre::TTYGuiElement::getCaption(), Ogre::TextBoxGuiElement::getCaption(), Ogre::TextAreaGuiElement::getCaption(), Ogre::GuiElement::getCaption(), Ogre::TextBoxGuiElement::getTextAreaName(), Ogre::TextBoxGuiElement::processEvent(), Ogre::TextBoxGuiElement::setCaption(), Ogre::TextAreaGuiElement::setCaption(), Ogre::GuiElement::setCaption(), Ogre::TextBoxGuiElement::setCaptionToTextArea(), Ogre::TextBoxGuiElement::setTextArea(), and Ogre::TextAreaGuiElement::updateGeometry().

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

| Definition at line 58 of file OgreGuiContainer.h. Referenced by Ogre::GuiContainer::_removeChild(), Ogre::GuiContainer::addChildImpl(), Ogre::GuiContainer::getChildContainerIterator(), and Ogre::GuiContainer::removeChild().

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

| Definition at line 56 of file OgreGuiContainer.h. Referenced by Ogre::GuiContainer::_removeChild(), Ogre::GuiContainer::addChildImpl(), Ogre::GuiContainer::getChild(), Ogre::GuiContainer::getChildIterator(), Ogre::ListGuiElement::layoutItems(), and Ogre::GuiContainer::removeChild().

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

| Definition at line 60 of file OgreGuiContainer.h. Referenced by Ogre::BorderButtonGuiElement::BorderButtonGuiElement(), Ogre::ButtonGuiElement::ButtonGuiElement(), Ogre::PopupMenuGuiElement::PopupMenuGuiElement(), and Ogre::TextBoxGuiElement::TextBoxGuiElement().

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

| Definition at line 125 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_getClippingRegion(), Ogre::GuiElement::_updateFromParent(), and Ogre::GuiElement::contains().

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

| Definition at line 116 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::GuiElement().

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

| Definition at line 124 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::getColour(), and Ogre::GuiElement::setColour().

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

| Definition at line 233 of file OgreRenderable.h.

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

| Definition at line 145 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_getDerivedLeft(), and Ogre::GuiElement::_updateFromParent().

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

Definition at line 147 of file OgreGuiElement.h.

Referenced by Ogre::GuiElement::_notifyParent(), Ogre::GuiElement::_setDimensions(), Ogre::GuiElement::_setHeight(), Ogre::GuiElement::_setLeft(), Ogre::GuiElement::_setPosition(), Ogre::GuiElement::_setTop(), Ogre::GuiElement::_setWidth(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setPosition(), Ogre::GuiElement::setTop(), and Ogre::GuiElement::setWidth().

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

| Definition at line 146 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_getDerivedTop(), Ogre::GuiElement::_updateFromParent(), and Ogre::ScrollBarGuiElement::mousePressed().

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

| Definition at line 160 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::GuiElement(), Ogre::GuiElement::isEnabled(), Ogre::GuiElement::processEvent(), and Ogre::GuiElement::setEnabled().

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

Falg indicating if the vertex positons need recalculating.

Definition at line 150 of file OgreGuiElement.h.

Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_positionsOutOfDate(), Ogre::TTYGuiElement::_update(), Ogre::TextAreaGuiElement::_update(), Ogre::GuiElement::_update(), Ogre::BorderPanelGuiElement::_update(), Ogre::GuiElement::GuiElement(), Ogre::BorderPanelGuiElement::setBorderSize(), Ogre::TTYGuiElement::setCharHeight(), Ogre::TextAreaGuiElement::setCharHeight(), Ogre::TTYGuiElement::setSpaceWidth(), and Ogre::TextAreaGuiElement::setSpaceWidth().

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

Definition at line 120 of file OgreGuiElement.h.

Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setDimensions(), Ogre::GuiElement::_setHeight(), Ogre::GuiElement::_update(), Ogre::GuiElement::_updateFromParent(), Ogre::TTYGuiElement::checkAndSetUpdateGeometry(), Ogre::GuiElement::getHeight(), Ogre::GuiElement::GuiElement(), Ogre::ListGuiElement::layoutItems(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), Ogre::GuiElement::setMetricsMode(), Ogre::TTYGuiElement::TTYGuiElement(), Ogre::TTYGuiElement::updatePositionGeometry(), Ogre::PanelGuiElement::updatePositionGeometry(), and Ogre::BorderPanelGuiElement::updatePositionGeometry().

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

| Definition at line 128 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getHorizontalAlignment(), Ogre::GuiElement::GuiElement(), and Ogre::GuiElement::setHorizontalAlignment().

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

Definition at line 117 of file OgreGuiElement.h.

Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setLeft(), Ogre::GuiElement::_setPosition(), Ogre::GuiElement::_update(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getLeft(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), setOffsetX(), and Ogre::GuiElement::setPosition().

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

| Definition at line 121 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::getMaterialName(), Ogre::GuiElement::setMaterialName(), Ogre::PopupMenuGuiElement::setSelectedItem(), and Ogre::ListGuiElement::setSelectedItem().

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

Definition at line 127 of file OgreGuiElement.h.

Referenced by Ogre::TTYGuiElement::_update(), Ogre::TextAreaGuiElement::_update(), Ogre::BorderPanelGuiElement::_update(), Ogre::BorderPanelGuiElement::getBottomBorderSize(), Ogre::TTYGuiElement::getCharHeight(), Ogre::TextAreaGuiElement::getCharHeight(), Ogre::GuiElement::getHeight(), Ogre::GuiElement::getLeft(), Ogre::BorderPanelGuiElement::getLeftBorderSize(), Ogre::GuiElement::getMetricsMode(), Ogre::BorderPanelGuiElement::getRightBorderSize(), Ogre::TTYGuiElement::getSpaceWidth(), Ogre::TextAreaGuiElement::getSpaceWidth(), Ogre::GuiElement::getTop(), Ogre::BorderPanelGuiElement::getTopBorderSize(), Ogre::GuiElement::getWidth(), Ogre::GuiElement::GuiElement(), Ogre::BorderPanelGuiElement::setBorderSize(), Ogre::TTYGuiElement::setCharHeight(), Ogre::TextAreaGuiElement::setCharHeight(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setPosition(), Ogre::TTYGuiElement::setSpaceWidth(), Ogre::TextAreaGuiElement::setSpaceWidth(), Ogre::GuiElement::setTop(), Ogre::GuiElement::setWidth(), Ogre::TextAreaGuiElement::updateGeometry(), Ogre::ButtonGuiElement::updateMaterials(), and Ogre::BorderButtonGuiElement::updateMaterials().

MouseListener* Ogre::MouseTarget::mMouseListener`[protected, inherited]`

| Definition at line 60 of file OgreMouseTarget.h. Referenced by Ogre::MouseTarget::addMouseListener(), Ogre::GuiElement::GuiElement(), Ogre::MouseTarget::MouseTarget(), Ogre::MouseTarget::processMouseEvent(), and Ogre::MouseTarget::removeMouseListener().

MouseMotionListener* Ogre::MouseMotionTarget::mMouseMotionListener`[protected, inherited]`

| Definition at line 59 of file OgreMouseMotionTarget.h. Referenced by Ogre::MouseMotionTarget::addMouseMotionListener(), Ogre::MouseMotionTarget::MouseMotionTarget(), Ogre::MouseMotionTarget::processMouseMotionEvent(), and Ogre::MouseMotionTarget::removeMouseMotionListener().

bool Ogre::MouseTarget::mMouseWithin`[protected, inherited]`

| Definition at line 63 of file OgreMouseTarget.h. Referenced by Ogre::MouseTarget::isMouseWithin(), Ogre::MouseTarget::MouseTarget(), and Ogre::MouseTarget::processMouseEvent().

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

Definition at line 114 of file OgreGuiElement.h.

Referenced by Ogre::GuiElement::clone(), Ogre::GuiContainer::copyFromTemplate(), Ogre::PopupMenuGuiElement::getListItemName(), Ogre::ListGuiElement::getListItemName(), Ogre::GuiElement::getName(), Ogre::ListGuiElement::layoutItems(), Ogre::TextBoxGuiElement::processEvent(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::ButtonGuiElement::setButtonCaption(), Ogre::BorderButtonGuiElement::setButtonCaption(), Ogre::ScrollBarGuiElement::setDownButtonName(), Ogre::ListGuiElement::setScrollBarName(), Ogre::ScrollBarGuiElement::setScrollBitName(), Ogre::ListGuiElement::setSelectedIndex(), Ogre::TextBoxGuiElement::setTextArea(), and Ogre::ScrollBarGuiElement::setUpButtonName().

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

| Definition at line 113 of file OgrePanelGuiElement.h. Referenced by Ogre::PanelGuiElement::PanelGuiElement(), and Ogre::PanelGuiElement::updateTextureGeometry().

Real Ogre::CursorGuiElement::mOffsetX`[protected]`

| The current X coordinate of the cursor's hot spot. Definition at line 116 of file OgreCursorGuiElement.h. Referenced by getOffsetX(), mouseMoved(), setOffsetX(), and show().

Real Ogre::CursorGuiElement::mOffsetY`[protected]`

| The current Y coordinate of the cursor's hot spot. Definition at line 118 of file OgreCursorGuiElement.h. Referenced by getOffsetY(), mouseMoved(), setOffsetY(), and show().

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

| Definition at line 142 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyParent(), Ogre::GuiContainer::addChildImpl(), Ogre::GuiElement::getWorldOrientation(), Ogre::GuiElement::getWorldPosition(), and Ogre::GuiElement::getWorldTransforms().

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

GuiContainer* Ogre::GuiElement::mParent`[protected, inherited]`

| Definition at line 140 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyParent(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getParent(), and Ogre::GuiElement::GuiElement().

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

| Definition at line 135 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setDimensions(), Ogre::GuiElement::_setHeight(), Ogre::GuiElement::_update(), Ogre::GuiElement::getHeight(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), and Ogre::GuiElement::setMetricsMode().

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

| Definition at line 133 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setLeft(), Ogre::GuiElement::_setPosition(), Ogre::GuiElement::_update(), Ogre::GuiElement::getLeft(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), and Ogre::GuiElement::setPosition().

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

| Definition at line 136 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setDimensions(), Ogre::GuiElement::_setLeft(), Ogre::GuiElement::_setPosition(), Ogre::GuiElement::_setWidth(), Ogre::GuiElement::_update(), Ogre::BorderPanelGuiElement::_update(), Ogre::GuiElement::GuiElement(), and Ogre::GuiElement::setMetricsMode().

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

| Definition at line 137 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setDimensions(), Ogre::GuiElement::_setHeight(), Ogre::GuiElement::_setPosition(), Ogre::GuiElement::_setTop(), Ogre::GuiElement::_update(), Ogre::BorderPanelGuiElement::_update(), Ogre::GuiElement::GuiElement(), and Ogre::GuiElement::setMetricsMode().

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

| Definition at line 132 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setPosition(), Ogre::GuiElement::_setTop(), Ogre::GuiElement::_update(), Ogre::GuiElement::getTop(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setPosition(), and Ogre::GuiElement::setTop().

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

| Definition at line 134 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setDimensions(), Ogre::GuiElement::_setWidth(), Ogre::GuiElement::_update(), Ogre::GuiElement::getWidth(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setMetricsMode(), and Ogre::GuiElement::setWidth().

Material* Ogre::GuiElement::mpMaterial`[protected, inherited]`

| Definition at line 122 of file OgreGuiElement.h. Referenced by Ogre::PanelGuiElement::_updateRenderQueue(), Ogre::GuiElement::getMaterial(), Ogre::GuiElement::GuiElement(), Ogre::TTYGuiElement::setFontName(), Ogre::TextAreaGuiElement::setFontName(), Ogre::GuiElement::setMaterialName(), and Ogre::PanelGuiElement::updateTextureGeometry().

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

| Definition at line 115 of file OgrePanelGuiElement.h. Referenced by Ogre::PanelGuiElement::getRenderOperation(), Ogre::PanelGuiElement::initialise(), Ogre::PanelGuiElement::updatePositionGeometry(), Ogre::BorderPanelGuiElement::updatePositionGeometry(), Ogre::PanelGuiElement::updateTextureGeometry(), and Ogre::PanelGuiElement::~PanelGuiElement().

GuiElementCommands::CmdCaption Ogre::GuiElement::msCaptionCmd`[static, protected, inherited]`

| Definition at line 50 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

CursorGuiElement::CmdOffsetX Ogre::CursorGuiElement::msCmdOffsetX`[static, protected]`

| Definition at line 38 of file OgreCursorGuiElement.cpp. Referenced by addBaseParameters().

CursorGuiElement::CmdOffsetY Ogre::CursorGuiElement::msCmdOffsetY`[static, protected]`

| Definition at line 39 of file OgreCursorGuiElement.cpp. Referenced by addBaseParameters().

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

| Definition at line 38 of file OgrePanelGuiElement.cpp. Referenced by Ogre::PanelGuiElement::addBaseParameters().

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

| Definition at line 39 of file OgrePanelGuiElement.cpp. Referenced by Ogre::PanelGuiElement::addBaseParameters().

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

| Dictionary of parameters. Definition at line 30 of file OgreStringInterface.cpp. Referenced by Ogre::StringInterface::cleanupDictionary().

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

| Definition at line 45 of file OgreRenderSystem.cpp.

GuiElementCommands::CmdHeight Ogre::GuiElement::msHeightCmd`[static, protected, inherited]`

| Definition at line 48 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

GuiElementCommands::CmdHorizontalAlign Ogre::GuiElement::msHorizontalAlignCmd`[static, protected, inherited]`

| Definition at line 52 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

GuiElementCommands::CmdLeft Ogre::GuiElement::msLeftCmd`[static, protected, inherited]`

| Definition at line 45 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

GuiElementCommands::CmdMaterial Ogre::GuiElement::msMaterialCmd`[static, protected, inherited]`

| Definition at line 49 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

GuiElementCommands::CmdMetricsMode Ogre::GuiElement::msMetricsModeCmd`[static, protected, inherited]`

| Definition at line 51 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

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

| Definition at line 163 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::copyFromTemplate(), and Ogre::GuiElement::GuiElement().

GuiElementCommands::CmdTop Ogre::GuiElement::msTopCmd`[static, protected, inherited]`

| Definition at line 46 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

String Ogre::CursorGuiElement::msTypeName = "Cursor"`[static, protected]`

| Reimplemented from Ogre::PanelGuiElement. Definition at line 36 of file OgreCursorGuiElement.cpp. Referenced by getTypeName().

GuiElementCommands::CmdVerticalAlign Ogre::GuiElement::msVerticalAlignCmd`[static, protected, inherited]`

| Definition at line 53 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

GuiElementCommands::CmdVisible Ogre::GuiElement::msVisibleCmd`[static, protected, inherited]`

| Definition at line 54 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

GuiElementCommands::CmdWidth Ogre::GuiElement::msWidthCmd`[static, protected, inherited]`

| Definition at line 47 of file OgreGuiElement.cpp. Referenced by Ogre::GuiElement::addBaseParameters().

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

| Definition at line 111 of file OgrePanelGuiElement.h. Referenced by Ogre::PanelGuiElement::getTileX(), Ogre::PanelGuiElement::PanelGuiElement(), Ogre::PanelGuiElement::setTiling(), and Ogre::PanelGuiElement::updateTextureGeometry().

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

| Definition at line 112 of file OgrePanelGuiElement.h. Referenced by Ogre::PanelGuiElement::getTileY(), Ogre::PanelGuiElement::PanelGuiElement(), Ogre::PanelGuiElement::setTiling(), and Ogre::PanelGuiElement::updateTextureGeometry().

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

Definition at line 118 of file OgreGuiElement.h.

Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setPosition(), Ogre::GuiElement::_setTop(), Ogre::GuiElement::_update(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getTop(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setMetricsMode(), setOffsetY(), Ogre::GuiElement::setPosition(), and Ogre::GuiElement::setTop().

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

| Definition at line 109 of file OgrePanelGuiElement.h. Referenced by Ogre::PanelGuiElement::_updateRenderQueue(), Ogre::PanelGuiElement::isTransparent(), Ogre::PanelGuiElement::PanelGuiElement(), and Ogre::PanelGuiElement::setTransparent().

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

| Definition at line 129 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getVerticalAlignment(), Ogre::GuiElement::GuiElement(), and Ogre::GuiElement::setVerticalAlignment().

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

| Definition at line 115 of file OgreGuiElement.h. Referenced by CursorGuiElement(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::hide(), Ogre::GuiElement::isVisible(), Ogre::GuiElement::show(), and show().

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

Definition at line 119 of file OgreGuiElement.h.

Referenced by Ogre::GuiElement::_notifyViewport(), Ogre::GuiElement::_setDimensions(), Ogre::GuiElement::_setWidth(), Ogre::GuiElement::_update(), Ogre::GuiElement::_updateFromParent(), Ogre::TTYGuiElement::checkAndSetUpdateGeometry(), Ogre::GuiElement::getWidth(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setWidth(), Ogre::PanelGuiElement::updatePositionGeometry(), Ogre::BorderPanelGuiElement::updatePositionGeometry(), Ogre::TTYGuiElement::updateTextGeometry(), and Ogre::TTYGuiElement::updateWindowGeometry().

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

| Definition at line 157 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyWorldTransforms(), and Ogre::GuiContainer::addChildImpl().

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

| Definition at line 154 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyZOrder(), Ogre::GuiElement::_updateRenderQueue(), Ogre::BorderPanelGuiElement::_updateRenderQueue(), Ogre::GuiContainer::addChildImpl(), and Ogre::GuiElement::GuiElement().

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

- OgreCursorGuiElement.h
- OgreCursorGuiElement.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:50:13 2004