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

Ogre::GuiElement Class Reference

Abstract definition of a 2D element to be displayed in an Overlay. More...

#include <OgreGuiElement.h>

Inheritance diagram for Ogre::GuiElement:

Inheritance graph
[legend]
List of all members.

Public Methods

 GuiElement (const String &name)
 Constructor: do not call direct, use GuiManager::createElement.

virtual ~GuiElement ()
virtual void initialise (void)=0
 Initialise gui element.

const StringgetName (void) const
 Gets the name of this overlay.

virtual void show (void)
 Shows this element if it was hidden.

virtual void hide (void)
 Hides this element if it was visible.

bool isVisible (void) const
 Returns whether or not the element is visible.

bool isEnabled () const
virtual void setEnabled (bool b)
void setDimensions (Real width, Real height)
 Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual const StringgetMaterialName (void) const
 Gets the name of the material this element uses.

virtual void setMaterialName (const String &matName)
 Sets the name of the material this element will use.

MaterialgetMaterial (void) const
 See Renderable.

void getWorldTransforms (Matrix4 *xform) const
 See Renderable.

const QuaterniongetWorldOrientation (void) const
 @copydoc Renderable::getWorldOrientation

const Vector3getWorldPosition (void) const
 @copydoc Renderable::getWorldPosition

bool useIdentityProjection (void) const
 See Renderable.

bool useIdentityView (void) const
 See Renderable.

virtual void _positionsOutOfDate (void)
 Tell the object to recalculate.

virtual void _update (void)
 Internal method to update the element based on transforms applied.

virtual void _updateFromParent (void)
 Updates this elements transform based on it's parent.

virtual void _notifyParent (GuiContainer *parent, Overlay *overlay)
 Internal method for notifying the gui element of it's parent and ultimate overlay.

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 _notifyZOrder (ushort newZOrder)
 Internal method to notify the element when Zorder of parent overlay has changed.

virtual void _notifyWorldTransforms (const Matrix4 &xform)
 Internal method to notify the element when it's world transform of parent overlay has changed.

virtual void _notifyViewport ()
 Internal method to notify the element when the viewport of parent overlay has changed.

virtual void _updateRenderQueue (RenderQueue *queue)
 Internal method to put the contents onto the render queue.

virtual const StringgetTypeName (void) const=0
 Gets the type name of the element.

virtual void setCaption (const String &text)
 Sets the caption on elements that support it.

virtual const StringgetCaption (void) const
 Gets the caption for this element.

virtual void setColour (const ColourValue &col)
 Sets the colour on elements that support it.

virtual const ColourValuegetColour (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 GuiElement * findElementAt (Real x, Real y)
 Returns true if xy is within the constraints of the component.

virtual void processEvent (InputEvent *e)
 Processes events occurring on this component.

virtual bool isContainer () const
 returns false as this class is not a container type

virtual bool isKeyEnabled () const
virtual bool isCloneable () const
virtual void setCloneable (bool c)
PositionTargetgetPositionTargetParent ()
 Returns the parent container.

GuiContainergetParent ()
 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 LightListgetLights (void) const
 @copydoc Renderable::getLights

void copyFromTemplate (GuiElement *templateGui)
virtual GuiElement * clone (const String &instanceName)
const GuiElement * getSourceTemplate () const
ParamDictionarygetParamDictionary (void)
 Retrieves the parameter dictionary for this class.

const ParamDictionarygetParamDictionary (void) const
const ParameterListgetParameters (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 TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses.

virtual void getRenderOperation (RenderOperation &op)=0
 Gets the render operation required to send this object to the frame buffer.

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 PlaneListgetClipPlanes () const
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow.

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)

Protected Methods

virtual void updatePositionGeometry (void)=0
 Internal method which is triggered when the positions of the element get updated, meaning the element should be rebuilding it's mesh positions.

virtual void addBaseParameters (void)
 Internal method for setting up the basic parameter definitions for a subclass.

bool createParamDictionary (const String &className)
 Internal method for creating a parameter dictionary for the class, if it does not already exist.


Protected Attributes

String mName
bool mVisible
bool mCloneable
Real mLeft
Real mTop
Real mWidth
Real mHeight
String mMaterialName
MaterialmpMaterial
String mCaption
ColourValue mColour
Rectangle mClippingRegion
GuiMetricsMode mMetricsMode
GuiHorizontalAlignment mHorzAlign
GuiVerticalAlignment mVertAlign
Real mPixelTop
Real mPixelLeft
Real mPixelWidth
Real mPixelHeight
Real mPixelScaleX
Real mPixelScaleY
GuiContainermParent
OverlaymOverlay
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).

MouseListenermMouseListener
bool mMouseWithin
MouseMotionListenermMouseMotionListener
ActionListenermActionListener

Static Protected Attributes

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.


Detailed Description

Abstract definition of a 2D element to be displayed in an Overlay.

Remarks:
This class abstracts all the details of a 2D element which will appear in an overlay. In fact, not all GuiElement instances can be directly added to an Overlay, only those which are GuiContainer instances (a subclass of this class). GuiContainer objects can contain any GuiElement however. This is just to enforce some level of grouping on widgets.

GuiElements should be managed using GuiManager. This class is responsible for instantiating / deleting elements, and also for accepting new types of element from plugins etc.

Note that positions / dimensions of 2D screen elements are expressed as parametric values (0.0 - 1.0) because this makes them resolution-independent. However, most screen resolutions have an aspect ratio of 1.3333:1 (width : height) so note that in physical pixels 0.5 is wider than it is tall, so a 0.5x0.5 panel will not be square on the screen (but it will take up exactly half the screen in both dimensions).

Because this class is designed to be extensible, it subclasses from StringInterface so its parameters can be set in a generic way.

Definition at line 96 of file OgreGuiElement.h.


Constructor & Destructor Documentation

Ogre::GuiElement::GuiElement const String   name
 

Constructor: do not call direct, use GuiManager::createElement.

Definition at line 56 of file OgreGuiElement.cpp.

References Ogre::GHA_LEFT, Ogre::GMM_RELATIVE, Ogre::GVA_TOP, mCloneable, mDerivedOutOfDate, mEnabled, mGeomPositionsOutOfDate, mHeight, mHorzAlign, mLeft, mMetricsMode, Ogre::MouseTarget::mMouseListener, mParent, mPixelHeight, mPixelLeft, mPixelScaleX, mPixelScaleY, mPixelTop, mPixelWidth, mpMaterial, mSourceTemplate, mTop, mVertAlign, mVisible, mWidth, and mZOrder.

Ogre::GuiElement::~GuiElement   [virtual]
 

Definition at line 86 of file OgreGuiElement.cpp.


Member Function Documentation

void Ogre::GuiElement::_getClippingRegion Rectangle   clippingRegion [virtual]
 

Gets the clipping region of the element.

Definition at line 521 of file OgreGuiElement.cpp.

References _updateFromParent(), and mClippingRegion.

Referenced by _updateFromParent().

Real Ogre::GuiElement::_getDerivedLeft void    [virtual]
 

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

Definition at line 503 of file OgreGuiElement.cpp.

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

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

Real Ogre::GuiElement::_getDerivedTop void    [virtual]
 

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

Definition at line 512 of file OgreGuiElement.cpp.

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

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

Real Ogre::GuiElement::_getHeight void    const
 

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
 

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
 

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
 

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::GuiElement::_notifyParent GuiContainer   parent,
Overlay   overlay
[virtual]
 

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

Reimplemented in Ogre::GuiContainer.

Definition at line 495 of file OgreGuiElement.cpp.

References mDerivedOutOfDate, mOverlay, and mParent.

Referenced by Ogre::GuiContainer::addChildImpl().

void Ogre::GuiElement::_notifyViewport   [virtual]
 

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

Reimplemented in Ogre::GuiContainer.

Definition at line 542 of file OgreGuiElement.cpp.

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

Referenced by Ogre::GuiContainer::addChildImpl().

void Ogre::GuiElement::_notifyWorldTransforms const Matrix4   xform [virtual]
 

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

Reimplemented in Ogre::GuiContainer.

Definition at line 536 of file OgreGuiElement.cpp.

References mXForm.

Referenced by Ogre::GuiContainer::addChildImpl().

void Ogre::GuiElement::_notifyZOrder ushort    newZOrder [virtual]
 

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

Remarks:
Overlays have explicit Z orders. GuiElements do not, they inherit the ZOrder of the overlay, and the Zorder is incremented for every container nested within this to ensure that containers are displayed behind contained items. This method is used internally to notify the element of a change in final zorder which is used to render the element.

Reimplemented in Ogre::GuiContainer.

Definition at line 530 of file OgreGuiElement.cpp.

References mZOrder, and Ogre::ushort.

Referenced by Ogre::GuiContainer::addChildImpl().

void Ogre::GuiElement::_positionsOutOfDate void    [virtual]
 

Tell the object to recalculate.

Reimplemented in Ogre::GuiContainer.

Definition at line 357 of file OgreGuiElement.cpp.

References mGeomPositionsOutOfDate.

Referenced by _setDimensions(), _setHeight(), _setLeft(), _setPosition(), _setTop(), _setWidth(), setCaption(), setDimensions(), setHeight(), setHorizontalAlignment(), setLeft(), setMetricsMode(), setPosition(), setTop(), setVerticalAlignment(), and setWidth().

void Ogre::GuiElement::_setDimensions Real    width,
Real    height
 

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 _positionsOutOfDate(), mDerivedOutOfDate, mHeight, mPixelHeight, mPixelScaleX, mPixelScaleY, mPixelWidth, mWidth, and Ogre::Real.

void Ogre::GuiElement::_setHeight Real    height
 

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 _positionsOutOfDate(), mDerivedOutOfDate, mHeight, mPixelHeight, mPixelScaleY, and Ogre::Real.

void Ogre::GuiElement::_setLeft Real    left
 

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 _positionsOutOfDate(), mDerivedOutOfDate, mLeft, mPixelLeft, mPixelScaleX, and Ogre::Real.

void Ogre::GuiElement::_setParent GuiContainer   parent
 

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
 

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 _positionsOutOfDate(), mDerivedOutOfDate, mLeft, mPixelLeft, mPixelScaleX, mPixelScaleY, mPixelTop, mTop, and Ogre::Real.

void Ogre::GuiElement::_setTop Real    top
 

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 _positionsOutOfDate(), mDerivedOutOfDate, mPixelScaleY, mPixelTop, mTop, and Ogre::Real.

void Ogre::GuiElement::_setWidth Real    width
 

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 _positionsOutOfDate(), mDerivedOutOfDate, mPixelScaleX, mPixelWidth, mWidth, and Ogre::Real.

void Ogre::GuiElement::_update void    [virtual]
 

Internal method to update the element based on transforms applied.

Reimplemented in Ogre::GuiContainer, Ogre::BorderPanelGuiElement, Ogre::TextAreaGuiElement, and Ogre::TTYGuiElement.

Definition at line 363 of file OgreGuiElement.cpp.

References _updateFromParent(), Ogre::OverlayManager::getViewportHeight(), Ogre::OverlayManager::getViewportWidth(), Ogre::GMM_PIXELS, Ogre::GMM_RELATIVE_ASPECT_ADJUSTED, mGeomPositionsOutOfDate, mHeight, mLeft, mPixelHeight, mPixelLeft, mPixelScaleX, mPixelScaleY, mPixelTop, mPixelWidth, mTop, mWidth, Ogre::Real, and updatePositionGeometry().

Referenced by Ogre::ListGuiElement::layoutItems().

void Ogre::GuiElement::_updateFromParent void    [virtual]
 

Updates this elements transform based on it's parent.

Definition at line 418 of file OgreGuiElement.cpp.

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

Referenced by _getClippingRegion(), _getDerivedLeft(), _getDerivedTop(), and _update().

void Ogre::GuiElement::_updateRenderQueue RenderQueue   queue [virtual]
 

Internal method to put the contents onto the render queue.

Reimplemented in Ogre::GuiContainer, Ogre::BorderPanelGuiElement, and Ogre::PanelGuiElement.

Definition at line 589 of file OgreGuiElement.cpp.

References Ogre::RenderQueue::addRenderable(), mZOrder, and Ogre::RENDER_QUEUE_OVERLAY.

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::GuiElement::addBaseParameters void    [protected, virtual]
 

Internal method for setting up the basic parameter definitions for a subclass.

Remarks:
Because StringInterface holds a dictionary of parameters per class, subclasses need to call this to ask the base class to add it's parameters to their dictionary as well. Can't do this in the constructor because that runs in a non-virtual context.

The subclass must have called it's own createParamDictionary before calling this method.

Reimplemented in Ogre::BorderButtonGuiElement, Ogre::BorderPanelGuiElement, Ogre::ButtonGuiElement, Ogre::CursorGuiElement, Ogre::ListGuiElement, Ogre::PanelGuiElement, Ogre::PopupMenuGuiElement, Ogre::ScrollBarGuiElement, Ogre::TextAreaGuiElement, Ogre::TextBoxGuiElement, and Ogre::TTYGuiElement.

Definition at line 598 of file OgreGuiElement.cpp.

References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::getParamDictionary(), msCaptionCmd, msHeightCmd, msHorizontalAlignCmd, msLeftCmd, msMaterialCmd, msMetricsModeCmd, msTopCmd, msVerticalAlignCmd, msVisibleCmd, msWidthCmd, Ogre::PT_REAL, and Ogre::PT_STRING.

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

GuiElement * Ogre::GuiElement::clone const String   instanceName [virtual]
 

Reimplemented in Ogre::GuiContainer.

Definition at line 824 of file OgreGuiElement.cpp.

References Ogre::StringInterface::copyParametersTo(), getTypeName(), and mName.

Referenced by Ogre::GuiContainer::clone(), and Ogre::GuiManager::cloneGuiElementFromTemplate().

bool Ogre::GuiElement::contains Real    x,
Real    y
const [virtual]
 

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

Definition at line 759 of file OgreGuiElement.cpp.

References Ogre::Rectangle::inside(), mClippingRegion, and Ogre::Real.

void Ogre::GuiElement::copyFromTemplate GuiElement *    templateGui
 

Reimplemented in Ogre::GuiContainer.

Definition at line 817 of file OgreGuiElement.cpp.

References Ogre::StringInterface::copyParametersTo(), and mSourceTemplate.

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

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(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::D3D9HLSLProgram::D3D9HLSLProgram(), 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::GuiElement::findElementAt Real    x,
Real    y
[virtual]
 

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

Reimplemented in Ogre::GuiContainer, and Ogre::CursorGuiElement.

Definition at line 765 of file OgreGuiElement.cpp.

References Ogre::Real.

Referenced by Ogre::GuiContainer::findElementAt().

const String & Ogre::GuiElement::getCaption void    const [virtual]
 

Gets the caption for this element.

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

Definition at line 650 of file OgreGuiElement.cpp.

References mCaption.

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

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

virtual const PlaneList& Ogre::Renderable::getClipPlanes   const [virtual, inherited]
 

Definition at line 142 of file OgreRenderable.h.

References Ogre::PlaneList.

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

const ColourValue & Ogre::GuiElement::getColour void    const [virtual]
 

Gets the colour for this element.

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

Definition at line 660 of file OgreGuiElement.cpp.

References mColour.

Real Ogre::GuiElement::getHeight void    const
 

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, mHeight, mMetricsMode, mPixelHeight, and Ogre::Real.

Referenced by _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]
 

Gets the horizontal alignment for this element.

Definition at line 740 of file OgreGuiElement.cpp.

References Ogre::GuiHorizontalAlignment, and mHorzAlign.

Real Ogre::GuiElement::getLeft void    const [virtual]
 

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, mLeft, mMetricsMode, mPixelLeft, and Ogre::Real.

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

const LightList& Ogre::GuiElement::getLights void    const [virtual]
 

@copydoc Renderable::getLights

Implements Ogre::Renderable.

Definition at line 463 of file OgreGuiElement.h.

References Ogre::LightList.

Material * Ogre::GuiElement::getMaterial void    const [virtual]
 

See Renderable.

Implements Ogre::Renderable.

Definition at line 326 of file OgreGuiElement.cpp.

References mpMaterial.

const String & Ogre::GuiElement::getMaterialName void    const [virtual]
 

Gets the name of the material this element uses.

Definition at line 306 of file OgreGuiElement.cpp.

References mMaterialName.

GuiMetricsMode Ogre::GuiElement::getMetricsMode void    const [virtual]
 

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

Definition at line 729 of file OgreGuiElement.cpp.

References Ogre::GuiMetricsMode, and mMetricsMode.

const String & Ogre::GuiElement::getName void    const
 

Gets the name of this overlay.

Definition at line 90 of file OgreGuiElement.cpp.

References mName.

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

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

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(), addBaseParameters(), Ogre::CursorGuiElement::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::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(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters void    const [inherited]
 

Retrieves a list of parameters valid for this object.

Returns:
A reference to a static list of ParameterDef objects.

Definition at line 224 of file OgreStringInterface.h.

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

GuiContainer * Ogre::GuiElement::getParent  
 

Returns the parent container.

Definition at line 812 of file OgreGuiElement.cpp.

References mParent.

Referenced by Ogre::GuiManager::destroyAllGuiElementsImpl(), Ogre::ListGuiElement::mouseDragged(), Ogre::PopupMenuGuiElement::setSelectedItem(), and Ogre::ListGuiElement::setSelectedItem().

PositionTarget * Ogre::GuiElement::getPositionTargetParent   [virtual]
 

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

References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID.

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

virtual void Ogre::Renderable::getRenderOperation RenderOperation   op [pure virtual, inherited]
 

Gets the render operation required to send this object to the frame buffer.

Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::Node, Ogre::ShadowRenderable, Ogre::SimpleRenderable, Ogre::SubEntity, Ogre::BorderRenderable, Ogre::PanelGuiElement, Ogre::TextAreaGuiElement, Ogre::TTYGuiElement, Ogre::OctreeNode, and Ogre::TerrainRenderable.

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

const GuiElement* Ogre::GuiElement::getSourceTemplate   const
 

Definition at line 474 of file OgreGuiElement.h.

Real Ogre::GuiElement::getSquaredViewDepth const Camera   cam const [virtual]
 

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

References Ogre::Material::getBestTechnique().

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

Real Ogre::GuiElement::getTop void    const [virtual]
 

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, mMetricsMode, mPixelTop, mTop, and Ogre::Real.

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

virtual const String& Ogre::GuiElement::getTypeName void    const [pure virtual]
 

Gets the type name of the element.

All concrete subclasses must implement this.

Implemented in Ogre::BorderButtonGuiElement, Ogre::BorderPanelGuiElement, Ogre::ButtonGuiElement, Ogre::CursorGuiElement, Ogre::ListGuiElement, Ogre::PanelGuiElement, Ogre::ScrollBarGuiElement, Ogre::TextAreaGuiElement, Ogre::TextBoxGuiElement, and Ogre::TTYGuiElement.

Referenced by clone(), Ogre::GuiContainer::copyFromTemplate(), Ogre::GuiManager::createGuiElementFromTemplate(), Ogre::GuiManager::destroyAllGuiElementsImpl(), and Ogre::OverlayManager::parseChildren().

GuiVerticalAlignment Ogre::GuiElement::getVerticalAlignment void    const [virtual]
 

Gets the vertical alignment for this element.

Definition at line 751 of file OgreGuiElement.cpp.

References Ogre::GuiVerticalAlignment, and mVertAlign.

Real Ogre::GuiElement::getWidth void    const
 

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, mMetricsMode, mPixelWidth, mWidth, and Ogre::Real.

Referenced by _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]
 

@copydoc Renderable::getWorldOrientation

Implements Ogre::Renderable.

Definition at line 336 of file OgreGuiElement.cpp.

References Ogre::Overlay::getWorldOrientation(), and mOverlay.

const Vector3 & Ogre::GuiElement::getWorldPosition void    const [virtual]
 

@copydoc Renderable::getWorldPosition

Implements Ogre::Renderable.

Definition at line 341 of file OgreGuiElement.cpp.

References Ogre::Overlay::getWorldPosition(), and mOverlay.

void Ogre::GuiElement::getWorldTransforms Matrix4   xform const [virtual]
 

See Renderable.

Implements Ogre::Renderable.

Definition at line 331 of file OgreGuiElement.cpp.

References Ogre::Overlay::_getWorldTransforms(), and mOverlay.

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

ushort Ogre::GuiElement::getZOrder   const
 

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::GuiElement::hide void    [virtual]
 

Hides this element if it was visible.

Reimplemented in Ogre::CursorGuiElement.

Definition at line 100 of file OgreGuiElement.cpp.

References mVisible.

Referenced by Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), Ogre::ListGuiElement::layoutItems(), and Ogre::OverlayManager::setCursorGui().

virtual void Ogre::GuiElement::initialise void    [pure virtual]
 

Initialise gui element.

Implemented in Ogre::BorderPanelGuiElement, Ogre::PanelGuiElement, Ogre::TextAreaGuiElement, and Ogre::TTYGuiElement.

Referenced by Ogre::GuiManager::createGuiElementImpl(), and Ogre::OverlayManager::getCursorGui().

virtual bool Ogre::GuiElement::isCloneable   const [virtual]
 

Definition at line 433 of file OgreGuiElement.h.

Referenced by Ogre::GuiContainer::clone(), and Ogre::GuiContainer::copyFromTemplate().

virtual bool Ogre::GuiElement::isContainer   const [virtual]
 

returns false as this class is not a container type

Reimplemented in Ogre::GuiContainer.

Definition at line 427 of file OgreGuiElement.h.

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

bool Ogre::GuiElement::isEnabled   const
 

Definition at line 835 of file OgreGuiElement.cpp.

References mEnabled.

Referenced by Ogre::GuiContainer::findElementAt(), and Ogre::ButtonGuiElement::updateMaterials().

virtual bool Ogre::GuiElement::isKeyEnabled   const [virtual]
 

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

bool Ogre::GuiElement::isVisible void    const
 

Returns whether or not the element is visible.

Definition at line 105 of file OgreGuiElement.cpp.

References mVisible.

Referenced by Ogre::GuiContainer::findElementAt().

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(), processEvent(), and Ogre::GuiControl::processEvent().

void Ogre::GuiElement::processEvent InputEvent   e [virtual]
 

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(), 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 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 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::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]
 

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 _positionsOutOfDate(), and mCaption.

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

virtual void Ogre::GuiElement::setCloneable bool    c [virtual]
 

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]
 

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

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

void Ogre::GuiElement::setDimensions Real    width,
Real    height
 

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 _positionsOutOfDate(), Ogre::GMM_RELATIVE, mDerivedOutOfDate, mHeight, mMetricsMode, mPixelHeight, mPixelWidth, mWidth, and Ogre::Real.

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

void Ogre::GuiElement::setEnabled bool    b [virtual]
 

Definition at line 841 of file OgreGuiElement.cpp.

References mEnabled.

void Ogre::GuiElement::setHeight Real    height
 

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 _positionsOutOfDate(), Ogre::GMM_RELATIVE, mDerivedOutOfDate, mHeight, mMetricsMode, 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(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::Profiler::displayResults(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::PopupMenuGuiElement::layoutItems(), and Ogre::ListGuiElement::setScrollBarName().

void Ogre::GuiElement::setHorizontalAlignment GuiHorizontalAlignment    gha [virtual]
 

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 _positionsOutOfDate(), Ogre::GuiHorizontalAlignment, and mHorzAlign.

void Ogre::GuiElement::setLeft Real    left
 

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 _positionsOutOfDate(), Ogre::GMM_RELATIVE, mDerivedOutOfDate, mLeft, mMetricsMode, 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(), Ogre::CursorGuiElement::mouseMoved(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::CursorGuiElement::setOffsetX(), Ogre::ListGuiElement::setScrollBarName(), Ogre::TextBoxGuiElement::setTextArea(), and Ogre::CursorGuiElement::show().

void Ogre::GuiElement::setMaterialName const String   matName [virtual]
 

Sets the name of the material this element will use.

Remarks:
Different elements will use different materials. One constant about them all though is that a Material used for a GuiElement must have it's depth checking set to 'off', which means it always gets rendered on top. OGRE will set this flag for you if necessary. What it does mean though is that you should not use the same Material for rendering GuiElements as standard scene objects. It's fine to use the same textures, just not the same Material.

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

Definition at line 312 of file OgreGuiElement.cpp.

References Except, Ogre::Material::load(), mMaterialName, mpMaterial, Ogre::Material::setDepthCheckEnabled(), and Ogre::Material::setLightingEnabled().

Referenced by Ogre::Profiler::createContainer(), Ogre::Profiler::createPanel(), Ogre::PopupMenuGuiElement::setSelectedItem(), and Ogre::ListGuiElement::setSelectedItem().

void Ogre::GuiElement::setMetricsMode GuiMetricsMode    gmm [virtual]
 

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 _positionsOutOfDate(), Ogre::OverlayManager::getViewportHeight(), Ogre::OverlayManager::getViewportWidth(), Ogre::GMM_PIXELS, Ogre::GMM_RELATIVE, Ogre::GMM_RELATIVE_ASPECT_ADJUSTED, Ogre::GuiMetricsMode, mDerivedOutOfDate, mHeight, mLeft, mMetricsMode, mPixelHeight, mPixelLeft, mPixelScaleX, mPixelScaleY, mPixelTop, mPixelWidth, mTop, mWidth, and Ogre::Real.

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

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(), and Ogre::StringInterface::getParamDictionary().

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
 

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 _positionsOutOfDate(), Ogre::GMM_RELATIVE, mDerivedOutOfDate, mLeft, mMetricsMode, mPixelLeft, mPixelTop, mTop, and Ogre::Real.

void Ogre::GuiElement::setTop Real    Top
 

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 _positionsOutOfDate(), Ogre::GMM_RELATIVE, mDerivedOutOfDate, mMetricsMode, mPixelTop, 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(), Ogre::CursorGuiElement::mouseMoved(), Ogre::ScrollBarGuiElement::moveScrollBitTo(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::CursorGuiElement::setOffsetY(), Ogre::ListGuiElement::setScrollBarName(), Ogre::TextBoxGuiElement::setTextArea(), Ogre::CursorGuiElement::show(), and Ogre::ScrollBarGuiElement::updateScrollBit().

void Ogre::GuiElement::setVerticalAlignment GuiVerticalAlignment    gva [virtual]
 

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 _positionsOutOfDate(), Ogre::GuiVerticalAlignment, and mVertAlign.

void Ogre::GuiElement::setWidth Real    width
 

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 _positionsOutOfDate(), Ogre::GMM_RELATIVE, mDerivedOutOfDate, mMetricsMode, mPixelWidth, 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(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::Profiler::displayResults(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::TextBoxGuiElement::setBackPanel(), and Ogre::TextAreaGuiElement::updateGeometry().

void Ogre::GuiElement::show void    [virtual]
 

Shows this element if it was hidden.

Reimplemented in Ogre::CursorGuiElement.

Definition at line 95 of file OgreGuiElement.cpp.

References mVisible.

Referenced by Ogre::OverlayManager::createCursorOverlay(), Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), Ogre::Profiler::displayResults(), Ogre::ListGuiElement::layoutItems(), and Ogre::OverlayManager::setCursorGui().

virtual void Ogre::GuiElement::updatePositionGeometry void    [protected, pure virtual]
 

Internal method which is triggered when the positions of the element get updated, meaning the element should be rebuilding it's mesh positions.

Abstract since subclasses must implement this.

Implemented in Ogre::BorderPanelGuiElement, Ogre::PanelGuiElement, Ogre::TextAreaGuiElement, and Ogre::TTYGuiElement.

Referenced by _update().

bool Ogre::GuiElement::useIdentityProjection void    const [virtual]
 

See Renderable.

Reimplemented from Ogre::Renderable.

Definition at line 346 of file OgreGuiElement.cpp.

bool Ogre::GuiElement::useIdentityView void    const [virtual]
 

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]
 

Definition at line 123 of file OgreGuiElement.h.

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

Rectangle Ogre::GuiElement::mClippingRegion [protected]
 

Definition at line 125 of file OgreGuiElement.h.

Referenced by _getClippingRegion(), _updateFromParent(), and contains().

bool Ogre::GuiElement::mCloneable [protected]
 

Definition at line 116 of file OgreGuiElement.h.

Referenced by GuiElement().

ColourValue Ogre::GuiElement::mColour [protected]
 

Definition at line 124 of file OgreGuiElement.h.

Referenced by getColour(), and setColour().

Real Ogre::GuiElement::mDerivedLeft [protected]
 

Definition at line 145 of file OgreGuiElement.h.

Referenced by _getDerivedLeft(), and _updateFromParent().

bool Ogre::GuiElement::mDerivedOutOfDate [protected]
 

Definition at line 147 of file OgreGuiElement.h.

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

Real Ogre::GuiElement::mDerivedTop [protected]
 

Definition at line 146 of file OgreGuiElement.h.

Referenced by _getDerivedTop(), _updateFromParent(), and Ogre::ScrollBarGuiElement::mousePressed().

bool Ogre::GuiElement::mEnabled [protected]
 

Definition at line 160 of file OgreGuiElement.h.

Referenced by GuiElement(), isEnabled(), processEvent(), and setEnabled().

bool Ogre::GuiElement::mGeomPositionsOutOfDate [protected]
 

Falg indicating if the vertex positons need recalculating.

Definition at line 150 of file OgreGuiElement.h.

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

Real Ogre::GuiElement::mHeight [protected]
 

Definition at line 120 of file OgreGuiElement.h.

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

GuiHorizontalAlignment Ogre::GuiElement::mHorzAlign [protected]
 

Definition at line 128 of file OgreGuiElement.h.

Referenced by _updateFromParent(), getHorizontalAlignment(), GuiElement(), and setHorizontalAlignment().

Real Ogre::GuiElement::mLeft [protected]
 

Definition at line 117 of file OgreGuiElement.h.

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

String Ogre::GuiElement::mMaterialName [protected]
 

Definition at line 121 of file OgreGuiElement.h.

Referenced by getMaterialName(), setMaterialName(), Ogre::PopupMenuGuiElement::setSelectedItem(), and Ogre::ListGuiElement::setSelectedItem().

GuiMetricsMode Ogre::GuiElement::mMetricsMode [protected]
 

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(), getHeight(), getLeft(), Ogre::BorderPanelGuiElement::getLeftBorderSize(), getMetricsMode(), Ogre::BorderPanelGuiElement::getRightBorderSize(), Ogre::TTYGuiElement::getSpaceWidth(), Ogre::TextAreaGuiElement::getSpaceWidth(), getTop(), Ogre::BorderPanelGuiElement::getTopBorderSize(), getWidth(), GuiElement(), Ogre::BorderPanelGuiElement::setBorderSize(), Ogre::TTYGuiElement::setCharHeight(), Ogre::TextAreaGuiElement::setCharHeight(), setDimensions(), setHeight(), setLeft(), setMetricsMode(), setPosition(), Ogre::TTYGuiElement::setSpaceWidth(), Ogre::TextAreaGuiElement::setSpaceWidth(), setTop(), 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(), 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]
 

Definition at line 114 of file OgreGuiElement.h.

Referenced by clone(), Ogre::GuiContainer::copyFromTemplate(), Ogre::PopupMenuGuiElement::getListItemName(), Ogre::ListGuiElement::getListItemName(), 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().

Overlay* Ogre::GuiElement::mOverlay [protected]
 

Definition at line 142 of file OgreGuiElement.h.

Referenced by _notifyParent(), Ogre::GuiContainer::addChildImpl(), getWorldOrientation(), getWorldPosition(), and 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]
 

Definition at line 140 of file OgreGuiElement.h.

Referenced by _notifyParent(), _updateFromParent(), getParent(), and GuiElement().

Real Ogre::GuiElement::mPixelHeight [protected]
 

Definition at line 135 of file OgreGuiElement.h.

Referenced by _notifyViewport(), _setDimensions(), _setHeight(), _update(), getHeight(), GuiElement(), setDimensions(), setHeight(), and setMetricsMode().

Real Ogre::GuiElement::mPixelLeft [protected]
 

Definition at line 133 of file OgreGuiElement.h.

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

Real Ogre::GuiElement::mPixelScaleX [protected]
 

Definition at line 136 of file OgreGuiElement.h.

Referenced by _notifyViewport(), _setDimensions(), _setLeft(), _setPosition(), _setWidth(), _update(), Ogre::BorderPanelGuiElement::_update(), GuiElement(), and setMetricsMode().

Real Ogre::GuiElement::mPixelScaleY [protected]
 

Definition at line 137 of file OgreGuiElement.h.

Referenced by _notifyViewport(), _setDimensions(), _setHeight(), _setPosition(), _setTop(), _update(), Ogre::BorderPanelGuiElement::_update(), GuiElement(), and setMetricsMode().

Real Ogre::GuiElement::mPixelTop [protected]
 

Definition at line 132 of file OgreGuiElement.h.

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

Real Ogre::GuiElement::mPixelWidth [protected]
 

Definition at line 134 of file OgreGuiElement.h.

Referenced by _notifyViewport(), _setDimensions(), _setWidth(), _update(), getWidth(), GuiElement(), setDimensions(), setMetricsMode(), and setWidth().

Material* Ogre::GuiElement::mpMaterial [protected]
 

Definition at line 122 of file OgreGuiElement.h.

Referenced by Ogre::PanelGuiElement::_updateRenderQueue(), getMaterial(), GuiElement(), Ogre::TTYGuiElement::setFontName(), Ogre::TextAreaGuiElement::setFontName(), setMaterialName(), and Ogre::PanelGuiElement::updateTextureGeometry().

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

Definition at line 50 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Dictionary of parameters.

Definition at line 30 of file OgreStringInterface.cpp.

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

Definition at line 48 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Definition at line 52 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Definition at line 45 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Definition at line 49 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Definition at line 51 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

GuiElement* Ogre::GuiElement::mSourceTemplate [protected]
 

Definition at line 163 of file OgreGuiElement.h.

Referenced by copyFromTemplate(), and GuiElement().

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

Definition at line 46 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Definition at line 53 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Definition at line 54 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

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

Definition at line 47 of file OgreGuiElement.cpp.

Referenced by addBaseParameters().

Real Ogre::GuiElement::mTop [protected]
 

Definition at line 118 of file OgreGuiElement.h.

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

GuiVerticalAlignment Ogre::GuiElement::mVertAlign [protected]
 

Definition at line 129 of file OgreGuiElement.h.

Referenced by _updateFromParent(), getVerticalAlignment(), GuiElement(), and setVerticalAlignment().

bool Ogre::GuiElement::mVisible [protected]
 

Definition at line 115 of file OgreGuiElement.h.

Referenced by Ogre::CursorGuiElement::CursorGuiElement(), GuiElement(), hide(), isVisible(), show(), and Ogre::CursorGuiElement::show().

Real Ogre::GuiElement::mWidth [protected]
 

Definition at line 119 of file OgreGuiElement.h.

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

Matrix4 Ogre::GuiElement::mXForm [protected]
 

Definition at line 157 of file OgreGuiElement.h.

Referenced by _notifyWorldTransforms(), and Ogre::GuiContainer::addChildImpl().

ushort Ogre::GuiElement::mZOrder [protected]
 

Definition at line 154 of file OgreGuiElement.h.

Referenced by _notifyZOrder(), _updateRenderQueue(), Ogre::BorderPanelGuiElement::_updateRenderQueue(), Ogre::GuiContainer::addChildImpl(), and GuiElement().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:26:15 2004