---

Ogre::TTYGuiElement Class Reference

GuiElement representing a TTY style text area. More...

#include <OgreTTYGuiElement.h>

Inheritance diagram for Ogre::TTYGuiElement:

[legend]Collaboration diagram for Ogre::TTYGuiElement:

[legend]List of all members.

Public Methods
	TTYGuiElement (const String &name)
	Constructor.
	~TTYGuiElement ()
void	initialise (void)
	Initialise.
void	setCaption (const String &caption)
	Appends specified text to end of screen buffer.
const String &	getCaption () const
	Gets the caption for this element.
virtual void	appendText (const String &text)
	Appends specified text to end of screen buffer.
virtual void	appendText (const ColourValue &colour, const String &text)
	Appends specified text to end of screen buffer.
virtual void	appendText (const ColourValue &tColour, const ColourValue &bColour, const String &text)
	Appends specified text to end of screen buffer.
virtual void	appendText (const RGBA &tColour, const RGBA &bColour, const String &text)
	Appends specified text to end of screen buffer.
virtual void	clearText ()
virtual void	setScrollBar (ScrollBarGuiElement *scrollBar)
virtual ScrollBarGuiElement *	getScrollBar () const
virtual void	setTextLimit (uint maxChars)
virtual uint	getTextLimit () const
virtual void	setCharHeight (Real height)
virtual Real	getCharHeight () const
virtual void	setSpaceWidth (Real width)
virtual Real	getSpaceWidth () const
virtual void	setFontName (const String &font)
virtual const String &	getFontName () const
virtual const String &	getTypeName (void) const
	See GuiElement.
void	getRenderOperation (RenderOperation &op)
	See Renderable.
void	setMaterialName (const String &matName)
	Overridden from GuiElement.
virtual void	setColour (const ColourValue &col)
	Sets the colour of the text.
virtual const ColourValue &	getColour (void) const
	Gets the colour of the text.
virtual void	setColourBottom (const ColourValue &col)
	Sets the colour of the bottom of the letters.
virtual const ColourValue &	getColourBottom (void) const
	Gets the colour of the bottom of the letters.
virtual void	setColourTop (const ColourValue &col)
	Sets the colour of the top of the letters.
virtual const ColourValue &	getColourTop (void) const
	Gets the colour of the top of the letters.
void	setMetricsMode (GuiMetricsMode gmm)
	Overridden from GuiElement.
void	_update (void)
	Overridden from GuiElement.
const String &	getName (void) const
	Gets the name of this overlay.
virtual void	show (void)
	Shows this element if it was hidden.
virtual void	hide (void)
	Hides this element if it was visible.
bool	isVisible (void) const
	Returns whether or not the element is visible.
bool	isEnabled () const
virtual void	setEnabled (bool b)
void	setDimensions (Real width, Real height)
	Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).
void	setPosition (Real left, Real top)
	Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height).
void	setWidth (Real width)
	Sets the width of this element in relation to the screen (where 1.0 = screen width).
Real	getWidth (void) const
	Gets the width of this element in relation to the screen (where 1.0 = screen width).
void	setHeight (Real height)
	Sets the height of this element in relation to the screen (where 1.0 = screen height).
Real	getHeight (void) const
	Gets the height of this element in relation to the screen (where 1.0 = screen height).
void	setLeft (Real left)
	Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Real	getLeft (void) const
	Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
void	setTop (Real Top)
	Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
Real	getTop (void) const
	Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
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	_positionsOutOfDate (void)
	Tell the object to recalculate.
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	_notifyZOrder (ushort newZOrder)
	Internal method to notify the element when Zorder of parent overlay has changed.
virtual void	_updateRenderQueue (RenderQueue *queue)
	Internal method to put the contents onto the render queue.
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)
PositionTarget *	getPositionTargetParent ()
	Returns the parent container.
GuiContainer *	getParent ()
	Returns the parent container.
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
void	copyFromTemplate (GuiElement *templateGui)
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.
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 Types
typedef std::deque< TextBlock >	TextBlockQueue
Protected Methods
void	addBaseParameters (void)
	Method for setting up base parameters for this class.
void	checkAndSetUpdateGeometry ()
	Internal methods to update geometry.
void	pruneText ()
void	updateScrollBar ()
void	updateTextGeometry (TextBlock &text, Real lineWidth=0.0)
void	updateTextGeometry ()
void	updateWindowGeometry ()
void	checkMemoryAllocation (uint numChar)
	Internal method to allocate memory, only reallocates when necessary.
virtual void	scrollPerformed (ScrollEvent *e)
	Inherited function.
virtual void	updatePositionGeometry ()
	Internal method which is triggered when the positions of the element get updated, meaning the element should be rebuilding it's mesh positions.
bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
Protected Attributes
RenderOperation	mRenderOp
	Render operation.
Font *	mpFont
Real	mCharHeight
ushort	mPixelCharHeight
Real	mSpaceWidth
ushort	mPixelSpaceWidth
uint	mAllocSize
ColourValue	mColourBottom
	Colours to use for the vertices.
ColourValue	mColourTop
RGBA	mTopColour
RGBA	mBottomColour
uint	mScrLines
bool	mUpdateGeometry
bool	mUpdateGeometryNotVisible
TextBlockQueue	mTextBlockQueue
uint	mTtlChars
uint	mMaxChars
uint	mTtlFaces
uint	mTtlLines
uint	mTopLine
bool	mAutoScroll
ScrollBarGuiElement *	mScrollBar
String	mName
bool	mVisible
bool	mCloneable
Real	mLeft
Real	mTop
Real	mWidth
Real	mHeight
String	mMaterialName
Material *	mpMaterial
String	mCaption
ColourValue	mColour
GuiMetricsMode	mMetricsMode
GuiHorizontalAlignment	mHorzAlign
GuiVerticalAlignment	mVertAlign
short	mPixelTop
short	mPixelLeft
short	mPixelWidth
short	mPixelHeight
GuiContainer *	mParent
Overlay *	mOverlay
Real	mDerivedLeft
Real	mDerivedTop
bool	mDerivedOutOfDate
bool	mGeomPositionsOutOfDate
	Falg indicating if the vertex positons need recalculating.
ushort	mZOrder
bool	mEnabled
String	mParamDictName
	Class name for this instance to be used as a lookup (must be initialised by subclasses).
MouseListener *	mMouseListener
bool	mMouseWithin
MouseMotionListener *	mMouseMotionListener
ActionListener *	mActionListener
Static Protected Attributes
String	msTypeName = "TTY"
CmdCharHeight	msCmdCharHeight
CmdSpaceWidth	msCmdSpaceWidth
CmdFontName	msCmdFontName
CmdColour	msCmdColour
CmdColourTop	msCmdColourTop
CmdColourBottom	msCmdColourBottom
CmdTextLimit	msCmdTextLimit
CmdScrollBar	msCmdScrollBar
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.
Private Methods
virtual bool	isMulticaster () const
	Returns whether or not the listener is a multicaster.

---

Detailed Description

GuiElement representing a TTY style text area.

Remarks:

This class subclasses GuiElement and provides a TTY style interface for displaying textual data. Text will wrap when it exceeds the window width and scroll when the window height is exceeded. In addition, each block of text can have it's own colour associated with it.

The setCaption method is depreciated in this class.

Definition at line 50 of file OgreTTYGuiElement.h.

---

Member Typedef Documentation

typedef std::deque<TextBlock> Ogre::TTYGuiElement::TextBlockQueue [protected]

Definition at line 260 of file OgreTTYGuiElement.h.

---

Constructor & Destructor Documentation

Ogre::TTYGuiElement::TTYGuiElement (  const String &    name )

Constructor. Definition at line 52 of file OgreTTYGuiElement.cpp. References addBaseParameters(), Ogre::StringInterface::createParamDictionary(), mAllocSize, mAutoScroll, mBottomColour, mCharHeight, mColourBottom, mColourTop, Ogre::GuiElement::mHeight, mMaxChars, mpFont, mPixelCharHeight, mPixelSpaceWidth, mScrLines, mScrollBar, mSpaceWidth, mTopColour, mTopLine, mTtlChars, mTtlFaces, mTtlLines, mUpdateGeometry, and mUpdateGeometryNotVisible.

Ogre::TTYGuiElement::~TTYGuiElement (    )

Definition at line 650 of file OgreTTYGuiElement.cpp. References mRenderOp, and Ogre::RenderOperation::vertexData.

---

Member Function Documentation

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

Gets the 'left' position as derived from own left and that of parents. Definition at line 387 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 updateWindowGeometry().

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

Gets the 'top' position as derived from own left and that of parents. Definition at line 396 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 updateWindowGeometry().

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

Internal method for notifying the gui element of it's parent and ultimate overlay. Reimplemented in Ogre::GuiContainer. Definition at line 379 of file OgreGuiElement.cpp. References Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mOverlay, and Ogre::GuiElement::mParent. Referenced by Ogre::GuiContainer::addChildImpl().

void Ogre::GuiElement::_notifyZOrder (  ushort    newZOrder )  [virtual, inherited]

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 405 of file OgreGuiElement.cpp. References Ogre::GuiElement::mZOrder, and Ogre::ushort. Referenced by Ogre::GuiContainer::addChildImpl().

void Ogre::GuiElement::_positionsOutOfDate (  void    )  [virtual, inherited]

Tell the object to recalculate. Reimplemented in Ogre::GuiContainer. Definition at line 289 of file OgreGuiElement.cpp. References Ogre::GuiElement::mGeomPositionsOutOfDate. Referenced by Ogre::GuiElement::setCaption(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), Ogre::GuiElement::setHorizontalAlignment(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setPosition(), Ogre::GuiElement::setTop(), Ogre::GuiElement::setVerticalAlignment(), and Ogre::GuiElement::setWidth().

void Ogre::TTYGuiElement::_update (  void    )  [virtual]

Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 763 of file OgreTTYGuiElement.cpp. References Ogre::GMM_PIXELS, mCharHeight, Ogre::GuiElement::mGeomPositionsOutOfDate, Ogre::GuiElement::mMetricsMode, mPixelCharHeight, mPixelSpaceWidth, mSpaceWidth, Ogre::Real, updateScrollBar(), and updateWindowGeometry().

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

Updates this elements transform based on it's parent. Definition at line 323 of file OgreGuiElement.cpp. References Ogre::GuiElement::_getDerivedLeft(), Ogre::GuiElement::_getDerivedTop(), 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::GuiElement::mDerivedLeft, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mDerivedTop, Ogre::GuiElement::mHorzAlign, Ogre::GuiElement::mLeft, Ogre::GuiElement::mParent, Ogre::GuiElement::mTop, Ogre::GuiElement::mVertAlign, and Ogre::Real. Referenced by Ogre::GuiElement::_getDerivedLeft(), Ogre::GuiElement::_getDerivedTop(), and Ogre::GuiElement::_update().

void Ogre::GuiElement::_updateRenderQueue (  RenderQueue *    queue )  [virtual, inherited]

Internal method to put the contents onto the render queue. Reimplemented in Ogre::GuiContainer, Ogre::BorderPanelGuiElement, and Ogre::PanelGuiElement. Definition at line 410 of file OgreGuiElement.cpp. References Ogre::RenderQueue::addRenderable(), Ogre::GuiElement::mZOrder, and Ogre::RENDER_QUEUE_OVERLAY.

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

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

void Ogre::TTYGuiElement::addBaseParameters (  void    )  [protected, virtual]

Method for setting up base parameters for this class. Reimplemented from Ogre::GuiElement. Definition at line 671 of file OgreTTYGuiElement.cpp. References Ogre::ParamDictionary::addParameter(), Ogre::StringInterface::getParamDictionary(), msCmdCharHeight, msCmdColour, msCmdColourBottom, msCmdColourTop, msCmdFontName, msCmdScrollBar, msCmdSpaceWidth, msCmdTextLimit, Ogre::PT_REAL, and Ogre::PT_STRING. Referenced by TTYGuiElement().

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

Definition at line 86 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 65 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::TTYGuiElement::appendText (  const RGBA &    tColour, const RGBA &    bColour, const String &    text )  [virtual]

Appends specified text to end of screen buffer. Remarks: This method is used to append text to the end of the screen buffer using the specified colors. Definition at line 135 of file OgreTTYGuiElement.cpp. References mAutoScroll, mScrLines, mTextBlockQueue, mTopLine, mTtlChars, mTtlFaces, mTtlLines, pruneText(), Ogre::RGBA, updateScrollBar(), updateTextGeometry(), and updateWindowGeometry().

void Ogre::TTYGuiElement::appendText (  const ColourValue &    tColour, const ColourValue &    bColour, const String &    text )  [virtual]

Appends specified text to end of screen buffer. Remarks: This method is used to append text to the end of the screen buffer using the specified colors. Definition at line 125 of file OgreTTYGuiElement.cpp. References appendText(), and Ogre::RGBA.

void Ogre::TTYGuiElement::appendText (  const ColourValue &    colour, const String &    text )  [virtual]

Appends specified text to end of screen buffer. Remarks: This method is used to append text to the end of the screen buffer using the specified color for both the top and bottom colors. Definition at line 116 of file OgreTTYGuiElement.cpp. References appendText(), and Ogre::RGBA.

virtual void Ogre::TTYGuiElement::appendText (  const String &    text )  [virtual]

Appends specified text to end of screen buffer. Remarks: This method is used to append text to the end of the screen buffer using the default colours. Definition at line 73 of file OgreTTYGuiElement.h. Referenced by appendText(), and setCaption().

void Ogre::TTYGuiElement::checkAndSetUpdateGeometry (    )  [protected]

Internal methods to update geometry. Definition at line 256 of file OgreTTYGuiElement.cpp. References mCharHeight, Ogre::GuiElement::mHeight, mpFont, mRenderOp, mUpdateGeometry, Ogre::GuiElement::mWidth, Ogre::VertexData::vertexCount, Ogre::RenderOperation::vertexData, and Ogre::VertexData::vertexStart. Referenced by setFontName(), and updatePositionGeometry().

void Ogre::TTYGuiElement::checkMemoryAllocation (  uint    numChar )  [protected]

Internal method to allocate memory, only reallocates when necessary. Definition at line 219 of file OgreTTYGuiElement.cpp. References COLOUR_BINDING, Ogre::VertexDeclaration::getVertexSize(), mAllocSize, mRenderOp, POS_TEX_BINDING, Ogre::VertexBufferBinding::setBinding(), Ogre::uint, Ogre::VertexData::vertexBufferBinding, Ogre::VertexData::vertexCount, Ogre::RenderOperation::vertexData, and Ogre::VertexData::vertexDeclaration. Referenced by initialise(), and updateWindowGeometry().

void Ogre::TTYGuiElement::clearText (    )  [virtual]

Definition at line 163 of file OgreTTYGuiElement.cpp. References mAutoScroll, mTextBlockQueue, mTopLine, mTtlChars, mTtlFaces, mTtlLines, updateScrollBar(), and updateWindowGeometry().

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 532 of file OgreGuiElement.cpp. References Ogre::GuiElement::mDerivedLeft, Ogre::GuiElement::mDerivedTop, Ogre::GuiElement::mHeight, and Ogre::Real.

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

Reimplemented in Ogre::GuiContainer. Definition at line 590 of file OgreGuiElement.cpp. References Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::copyParametersTo (  StringInterface *    dest )  const [virtual, inherited]

Method for copying this object's parameters to another object. Remarks: This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. Any unrecognised parameters will be ignored as with setParameter method. Parameters: dest  Pointer to object to have it's parameters set the same as this object. Definition at line 293 of file OgreStringInterface.h. References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter(). Referenced by 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. Referenced by 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 TTYGuiElement().

GuiElement * Ogre::GuiElement::findElementAt (  Real    x, Real    y )  [virtual, inherited]

Returns true if xy is within the constraints of the component. Reimplemented in Ogre::GuiContainer, and Ogre::CursorGuiElement. Definition at line 538 of file OgreGuiElement.cpp. References Ogre::Real. Referenced by Ogre::GuiContainer::findElementAt().

const String & Ogre::TTYGuiElement::getCaption (    )  const [virtual]

Gets the caption for this element. Reimplemented from Ogre::GuiElement. Definition at line 572 of file OgreTTYGuiElement.cpp. References Ogre::GuiElement::mCaption.

Real Ogre::TTYGuiElement::getCharHeight (    )  const [virtual]

Definition at line 611 of file OgreTTYGuiElement.cpp. References Ogre::GMM_PIXELS, mCharHeight, Ogre::GuiElement::mMetricsMode, mPixelCharHeight, and Ogre::Real. Referenced by Ogre::TTYGuiElement::CmdCharHeight::doGet().

const ColourValue & Ogre::TTYGuiElement::getColour (  void    )  const [virtual]

Gets the colour of the text. Reimplemented from Ogre::GuiElement. Definition at line 725 of file OgreTTYGuiElement.cpp. References mColourTop. Referenced by Ogre::TTYGuiElement::CmdColour::doGet().

const ColourValue & Ogre::TTYGuiElement::getColourBottom (  void    )  const [virtual]

Gets the colour of the bottom of the letters. Definition at line 737 of file OgreTTYGuiElement.cpp. References mColourBottom. Referenced by Ogre::TTYGuiElement::CmdColourBottom::doGet().

const ColourValue & Ogre::TTYGuiElement::getColourTop (  void    )  const [virtual]

Gets the colour of the top of the letters. Definition at line 748 of file OgreTTYGuiElement.cpp. References mColourTop. Referenced by Ogre::TTYGuiElement::CmdColourTop::doGet().

const String & Ogre::TTYGuiElement::getFontName (    )  const [virtual]

Definition at line 593 of file OgreTTYGuiElement.cpp. References Ogre::Resource::getName(), and mpFont.

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 173 of file OgreGuiElement.cpp. References Ogre::GMM_PIXELS, 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::mousePressed(), 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 513 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 199 of file OgreGuiElement.cpp. References Ogre::GMM_PIXELS, 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 419 of file OgreGuiElement.h. References Ogre::LightList.

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

See Renderable. Implements Ogre::Renderable. Definition at line 258 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 238 of file OgreGuiElement.cpp. References Ogre::GuiElement::mMaterialName.

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

Retrieves the current settings of how the element metrics are interpreted. Definition at line 502 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 82 of file OgreGuiElement.cpp. References Ogre::GuiElement::mName. Referenced by Ogre::ScrollBarGuiElement::actionPerformed(), Ogre::GuiContainer::addChildImpl(), Ogre::GuiContainer::copyFromTemplate(), 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 132 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 98 of file OgreRenderable.h. Referenced by 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 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(), Ogre::CursorGuiElement::addBaseParameters(), Ogre::ButtonGuiElement::addBaseParameters(), Ogre::BorderPanelGuiElement::addBaseParameters(), Ogre::BorderButtonGuiElement::addBaseParameters(), 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 (    )  [inherited]

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

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

Returns the parent container. Implements Ogre::PositionTarget. Definition at line 580 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 129 of file OgreRenderable.h. References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID. Referenced by Ogre::SceneManager::renderSingleObject().

void Ogre::TTYGuiElement::getRenderOperation (  RenderOperation &    op )  [virtual]

See Renderable. Implements Ogre::Renderable. Definition at line 660 of file OgreTTYGuiElement.cpp. References mRenderOp.

virtual ScrollBarGuiElement* Ogre::TTYGuiElement::getScrollBar (    )  const [virtual]

Definition at line 96 of file OgreTTYGuiElement.h.

Real Ogre::TTYGuiElement::getSpaceWidth (    )  const [virtual]

Definition at line 637 of file OgreTTYGuiElement.cpp. References Ogre::GMM_PIXELS, Ogre::GuiElement::mMetricsMode, mPixelSpaceWidth, mSpaceWidth, and Ogre::Real. Referenced by Ogre::TTYGuiElement::CmdSpaceWidth::doGet().

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

Overridden from Renderable. Implements Ogre::Renderable. Definition at line 413 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 63 of file OgreRenderable.h. References Ogre::Material::getBestTechnique(). Referenced by Ogre::RenderPriorityGroup::addRenderable().

virtual uint Ogre::TTYGuiElement::getTextLimit (    )  const [virtual]

Definition at line 99 of file OgreTTYGuiElement.h. References Ogre::uint. Referenced by Ogre::TTYGuiElement::CmdTextLimit::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 226 of file OgreGuiElement.cpp. References Ogre::GMM_PIXELS, 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::TTYGuiElement::getTypeName (  void    )  const [virtual]

See GuiElement. Implements Ogre::GuiElement. Definition at line 655 of file OgreTTYGuiElement.cpp. References msTypeName.

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

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

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 148 of file OgreGuiElement.cpp. References Ogre::GMM_PIXELS, 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::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 268 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 273 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 263 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 409 of file OgreGuiElement.h. References Ogre::ushort. Referenced by Ogre::GuiContainer::addChildImpl(), Ogre::Overlay::findElementAt(), and Ogre::GuiContainer::findElementAt().

void Ogre::GuiElement::hide (  void    )  [virtual, inherited]

Hides this element if it was visible. Reimplemented in Ogre::CursorGuiElement. Definition at line 92 of file OgreGuiElement.cpp. References Ogre::GuiElement::mVisible. Referenced by Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), Ogre::ListGuiElement::layoutItems(), and Ogre::OverlayManager::setCursorGui().

void Ogre::TTYGuiElement::initialise (  void    )  [virtual]

Initialise. Implements Ogre::GuiElement. Definition at line 88 of file OgreTTYGuiElement.cpp. References Ogre::VertexDeclaration::addElement(), checkMemoryAllocation(), COLOUR_BINDING, DEFAULT_INITIAL_CHARS, mRenderOp, Ogre::RenderOperation::operationType, POS_TEX_BINDING, Ogre::RenderOperation::useIndexes, Ogre::RenderOperation::vertexData, Ogre::VertexData::vertexDeclaration, Ogre::VertexData::vertexStart, Ogre::VES_DIFFUSE, Ogre::VES_POSITION, Ogre::VES_TEXTURE_COORDINATES, Ogre::VET_COLOUR, Ogre::VET_FLOAT2, and Ogre::VET_FLOAT3.

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

Definition at line 390 of file OgreGuiElement.h. Referenced by Ogre::GuiContainer::copyFromTemplate().

virtual bool Ogre::GuiElement::isContainer (    )  const [virtual, inherited]

returns false as this class is not a container type Reimplemented in Ogre::GuiContainer. Definition at line 384 of file OgreGuiElement.h. Referenced by Ogre::GuiContainer::addChild(), and Ogre::GuiContainer::copyFromTemplate().

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

Definition at line 597 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 387 of file OgreGuiElement.h.

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

Definition at line 105 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::GuiElement::isVisible (  void    )  const [inherited]

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

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

Definition at line 45 of file OgreActionTarget.cpp. References Ogre::ActionListener::actionPerformed(), Ogre::InputEvent::getID(), and Ogre::ActionTarget::mActionListener. Referenced by 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 549 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 46 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 44 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::TTYGuiElement::pruneText (    )  [protected]

Definition at line 272 of file OgreTTYGuiElement.cpp. References mMaxChars, mTextBlockQueue, mTtlChars, mTtlFaces, and mTtlLines. Referenced by appendText(), setTextLimit(), and updateTextGeometry().

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

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

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

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

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

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

void Ogre::TTYGuiElement::scrollPerformed (  ScrollEvent *    e )  [protected, virtual]

Inherited function. Implements Ogre::ScrollListener. Definition at line 210 of file OgreTTYGuiElement.cpp. References Ogre::ScrollEvent::getTopVisible(), mTopLine, and updateWindowGeometry().

void Ogre::TTYGuiElement::setCaption (  const String &    caption )  [virtual]

Appends specified text to end of screen buffer. Remarks: Depreciated, this setCaption method equivalent to calling clearText and appendText. Reimplemented from Ogre::GuiElement. Definition at line 560 of file OgreTTYGuiElement.cpp. References appendText(), mAutoScroll, mTextBlockQueue, mTopLine, mTtlChars, mTtlFaces, and mTtlLines.

void Ogre::TTYGuiElement::setCharHeight (  Real    height )  [virtual]

Definition at line 598 of file OgreTTYGuiElement.cpp. References Ogre::GMM_PIXELS, mCharHeight, Ogre::GuiElement::mGeomPositionsOutOfDate, Ogre::GuiElement::mMetricsMode, mPixelCharHeight, and Ogre::Real.

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

Definition at line 393 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::TTYGuiElement::setColour (  const ColourValue &    col )  [virtual]

Sets the colour of the text. Remarks: This method establishes a constant colour for the entire text. Also see setColourBottom and setColourTop which allow you to set a colour gradient. Reimplemented from Ogre::GuiElement. Definition at line 717 of file OgreTTYGuiElement.cpp. References mBottomColour, mColourBottom, mColourTop, and mTopColour.

void Ogre::TTYGuiElement::setColourBottom (  const ColourValue &    col )  [virtual]

Sets the colour of the bottom of the letters. Remarks: By setting a separate top and bottom colour, you can create a text area which has a graduated colour effect to it. Definition at line 731 of file OgreTTYGuiElement.cpp. References mBottomColour, and mColourBottom.

void Ogre::TTYGuiElement::setColourTop (  const ColourValue &    col )  [virtual]

Sets the colour of the top of the letters. Remarks: By setting a separate top and bottom colour, you can create a text area which has a graduated colour effect to it. Definition at line 742 of file OgreTTYGuiElement.cpp. References mColourTop, and mTopColour.

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 102 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_PIXELS, 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 603 of file OgreGuiElement.cpp. References Ogre::GuiElement::mEnabled.

void Ogre::TTYGuiElement::setFontName (  const String &    font )  [virtual]

Definition at line 577 of file OgreTTYGuiElement.cpp. References checkAndSetUpdateGeometry(), Ogre::Font::getGlyphAspectRatio(), Ogre::Font::getMaterial(), Ogre::Font::load(), mCharHeight, mpFont, Ogre::GuiElement::mpMaterial, mSpaceWidth, Ogre::Material::setDepthCheckEnabled(), Ogre::Material::setLightingEnabled(), updateScrollBar(), updateTextGeometry(), and updateWindowGeometry().

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 160 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_PIXELS, 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(), Ogre::CursorGuiElement::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 507 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 185 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_PIXELS, 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(), Ogre::CursorGuiElement::mouseMoved(), Ogre::TextBoxGuiElement::setBackPanel(), Ogre::CursorGuiElement::setOffsetX(), Ogre::ListGuiElement::setScrollBarName(), Ogre::TextBoxGuiElement::setTextArea(), and Ogre::CursorGuiElement::show().

void Ogre::TTYGuiElement::setMaterialName (  const String &    matName )  [virtual]

Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 665 of file OgreTTYGuiElement.cpp. References updateWindowGeometry().

void Ogre::TTYGuiElement::setMetricsMode (  GuiMetricsMode    gmm )  [virtual]

Overridden from GuiElement. Reimplemented from Ogre::GuiElement. Definition at line 753 of file OgreTTYGuiElement.cpp. References Ogre::GMM_PIXELS, Ogre::GuiMetricsMode, mCharHeight, mPixelCharHeight, mPixelSpaceWidth, and mSpaceWidth.

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 )  [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 118 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_PIXELS, Ogre::GuiElement::mDerivedOutOfDate, Ogre::GuiElement::mLeft, Ogre::GuiElement::mMetricsMode, Ogre::GuiElement::mPixelLeft, Ogre::GuiElement::mPixelTop, Ogre::GuiElement::mTop, and Ogre::Real.

void Ogre::TTYGuiElement::setScrollBar (  ScrollBarGuiElement *    scrollBar )  [virtual]

Definition at line 191 of file OgreTTYGuiElement.cpp. References Ogre::ScrollTarget::addScrollListener(), mScrollBar, Ogre::ScrollTarget::removeScrollListener(), and updateScrollBar().

void Ogre::TTYGuiElement::setSpaceWidth (  Real    width )  [virtual]

Definition at line 623 of file OgreTTYGuiElement.cpp. References Ogre::GMM_PIXELS, Ogre::GuiElement::mGeomPositionsOutOfDate, Ogre::GuiElement::mMetricsMode, mPixelSpaceWidth, mSpaceWidth, and Ogre::Real.

void Ogre::TTYGuiElement::setTextLimit (  uint    maxChars )  [virtual]

Definition at line 179 of file OgreTTYGuiElement.cpp. References mMaxChars, pruneText(), Ogre::uint, updateScrollBar(), and updateWindowGeometry().

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 211 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_PIXELS, 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(), 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, 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 518 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 135 of file OgreGuiElement.cpp. References Ogre::GuiElement::_positionsOutOfDate(), Ogre::GMM_PIXELS, 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(), Ogre::CursorGuiElement::CursorGuiElement(), Ogre::Profiler::displayResults(), Ogre::ScrollBarGuiElement::layoutItems(), Ogre::TextBoxGuiElement::setBackPanel(), and Ogre::TextAreaGuiElement::updateGeometry().

void Ogre::GuiElement::show (  void    )  [virtual, inherited]

Shows this element if it was hidden. Reimplemented in Ogre::CursorGuiElement. Definition at line 87 of file OgreGuiElement.cpp. References Ogre::GuiElement::mVisible. Referenced by Ogre::OverlayManager::createCursorOverlay(), Ogre::Profiler::createPanel(), Ogre::Profiler::createTextArea(), Ogre::Profiler::displayResults(), Ogre::ListGuiElement::layoutItems(), and Ogre::OverlayManager::setCursorGui().

void Ogre::TTYGuiElement::updatePositionGeometry (    )  [protected, 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. Implements Ogre::GuiElement. Definition at line 547 of file OgreTTYGuiElement.cpp. References checkAndSetUpdateGeometry(), mCharHeight, Ogre::GuiElement::mHeight, mScrLines, updateScrollBar(), updateTextGeometry(), and updateWindowGeometry().

void Ogre::TTYGuiElement::updateScrollBar (    )  [protected]

Definition at line 286 of file OgreTTYGuiElement.cpp. References mScrLines, mScrollBar, mTopLine, mTtlLines, mUpdateGeometry, and Ogre::ScrollBarGuiElement::setLimits(). Referenced by _update(), appendText(), clearText(), setFontName(), setScrollBar(), setTextLimit(), and updatePositionGeometry().

void Ogre::TTYGuiElement::updateTextGeometry (    )  [protected]

Definition at line 343 of file OgreTTYGuiElement.cpp. References mAutoScroll, mScrLines, mTextBlockQueue, mTopLine, mTtlChars, mTtlFaces, mTtlLines, mUpdateGeometry, pruneText(), and Ogre::Real. Referenced by appendText(), setFontName(), and updatePositionGeometry().

void Ogre::TTYGuiElement::updateTextGeometry (  TextBlock &    text, Real    lineWidth = 0.0 )  [protected]

Definition at line 293 of file OgreTTYGuiElement.cpp. References Ogre::TTYGuiElement::TextBlock::begin, Ogre::TTYGuiElement::TextBlock::cntFaces, Ogre::TTYGuiElement::TextBlock::cntLines, Ogre::TTYGuiElement::TextBlock::end, Ogre::Font::getGlyphAspectRatio(), mCharHeight, mpFont, mSpaceWidth, mUpdateGeometry, Ogre::GuiElement::mWidth, Ogre::Real, Ogre::TTYGuiElement::TextBlock::text, and Ogre::uint.

void Ogre::TTYGuiElement::updateWindowGeometry (    )  [protected]

Definition at line 379 of file OgreTTYGuiElement.cpp. References Ogre::GuiElement::_getDerivedLeft(), Ogre::GuiElement::_getDerivedTop(), checkMemoryAllocation(), COLOUR_BINDING, Ogre::VertexBufferBinding::getBuffer(), Ogre::Font::getGlyphAspectRatio(), Ogre::Font::getGlyphTexCoords(), mCharHeight, mpFont, mRenderOp, mScrLines, mSpaceWidth, mTextBlockQueue, mTopLine, mTtlChars, mUpdateGeometry, Ogre::GuiElement::mWidth, POS_TEX_BINDING, Ogre::Real, Ogre::RGBA, Ogre::uint, Ogre::VertexData::vertexBufferBinding, and Ogre::RenderOperation::vertexData. Referenced by _update(), appendText(), clearText(), scrollPerformed(), setFontName(), setMaterialName(), setTextLimit(), and updatePositionGeometry().

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

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

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

See Renderable. Reimplemented from Ogre::Renderable. Definition at line 283 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().

uint Ogre::TTYGuiElement::mAllocSize [protected]

Definition at line 286 of file OgreTTYGuiElement.h. Referenced by checkMemoryAllocation(), and TTYGuiElement().

bool Ogre::TTYGuiElement::mAutoScroll [protected]

Definition at line 305 of file OgreTTYGuiElement.h. Referenced by appendText(), clearText(), setCaption(), TTYGuiElement(), and updateTextGeometry().

RGBA Ogre::TTYGuiElement::mBottomColour [protected]

Definition at line 292 of file OgreTTYGuiElement.h. Referenced by setColour(), setColourBottom(), and TTYGuiElement().

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

Definition at line 120 of file OgreGuiElement.h. Referenced by 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().

Real Ogre::TTYGuiElement::mCharHeight [protected]

Definition at line 282 of file OgreTTYGuiElement.h. Referenced by _update(), checkAndSetUpdateGeometry(), getCharHeight(), setCharHeight(), setFontName(), setMetricsMode(), TTYGuiElement(), updatePositionGeometry(), updateTextGeometry(), and updateWindowGeometry().

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

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

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

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

ColourValue Ogre::TTYGuiElement::mColourBottom [protected]

Colours to use for the vertices. Definition at line 289 of file OgreTTYGuiElement.h. Referenced by getColourBottom(), setColour(), setColourBottom(), and TTYGuiElement().

ColourValue Ogre::TTYGuiElement::mColourTop [protected]

Definition at line 290 of file OgreTTYGuiElement.h. Referenced by getColour(), getColourTop(), setColour(), setColourTop(), and TTYGuiElement().

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

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

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

Definition at line 141 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyParent(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setPosition(), and Ogre::GuiElement::setTop().

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

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

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

Definition at line 152 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 144 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_positionsOutOfDate(), _update(), Ogre::TextAreaGuiElement::_update(), Ogre::GuiElement::_update(), Ogre::BorderPanelGuiElement::_update(), Ogre::GuiElement::GuiElement(), Ogre::BorderPanelGuiElement::setBorderSize(), setCharHeight(), Ogre::TextAreaGuiElement::setCharHeight(), setSpaceWidth(), and Ogre::TextAreaGuiElement::setSpaceWidth().

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

Definition at line 117 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), checkAndSetUpdateGeometry(), Ogre::GuiElement::contains(), Ogre::GuiElement::getHeight(), Ogre::GuiElement::GuiElement(), Ogre::ListGuiElement::layoutItems(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), Ogre::GuiElement::setMetricsMode(), TTYGuiElement(), updatePositionGeometry(), Ogre::PanelGuiElement::updatePositionGeometry(), and Ogre::BorderPanelGuiElement::updatePositionGeometry().

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

Definition at line 124 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 114 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getLeft(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), Ogre::CursorGuiElement::setOffsetX(), and Ogre::GuiElement::setPosition().

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

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

uint Ogre::TTYGuiElement::mMaxChars [protected]

Definition at line 301 of file OgreTTYGuiElement.h. Referenced by pruneText(), setTextLimit(), and TTYGuiElement().

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

Definition at line 123 of file OgreGuiElement.h. Referenced by _update(), Ogre::TextAreaGuiElement::_update(), Ogre::GuiElement::_update(), Ogre::BorderPanelGuiElement::_update(), Ogre::BorderPanelGuiElement::getBottomBorderSize(), getCharHeight(), Ogre::TextAreaGuiElement::getCharHeight(), Ogre::GuiElement::getHeight(), Ogre::GuiElement::getLeft(), Ogre::BorderPanelGuiElement::getLeftBorderSize(), Ogre::GuiElement::getMetricsMode(), Ogre::BorderPanelGuiElement::getRightBorderSize(), getSpaceWidth(), Ogre::TextAreaGuiElement::getSpaceWidth(), Ogre::GuiElement::getTop(), Ogre::BorderPanelGuiElement::getTopBorderSize(), Ogre::GuiElement::getWidth(), Ogre::GuiElement::GuiElement(), Ogre::BorderPanelGuiElement::setBorderSize(), setCharHeight(), Ogre::TextAreaGuiElement::setCharHeight(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setPosition(), 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 111 of file OgreGuiElement.h. Referenced by Ogre::GuiContainer::copyFromTemplate(), Ogre::PopupMenuGuiElement::getListItemName(), Ogre::ListGuiElement::getListItemName(), Ogre::GuiElement::getName(), Ogre::ListGuiElement::layoutItems(), 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, inherited]

Definition at line 136 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 134 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_notifyParent(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getParent(), and Ogre::GuiElement::GuiElement().

Font* Ogre::TTYGuiElement::mpFont [protected]

Definition at line 281 of file OgreTTYGuiElement.h. Referenced by checkAndSetUpdateGeometry(), getFontName(), setFontName(), TTYGuiElement(), updateTextGeometry(), and updateWindowGeometry().

ushort Ogre::TTYGuiElement::mPixelCharHeight [protected]

Definition at line 283 of file OgreTTYGuiElement.h. Referenced by _update(), getCharHeight(), setCharHeight(), setMetricsMode(), and TTYGuiElement().

short Ogre::GuiElement::mPixelHeight [protected, inherited]

Definition at line 131 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), Ogre::GuiElement::getHeight(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setHeight(), and Ogre::GuiElement::setMetricsMode().

short Ogre::GuiElement::mPixelLeft [protected, inherited]

Definition at line 129 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), Ogre::GuiElement::getLeft(), Ogre::GuiElement::setLeft(), Ogre::GuiElement::setMetricsMode(), and Ogre::GuiElement::setPosition().

ushort Ogre::TTYGuiElement::mPixelSpaceWidth [protected]

Definition at line 285 of file OgreTTYGuiElement.h. Referenced by _update(), getSpaceWidth(), setMetricsMode(), setSpaceWidth(), and TTYGuiElement().

short Ogre::GuiElement::mPixelTop [protected, inherited]

Definition at line 128 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), Ogre::GuiElement::getTop(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setPosition(), and Ogre::GuiElement::setTop().

short Ogre::GuiElement::mPixelWidth [protected, inherited]

Definition at line 130 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), Ogre::GuiElement::getWidth(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setMetricsMode(), and Ogre::GuiElement::setWidth().

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

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

RenderOperation Ogre::TTYGuiElement::mRenderOp [protected]

Render operation. Definition at line 263 of file OgreTTYGuiElement.h. Referenced by checkAndSetUpdateGeometry(), checkMemoryAllocation(), getRenderOperation(), initialise(), updateWindowGeometry(), and ~TTYGuiElement().

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

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

TTYGuiElement::CmdCharHeight Ogre::TTYGuiElement::msCmdCharHeight [static, protected]

Definition at line 40 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

TTYGuiElement::CmdColour Ogre::TTYGuiElement::msCmdColour [static, protected]

Definition at line 43 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

TTYGuiElement::CmdColourBottom Ogre::TTYGuiElement::msCmdColourBottom [static, protected]

Definition at line 44 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

TTYGuiElement::CmdColourTop Ogre::TTYGuiElement::msCmdColourTop [static, protected]

Definition at line 45 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

TTYGuiElement::CmdFontName Ogre::TTYGuiElement::msCmdFontName [static, protected]

Definition at line 42 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

TTYGuiElement::CmdScrollBar Ogre::TTYGuiElement::msCmdScrollBar [static, protected]

Definition at line 46 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

TTYGuiElement::CmdSpaceWidth Ogre::TTYGuiElement::msCmdSpaceWidth [static, protected]

Definition at line 41 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

TTYGuiElement::CmdTextLimit Ogre::TTYGuiElement::msCmdTextLimit [static, protected]

Definition at line 47 of file OgreTTYGuiElement.cpp. Referenced by addBaseParameters().

uint Ogre::TTYGuiElement::mScrLines [protected]

Definition at line 294 of file OgreTTYGuiElement.h. Referenced by appendText(), TTYGuiElement(), updatePositionGeometry(), updateScrollBar(), updateTextGeometry(), and updateWindowGeometry().

ScrollBarGuiElement* Ogre::TTYGuiElement::mScrollBar [protected]

Definition at line 307 of file OgreTTYGuiElement.h. Referenced by setScrollBar(), TTYGuiElement(), and updateScrollBar().

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, inherited]

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

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

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

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

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

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

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

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

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

Real Ogre::TTYGuiElement::mSpaceWidth [protected]

Definition at line 284 of file OgreTTYGuiElement.h. Referenced by _update(), getSpaceWidth(), setFontName(), setMetricsMode(), setSpaceWidth(), TTYGuiElement(), updateTextGeometry(), and updateWindowGeometry().

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

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

String Ogre::TTYGuiElement::msTypeName = "TTY" [static, protected]

Definition at line 39 of file OgreTTYGuiElement.cpp. Referenced by getTypeName().

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

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

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

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

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

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

TextBlockQueue Ogre::TTYGuiElement::mTextBlockQueue [protected]

Definition at line 299 of file OgreTTYGuiElement.h. Referenced by appendText(), clearText(), pruneText(), setCaption(), updateTextGeometry(), and updateWindowGeometry().

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

Definition at line 115 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), Ogre::GuiElement::_updateFromParent(), Ogre::GuiElement::getTop(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setMetricsMode(), Ogre::CursorGuiElement::setOffsetY(), Ogre::GuiElement::setPosition(), and Ogre::GuiElement::setTop().

RGBA Ogre::TTYGuiElement::mTopColour [protected]

Definition at line 291 of file OgreTTYGuiElement.h. Referenced by setColour(), setColourTop(), and TTYGuiElement().

uint Ogre::TTYGuiElement::mTopLine [protected]

Definition at line 304 of file OgreTTYGuiElement.h. Referenced by appendText(), clearText(), scrollPerformed(), setCaption(), TTYGuiElement(), updateScrollBar(), updateTextGeometry(), and updateWindowGeometry().

uint Ogre::TTYGuiElement::mTtlChars [protected]

Definition at line 300 of file OgreTTYGuiElement.h. Referenced by appendText(), clearText(), pruneText(), setCaption(), TTYGuiElement(), updateTextGeometry(), and updateWindowGeometry().

uint Ogre::TTYGuiElement::mTtlFaces [protected]

Definition at line 302 of file OgreTTYGuiElement.h. Referenced by appendText(), clearText(), pruneText(), setCaption(), TTYGuiElement(), and updateTextGeometry().

uint Ogre::TTYGuiElement::mTtlLines [protected]

Definition at line 303 of file OgreTTYGuiElement.h. Referenced by appendText(), clearText(), pruneText(), setCaption(), TTYGuiElement(), updateScrollBar(), and updateTextGeometry().

bool Ogre::TTYGuiElement::mUpdateGeometry [protected]

Definition at line 297 of file OgreTTYGuiElement.h. Referenced by checkAndSetUpdateGeometry(), TTYGuiElement(), updateScrollBar(), updateTextGeometry(), and updateWindowGeometry().

bool Ogre::TTYGuiElement::mUpdateGeometryNotVisible [protected]

Definition at line 298 of file OgreTTYGuiElement.h. Referenced by TTYGuiElement().

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

Definition at line 125 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 112 of file OgreGuiElement.h. Referenced by Ogre::CursorGuiElement::CursorGuiElement(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::hide(), Ogre::GuiElement::isVisible(), Ogre::GuiElement::show(), and Ogre::CursorGuiElement::show().

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

Definition at line 116 of file OgreGuiElement.h. Referenced by Ogre::GuiElement::_update(), checkAndSetUpdateGeometry(), Ogre::GuiElement::getWidth(), Ogre::GuiElement::GuiElement(), Ogre::GuiElement::setDimensions(), Ogre::GuiElement::setMetricsMode(), Ogre::GuiElement::setWidth(), Ogre::PanelGuiElement::updatePositionGeometry(), Ogre::BorderPanelGuiElement::updatePositionGeometry(), updateTextGeometry(), and updateWindowGeometry().

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

Definition at line 148 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:

• OgreTTYGuiElement.h
• OgreTTYGuiElement.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:15:42 2004