#include <OgreTextAreaOverlayElement.h>
Public Types | |
| enum | Alignment { Left, Right, Center } |
Public Member Functions | |
| TextAreaOverlayElement (const String &name) | |
| Constructor. | |
| virtual | ~TextAreaOverlayElement () |
| virtual void | initialise (void) |
| Initialise gui element. | |
| virtual void | setCaption (const DisplayString &text) |
| Sets the caption on elements that support it. | |
| void | setCharHeight (Real height) |
| Real | getCharHeight () const |
| void | setSpaceWidth (Real width) |
| Real | getSpaceWidth () const |
| void | setFontName (const String &font) |
| const String & | getFontName () const |
| virtual const String & | getTypeName (void) const |
| See OverlayElement. | |
| void | getRenderOperation (RenderOperation &op) |
| See Renderable. | |
| void | setMaterialName (const String &matName) |
| Overridden from OverlayElement. | |
| void | setColour (const ColourValue &col) |
| Sets the colour of the text. | |
| const ColourValue & | getColour (void) const |
| Gets the colour of the text. | |
| void | setColourBottom (const ColourValue &col) |
| Sets the colour of the bottom of the letters. | |
| const ColourValue & | getColourBottom (void) const |
| Gets the colour of the bottom of the letters. | |
| void | setColourTop (const ColourValue &col) |
| Sets the colour of the top of the letters. | |
| const ColourValue & | getColourTop (void) const |
| Gets the colour of the top of the letters. | |
| void | setAlignment (Alignment a) |
| Alignment | getAlignment () const |
| void | setMetricsMode (GuiMetricsMode gmm) |
| Overridden from OverlayElement. | |
| void | _update (void) |
| Overridden from OverlayElement. | |
| const String & | getName (void) const |
| Gets the name of this overlay. | |
| virtual void | show (void) |
| Shows this element if it was hidden. | |
| virtual void | hide (void) |
| Hides this element if it was visible. | |
| bool | isVisible (void) const |
| Returns whether or not the element is visible. | |
| bool | isEnabled () const |
| virtual void | setEnabled (bool b) |
| void | setDimensions (Real width, Real height) |
| Sets the dimensions of this element in relation to the screen (1.0 = screen width/height). | |
| void | setPosition (Real left, Real top) |
| Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height). | |
| void | setWidth (Real width) |
| Sets the width of this element in relation to the screen (where 1.0 = screen width). | |
| Real | getWidth (void) const |
| Gets the width of this element in relation to the screen (where 1.0 = screen width). | |
| void | setHeight (Real height) |
| Sets the height of this element in relation to the screen (where 1.0 = screen height). | |
| Real | getHeight (void) const |
| Gets the height of this element in relation to the screen (where 1.0 = screen height). | |
| void | setLeft (Real left) |
| Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
| Real | getLeft (void) const |
| Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
| void | setTop (Real Top) |
| Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). | |
| Real | getTop (void) const |
| Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). | |
| Real | _getLeft (void) const |
| Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
| Real | _getTop (void) const |
| Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
| Real | _getWidth (void) const |
| Gets the width of this element in relation to the screen (where 1.0 = screen width). | |
| Real | _getHeight (void) const |
| Gets the height of this element in relation to the screen (where 1.0 = screen height). | |
| void | _setLeft (Real left) |
| Sets the left of this element in relation to the screen (where 1.0 = screen width). | |
| void | _setTop (Real top) |
| Sets the top of this element in relation to the screen (where 1.0 = screen width). | |
| void | _setWidth (Real width) |
| Sets the width of this element in relation to the screen (where 1.0 = screen width). | |
| void | _setHeight (Real height) |
| Sets the height of this element in relation to the screen (where 1.0 = screen width). | |
| void | _setPosition (Real left, Real top) |
| Sets the left and top of this element in relation to the screen (where 1.0 = screen width). | |
| void | _setDimensions (Real width, Real height) |
| Sets the width and height of this element in relation to the screen (where 1.0 = screen width). | |
| virtual const String & | getMaterialName (void) const |
| Gets the name of the material this element uses. | |
| const MaterialPtr & | getMaterial (void) const |
| See Renderable. | |
| void | getWorldTransforms (Matrix4 *xform) const |
| See Renderable. | |
| const Quaternion & | getWorldOrientation (void) const |
| Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling. | |
| const Vector3 & | getWorldPosition (void) const |
| Gets the worldspace position of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling. | |
| 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 (OverlayContainer *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 Real | _getRelativeWidth (void) |
| Gets the 'width' as derived from own width and metrics mode. | |
| virtual Real | _getRelativeHeight (void) |
| Gets the 'height' as derived from own height and metrics mode. | |
| virtual void | _getClippingRegion (Rectangle &clippingRegion) |
| Gets the clipping region of the element. | |
| virtual void | _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 DisplayString & | getCaption (void) const |
| Gets the caption for this element. | |
| virtual GuiMetricsMode | getMetricsMode (void) const |
| Retrieves the current settings of how the element metrics are interpreted. | |
| virtual void | setHorizontalAlignment (GuiHorizontalAlignment gha) |
| Sets the horizontal origin for this element. | |
| virtual GuiHorizontalAlignment | getHorizontalAlignment (void) const |
| Gets the horizontal alignment for this element. | |
| virtual void | setVerticalAlignment (GuiVerticalAlignment gva) |
| Sets the vertical origin for this element. | |
| virtual GuiVerticalAlignment | getVerticalAlignment (void) const |
| Gets the vertical alignment for this element. | |
| virtual bool | contains (Real x, Real y) const |
| Returns true if xy is within the constraints of the component. | |
| virtual OverlayElement * | findElementAt (Real x, Real y) |
| Returns true if xy is within the constraints of the 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) |
| OverlayContainer * | getParent () |
| Returns the parent container. | |
| void | _setParent (OverlayContainer *parent) |
| ushort | getZOrder () const |
| Returns the zOrder of the element. | |
| Real | getSquaredViewDepth (const Camera *cam) const |
| Overridden from Renderable. | |
| const LightList & | getLights (void) const |
| Gets a list of lights, ordered relative to how close they are to this renderable.
| |
| virtual void | copyFromTemplate (OverlayElement *templateOverlay) |
| virtual OverlayElement * | clone (const String &instanceName) |
| const OverlayElement * | getSourceTemplate () const |
| ParamDictionary * | getParamDictionary (void) |
| Retrieves the parameter dictionary for this class. | |
| const ParamDictionary * | getParamDictionary (void) const |
| const ParameterList & | getParameters (void) const |
| Retrieves a list of parameters valid for this object. | |
| virtual bool | setParameter (const String &name, const String &value) |
| Generic parameter setting method. | |
| virtual void | setParameterList (const NameValuePairList ¶mList) |
| Generic multiple parameter setting method. | |
| virtual String | getParameter (const String &name) const |
| Generic parameter retrieval method. | |
| virtual void | copyParametersTo (StringInterface *dest) const |
| Method for copying this object's parameters to another object. | |
| virtual Technique * | getTechnique (void) const |
| Retrieves a pointer to the Material Technique this renderable object uses. | |
| virtual unsigned short | getNumWorldTransforms (void) const |
| Returns the number of world transform matrices this renderable requires. | |
| void | setUseIdentityProjection (bool useIdentityProjection) |
| Sets whether or not to use an 'identity' projection. | |
| bool | getUseIdentityProjection (void) const |
| Returns whether or not to use an 'identity' projection. | |
| void | setUseIdentityView (bool useIdentityView) |
| Sets whether or not to use an 'identity' view. | |
| bool | getUseIdentityView (void) const |
| Returns whether or not to use an 'identity' view. | |
| virtual bool | getNormaliseNormals (void) const |
| Returns whether or not this Renderable wishes the hardware to normalise normals. | |
| virtual const PlaneList & | getClipPlanes () const |
| virtual bool | getCastsShadows (void) const |
| Method which reports whether this renderable would normally cast a shadow. | |
| void | setCustomParameter (size_t index, const Vector4 &value) |
| Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. | |
| const Vector4 & | getCustomParameter (size_t index) const |
| Gets the custom value associated with this Renderable at the given index. | |
| virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
| Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. | |
| virtual void | setPolygonModeOverrideable (bool override) |
| Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
| virtual bool | getPolygonModeOverrideable (void) const |
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
Static Public Member Functions | |
| static void | cleanupDictionary () |
| Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. | |
Protected Types | |
| typedef std::map < size_t, Vector4 > | CustomParameterMap |
Protected Member Functions | |
| void | addBaseParameters (void) |
| Method for setting up base parameters for this class. | |
| void | checkMemoryAllocation (size_t numChars) |
| Internal method to allocate memory, only reallocates when necessary. | |
| virtual void | updatePositionGeometry () |
| Inherited function. | |
| virtual void | updateTextureGeometry () |
| Inherited function. | |
| virtual void | updateColours (void) |
| Updates vertex colours. | |
| bool | createParamDictionary (const String &className) |
| Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
| Alignment | mAlignment |
| The text alignment. | |
| bool | mTransparent |
| Flag indicating if this panel should be visual or just group things. | |
| RenderOperation | mRenderOp |
| Render operation. | |
| FontPtr | mpFont |
| Real | mCharHeight |
| ushort | mPixelCharHeight |
| Real | mSpaceWidth |
| ushort | mPixelSpaceWidth |
| size_t | mAllocSize |
| Real | mViewportAspectCoef |
| ColourValue | mColourBottom |
| Colours to use for the vertices. | |
| ColourValue | mColourTop |
| bool | mColoursChanged |
| String | mName |
| bool | mVisible |
| bool | mCloneable |
| Real | mLeft |
| Real | mTop |
| Real | mWidth |
| Real | mHeight |
| String | mMaterialName |
| MaterialPtr | mpMaterial |
| DisplayString | mCaption |
| ColourValue | mColour |
| Rectangle | mClippingRegion |
| GuiMetricsMode | mMetricsMode |
| GuiHorizontalAlignment | mHorzAlign |
| GuiVerticalAlignment | mVertAlign |
| Real | mPixelTop |
| Real | mPixelLeft |
| Real | mPixelWidth |
| Real | mPixelHeight |
| Real | mPixelScaleX |
| Real | mPixelScaleY |
| OverlayContainer * | mParent |
| Overlay * | mOverlay |
| Real | mDerivedLeft |
| Real | mDerivedTop |
| bool | mDerivedOutOfDate |
| bool | mGeomPositionsOutOfDate |
| Flag indicating if the vertex positons need recalculating. | |
| bool | mGeomUVsOutOfDate |
| Flag indicating if the vertex uvs need recalculating. | |
| ushort | mZOrder |
| Matrix4 | mXForm |
| bool | mEnabled |
| bool | mInitialised |
| OverlayElement * | mSourceTemplate |
| String | mParamDictName |
| Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
| CustomParameterMap | mCustomParameters |
| bool | mPolygonModeOverrideable |
| bool | mUseIdentityProjection |
| bool | mUseIdentityView |
Static Protected Attributes | |
| static String | msTypeName |
| static CmdCharHeight | msCmdCharHeight |
| static CmdSpaceWidth | msCmdSpaceWidth |
| static CmdFontName | msCmdFontName |
| static CmdColour | msCmdColour |
| static CmdColourTop | msCmdColourTop |
| static CmdColourBottom | msCmdColourBottom |
| static CmdAlignment | msCmdAlignment |
| static OverlayElementCommands::CmdLeft | msLeftCmd |
| static OverlayElementCommands::CmdTop | msTopCmd |
| static OverlayElementCommands::CmdWidth | msWidthCmd |
| static OverlayElementCommands::CmdHeight | msHeightCmd |
| static OverlayElementCommands::CmdMaterial | msMaterialCmd |
| static OverlayElementCommands::CmdCaption | msCaptionCmd |
| static OverlayElementCommands::CmdMetricsMode | msMetricsModeCmd |
| static OverlayElementCommands::CmdHorizontalAlign | msHorizontalAlignCmd |
| static OverlayElementCommands::CmdVerticalAlign | msVerticalAlignCmd |
| static OverlayElementCommands::CmdVisible | msVisibleCmd |
| static ParamDictionaryMap | msDictionary |
| Dictionary of parameters. | |
| static const PlaneList | msDummyPlaneList |
Classes | |
| class | CmdAlignment |
| Command object for setting the alignment. More... | |
| class | CmdCaption |
| Command object for setting the caption. More... | |
| class | CmdCharHeight |
| Command object for setting the char height. More... | |
| class | CmdColour |
| Command object for setting the constant colour. More... | |
| class | CmdColourBottom |
| Command object for setting the bottom colour. More... | |
| class | CmdColourTop |
| Command object for setting the top colour. More... | |
| class | CmdFontName |
| Command object for setting the caption. More... | |
| class | CmdSpaceWidth |
| Command object for setting the width of a space. More... | |
Definition at line 36 of file OgreTextAreaOverlayElement.h.
typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap [protected, inherited] |
Definition at line 285 of file OgreRenderable.h.
| Ogre::TextAreaOverlayElement::TextAreaOverlayElement | ( | const String & | name | ) |
Constructor.
| virtual Ogre::TextAreaOverlayElement::~TextAreaOverlayElement | ( | ) | [virtual] |
| virtual void Ogre::TextAreaOverlayElement::initialise | ( | void | ) | [virtual] |
| virtual void Ogre::TextAreaOverlayElement::setCaption | ( | const DisplayString & | text | ) | [virtual] |
Sets the caption on elements that support it.
Reimplemented from Ogre::OverlayElement.
| void Ogre::TextAreaOverlayElement::setCharHeight | ( | Real | height | ) |
| Real Ogre::TextAreaOverlayElement::getCharHeight | ( | ) | const |
| void Ogre::TextAreaOverlayElement::setSpaceWidth | ( | Real | width | ) |
| Real Ogre::TextAreaOverlayElement::getSpaceWidth | ( | ) | const |
| void Ogre::TextAreaOverlayElement::setFontName | ( | const String & | font | ) |
| const String& Ogre::TextAreaOverlayElement::getFontName | ( | ) | const |
| virtual const String& Ogre::TextAreaOverlayElement::getTypeName | ( | void | ) | const [virtual] |
| void Ogre::TextAreaOverlayElement::getRenderOperation | ( | RenderOperation & | op | ) | [virtual] |
| void Ogre::TextAreaOverlayElement::setMaterialName | ( | const String & | matName | ) | [virtual] |
| void Ogre::TextAreaOverlayElement::setColour | ( | const ColourValue & | col | ) | [virtual] |
Sets the colour of the text.
Reimplemented from Ogre::OverlayElement.
| const ColourValue& Ogre::TextAreaOverlayElement::getColour | ( | void | ) | const [virtual] |
| void Ogre::TextAreaOverlayElement::setColourBottom | ( | const ColourValue & | col | ) |
Sets the colour of the bottom of the letters.
| const ColourValue& Ogre::TextAreaOverlayElement::getColourBottom | ( | void | ) | const |
Gets the colour of the bottom of the letters.
| void Ogre::TextAreaOverlayElement::setColourTop | ( | const ColourValue & | col | ) |
Sets the colour of the top of the letters.
| const ColourValue& Ogre::TextAreaOverlayElement::getColourTop | ( | void | ) | const |
Gets the colour of the top of the letters.
| void Ogre::TextAreaOverlayElement::setAlignment | ( | Alignment | a | ) |
Definition at line 99 of file OgreTextAreaOverlayElement.h.
| Alignment Ogre::TextAreaOverlayElement::getAlignment | ( | ) | const |
Definition at line 104 of file OgreTextAreaOverlayElement.h.
| void Ogre::TextAreaOverlayElement::setMetricsMode | ( | GuiMetricsMode | gmm | ) | [virtual] |
| void Ogre::TextAreaOverlayElement::_update | ( | void | ) | [virtual] |
| void Ogre::TextAreaOverlayElement::addBaseParameters | ( | void | ) | [protected, virtual] |
| void Ogre::TextAreaOverlayElement::checkMemoryAllocation | ( | size_t | numChars | ) | [protected] |
Internal method to allocate memory, only reallocates when necessary.
| virtual void Ogre::TextAreaOverlayElement::updatePositionGeometry | ( | ) | [protected, virtual] |
| virtual void Ogre::TextAreaOverlayElement::updateTextureGeometry | ( | ) | [protected, virtual] |
| virtual void Ogre::TextAreaOverlayElement::updateColours | ( | void | ) | [protected, virtual] |
Updates vertex colours.
| const String& Ogre::OverlayElement::getName | ( | void | ) | const [inherited] |
| virtual void Ogre::OverlayElement::show | ( | void | ) | [virtual, inherited] |
Shows this element if it was hidden.
| virtual void Ogre::OverlayElement::hide | ( | void | ) | [virtual, inherited] |
Hides this element if it was visible.
| bool Ogre::OverlayElement::isVisible | ( | void | ) | const [inherited] |
Returns whether or not the element is visible.
| bool Ogre::OverlayElement::isEnabled | ( | ) | const [inherited] |
| virtual void Ogre::OverlayElement::setEnabled | ( | bool | b | ) | [virtual, inherited] |
Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).
Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height).
| void Ogre::OverlayElement::setWidth | ( | Real | width | ) | [inherited] |
Sets the width of this element in relation to the screen (where 1.0 = screen width).
| Real Ogre::OverlayElement::getWidth | ( | void | ) | const [inherited] |
Gets the width of this element in relation to the screen (where 1.0 = screen width).
| void Ogre::OverlayElement::setHeight | ( | Real | height | ) | [inherited] |
Sets the height of this element in relation to the screen (where 1.0 = screen height).
| Real Ogre::OverlayElement::getHeight | ( | void | ) | const [inherited] |
Gets the height of this element in relation to the screen (where 1.0 = screen height).
| void Ogre::OverlayElement::setLeft | ( | Real | left | ) | [inherited] |
Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
| Real Ogre::OverlayElement::getLeft | ( | void | ) | const [inherited] |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
| void Ogre::OverlayElement::setTop | ( | Real | Top | ) | [inherited] |
Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
| Real Ogre::OverlayElement::getTop | ( | void | ) | const [inherited] |
Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
| Real Ogre::OverlayElement::_getLeft | ( | void | ) | const [inherited] |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Definition at line 252 of file OgreOverlayElement.h.
| Real Ogre::OverlayElement::_getTop | ( | void | ) | const [inherited] |
Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Definition at line 254 of file OgreOverlayElement.h.
| Real Ogre::OverlayElement::_getWidth | ( | void | ) | const [inherited] |
Gets the width of this element in relation to the screen (where 1.0 = screen width).
Definition at line 256 of file OgreOverlayElement.h.
| Real Ogre::OverlayElement::_getHeight | ( | void | ) | const [inherited] |
Gets the height of this element in relation to the screen (where 1.0 = screen height).
Definition at line 258 of file OgreOverlayElement.h.
| void Ogre::OverlayElement::_setLeft | ( | Real | left | ) | [inherited] |
Sets the left of this element in relation to the screen (where 1.0 = screen width).
| void Ogre::OverlayElement::_setTop | ( | Real | top | ) | [inherited] |
Sets the top of this element in relation to the screen (where 1.0 = screen width).
| void Ogre::OverlayElement::_setWidth | ( | Real | width | ) | [inherited] |
Sets the width of this element in relation to the screen (where 1.0 = screen width).
| void Ogre::OverlayElement::_setHeight | ( | Real | height | ) | [inherited] |
Sets the height of this element in relation to the screen (where 1.0 = screen width).
Sets the left and top of this element in relation to the screen (where 1.0 = screen width).
Sets the width and height of this element in relation to the screen (where 1.0 = screen width).
| virtual const String& Ogre::OverlayElement::getMaterialName | ( | void | ) | const [virtual, inherited] |
Gets the name of the material this element uses.
| const MaterialPtr& Ogre::OverlayElement::getMaterial | ( | void | ) | const [virtual, inherited] |
| void Ogre::OverlayElement::getWorldTransforms | ( | Matrix4 * | xform | ) | const [virtual, inherited] |
| const Quaternion& Ogre::OverlayElement::getWorldOrientation | ( | void | ) | const [virtual, inherited] |
Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
Implements Ogre::Renderable.
| const Vector3& Ogre::OverlayElement::getWorldPosition | ( | void | ) | const [virtual, inherited] |
Gets the worldspace position of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
Implements Ogre::Renderable.
| virtual void Ogre::OverlayElement::_positionsOutOfDate | ( | void | ) | [virtual, inherited] |
| virtual void Ogre::OverlayElement::_updateFromParent | ( | void | ) | [virtual, inherited] |
Updates this elements transform based on it's parent.
| virtual void Ogre::OverlayElement::_notifyParent | ( | OverlayContainer * | parent, | |
| Overlay * | overlay | |||
| ) | [virtual, inherited] |
Internal method for notifying the gui element of it's parent and ultimate overlay.
Reimplemented in Ogre::OverlayContainer.
| virtual Real Ogre::OverlayElement::_getDerivedLeft | ( | void | ) | [virtual, inherited] |
Gets the 'left' position as derived from own left and that of parents.
| virtual Real Ogre::OverlayElement::_getDerivedTop | ( | void | ) | [virtual, inherited] |
Gets the 'top' position as derived from own left and that of parents.
| virtual Real Ogre::OverlayElement::_getRelativeWidth | ( | void | ) | [virtual, inherited] |
Gets the 'width' as derived from own width and metrics mode.
| virtual Real Ogre::OverlayElement::_getRelativeHeight | ( | void | ) | [virtual, inherited] |
Gets the 'height' as derived from own height and metrics mode.
| virtual void Ogre::OverlayElement::_getClippingRegion | ( | Rectangle & | clippingRegion | ) | [virtual, inherited] |
Gets the clipping region of the element.
| virtual void Ogre::OverlayElement::_notifyZOrder | ( | ushort | newZOrder | ) | [virtual, inherited] |
Internal method to notify the element when Zorder of parent overlay has changed.
Reimplemented in Ogre::OverlayContainer.
| virtual void Ogre::OverlayElement::_notifyWorldTransforms | ( | const Matrix4 & | xform | ) | [virtual, inherited] |
Internal method to notify the element when it's world transform of parent overlay has changed.
Reimplemented in Ogre::OverlayContainer.
| virtual void Ogre::OverlayElement::_notifyViewport | ( | ) | [virtual, inherited] |
Internal method to notify the element when the viewport of parent overlay has changed.
Reimplemented in Ogre::OverlayContainer.
| virtual void Ogre::OverlayElement::_updateRenderQueue | ( | RenderQueue * | queue | ) | [virtual, inherited] |
Internal method to put the contents onto the render queue.
Reimplemented in Ogre::BorderPanelOverlayElement, Ogre::OverlayContainer, and Ogre::PanelOverlayElement.
| virtual const DisplayString& Ogre::OverlayElement::getCaption | ( | void | ) | const [virtual, inherited] |
Gets the caption for this element.
| virtual GuiMetricsMode Ogre::OverlayElement::getMetricsMode | ( | void | ) | const [virtual, inherited] |
Retrieves the current settings of how the element metrics are interpreted.
| virtual void Ogre::OverlayElement::setHorizontalAlignment | ( | GuiHorizontalAlignment | gha | ) | [virtual, inherited] |
Sets the horizontal origin for this element.
| virtual GuiHorizontalAlignment Ogre::OverlayElement::getHorizontalAlignment | ( | void | ) | const [virtual, inherited] |
Gets the horizontal alignment for this element.
| virtual void Ogre::OverlayElement::setVerticalAlignment | ( | GuiVerticalAlignment | gva | ) | [virtual, inherited] |
Sets the vertical origin for this element.
| virtual GuiVerticalAlignment Ogre::OverlayElement::getVerticalAlignment | ( | void | ) | const [virtual, inherited] |
Gets the vertical alignment for this element.
Returns true if xy is within the constraints of the component.
| virtual OverlayElement* Ogre::OverlayElement::findElementAt | ( | Real | x, | |
| Real | y | |||
| ) | [virtual, inherited] |
Returns true if xy is within the constraints of the component.
Reimplemented in Ogre::OverlayContainer.
| virtual bool Ogre::OverlayElement::isContainer | ( | ) | const [virtual, inherited] |
returns false as this class is not a container type
Reimplemented in Ogre::OverlayContainer.
Definition at line 437 of file OgreOverlayElement.h.
| virtual bool Ogre::OverlayElement::isKeyEnabled | ( | ) | const [virtual, inherited] |
Definition at line 440 of file OgreOverlayElement.h.
| virtual bool Ogre::OverlayElement::isCloneable | ( | ) | const [virtual, inherited] |
Definition at line 443 of file OgreOverlayElement.h.
| virtual void Ogre::OverlayElement::setCloneable | ( | bool | c | ) | [virtual, inherited] |
Definition at line 446 of file OgreOverlayElement.h.
| OverlayContainer* Ogre::OverlayElement::getParent | ( | ) | [inherited] |
Returns the parent container.
| void Ogre::OverlayElement::_setParent | ( | OverlayContainer * | parent | ) | [inherited] |
Definition at line 453 of file OgreOverlayElement.h.
| ushort Ogre::OverlayElement::getZOrder | ( | ) | const [inherited] |
Overridden from Renderable.
Implements Ogre::Renderable.
Definition at line 462 of file OgreOverlayElement.h.
| const LightList& Ogre::OverlayElement::getLights | ( | void | ) | const [virtual, inherited] |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
Definition at line 468 of file OgreOverlayElement.h.
| virtual void Ogre::OverlayElement::copyFromTemplate | ( | OverlayElement * | templateOverlay | ) | [virtual, inherited] |
Reimplemented in Ogre::OverlayContainer.
| virtual OverlayElement* Ogre::OverlayElement::clone | ( | const String & | instanceName | ) | [virtual, inherited] |
Reimplemented in Ogre::OverlayContainer.
| const OverlayElement* Ogre::OverlayElement::getSourceTemplate | ( | ) | const [inherited] |
Definition at line 479 of file OgreOverlayElement.h.
| 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.
| className | the name of the class using the dictionary |
Definition at line 176 of file OgreStringInterface.h.
| ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h.
| const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 213 of file OgreStringInterface.h.
| const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
| virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
| const String & | value | |||
| ) | [virtual, inherited] |
Generic parameter setting method.
| 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. |
Referenced by Ogre::StringInterface::copyParametersTo().
| virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
| paramList | Name/value pair list |
| virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
| name | The name of the parameter to get |
Definition at line 269 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
| virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
Method for copying this object's parameters to another object.
| dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 300 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
| static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
| virtual Technique* Ogre::Renderable::getTechnique | ( | void | ) | const [virtual, inherited] |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 73 of file OgreRenderable.h.
| virtual unsigned short Ogre::Renderable::getNumWorldTransforms | ( | void | ) | const [virtual, inherited] |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 111 of file OgreRenderable.h.
| void Ogre::Renderable::setUseIdentityProjection | ( | bool | useIdentityProjection | ) | [inherited] |
Sets whether or not to use an 'identity' projection.
Definition at line 122 of file OgreRenderable.h.
| bool Ogre::Renderable::getUseIdentityProjection | ( | void | ) | const [inherited] |
Returns whether or not to use an 'identity' projection.
Definition at line 136 of file OgreRenderable.h.
| void Ogre::Renderable::setUseIdentityView | ( | bool | useIdentityView | ) | [inherited] |
Sets whether or not to use an 'identity' view.
Definition at line 147 of file OgreRenderable.h.
| bool Ogre::Renderable::getUseIdentityView | ( | void | ) | const [inherited] |
Returns whether or not to use an 'identity' view.
Definition at line 161 of file OgreRenderable.h.
| virtual bool Ogre::Renderable::getNormaliseNormals | ( | void | ) | const [virtual, inherited] |
Returns whether or not this Renderable wishes the hardware to normalise normals.
Reimplemented in Ogre::SubEntity.
Definition at line 171 of file OgreRenderable.h.
| virtual const PlaneList& Ogre::Renderable::getClipPlanes | ( | ) | const [virtual, inherited] |
Definition at line 179 of file OgreRenderable.h.
| virtual bool Ogre::Renderable::getCastsShadows | ( | void | ) | const [virtual, inherited] |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 187 of file OgreRenderable.h.
| void Ogre::Renderable::setCustomParameter | ( | size_t | index, | |
| const Vector4 & | value | |||
| ) | [inherited] |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
| index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used. | |
| value | The value to associate. |
Definition at line 204 of file OgreRenderable.h.
| const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const [inherited] |
Gets the custom value associated with this Renderable at the given index.
| @see | setCustomParaemter for full details. |
Definition at line 213 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
| virtual void Ogre::Renderable::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry, | |
| GpuProgramParameters * | params | |||
| ) | const [virtual, inherited] |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
| constantEntry | The auto constant entry referring to the parameter being updated | |
| params | The parameters object which this method should call to set the updated parameters. |
Reimplemented in Ogre::SubEntity.
Definition at line 252 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
| virtual void Ogre::Renderable::setPolygonModeOverrideable | ( | bool | override | ) | [virtual, inherited] |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
| override | true means that a lower camera detail will override this renderables detail level, false means it won't. |
Definition at line 269 of file OgreRenderable.h.
| virtual bool Ogre::Renderable::getPolygonModeOverrideable | ( | void | ) | const [virtual, inherited] |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::BorderRenderable.
Definition at line 277 of file OgreRenderable.h.
Alignment Ogre::TextAreaOverlayElement::mAlignment [protected] |
bool Ogre::TextAreaOverlayElement::mTransparent [protected] |
Flag indicating if this panel should be visual or just group things.
Definition at line 201 of file OgreTextAreaOverlayElement.h.
String Ogre::TextAreaOverlayElement::msTypeName [static, protected] |
Definition at line 209 of file OgreTextAreaOverlayElement.h.
CmdCharHeight Ogre::TextAreaOverlayElement::msCmdCharHeight [static, protected] |
Definition at line 212 of file OgreTextAreaOverlayElement.h.
CmdSpaceWidth Ogre::TextAreaOverlayElement::msCmdSpaceWidth [static, protected] |
Definition at line 213 of file OgreTextAreaOverlayElement.h.
CmdFontName Ogre::TextAreaOverlayElement::msCmdFontName [static, protected] |
Definition at line 214 of file OgreTextAreaOverlayElement.h.
CmdColour Ogre::TextAreaOverlayElement::msCmdColour [static, protected] |
Definition at line 215 of file OgreTextAreaOverlayElement.h.
CmdColourTop Ogre::TextAreaOverlayElement::msCmdColourTop [static, protected] |
Definition at line 216 of file OgreTextAreaOverlayElement.h.
CmdColourBottom Ogre::TextAreaOverlayElement::msCmdColourBottom [static, protected] |
Definition at line 217 of file OgreTextAreaOverlayElement.h.
CmdAlignment Ogre::TextAreaOverlayElement::msCmdAlignment [static, protected] |
Definition at line 218 of file OgreTextAreaOverlayElement.h.
FontPtr Ogre::TextAreaOverlayElement::mpFont [protected] |
Definition at line 221 of file OgreTextAreaOverlayElement.h.
Real Ogre::TextAreaOverlayElement::mCharHeight [protected] |
Definition at line 222 of file OgreTextAreaOverlayElement.h.
ushort Ogre::TextAreaOverlayElement::mPixelCharHeight [protected] |
Definition at line 223 of file OgreTextAreaOverlayElement.h.
Real Ogre::TextAreaOverlayElement::mSpaceWidth [protected] |
Definition at line 224 of file OgreTextAreaOverlayElement.h.
ushort Ogre::TextAreaOverlayElement::mPixelSpaceWidth [protected] |
Definition at line 225 of file OgreTextAreaOverlayElement.h.
size_t Ogre::TextAreaOverlayElement::mAllocSize [protected] |
Definition at line 226 of file OgreTextAreaOverlayElement.h.
Definition at line 227 of file OgreTextAreaOverlayElement.h.
ColourValue Ogre::TextAreaOverlayElement::mColourTop [protected] |
Definition at line 231 of file OgreTextAreaOverlayElement.h.
bool Ogre::TextAreaOverlayElement::mColoursChanged [protected] |
Definition at line 232 of file OgreTextAreaOverlayElement.h.
OverlayElementCommands::CmdLeft Ogre::OverlayElement::msLeftCmd [static, protected, inherited] |
Definition at line 110 of file OgreOverlayElement.h.
OverlayElementCommands::CmdTop Ogre::OverlayElement::msTopCmd [static, protected, inherited] |
Definition at line 111 of file OgreOverlayElement.h.
OverlayElementCommands::CmdWidth Ogre::OverlayElement::msWidthCmd [static, protected, inherited] |
Definition at line 112 of file OgreOverlayElement.h.
OverlayElementCommands::CmdHeight Ogre::OverlayElement::msHeightCmd [static, protected, inherited] |
Definition at line 113 of file OgreOverlayElement.h.
OverlayElementCommands::CmdMaterial Ogre::OverlayElement::msMaterialCmd [static, protected, inherited] |
Definition at line 114 of file OgreOverlayElement.h.
OverlayElementCommands::CmdCaption Ogre::OverlayElement::msCaptionCmd [static, protected, inherited] |
Definition at line 115 of file OgreOverlayElement.h.
OverlayElementCommands::CmdMetricsMode Ogre::OverlayElement::msMetricsModeCmd [static, protected, inherited] |
Definition at line 116 of file OgreOverlayElement.h.
OverlayElementCommands::CmdHorizontalAlign Ogre::OverlayElement::msHorizontalAlignCmd [static, protected, inherited] |
Definition at line 117 of file OgreOverlayElement.h.
OverlayElementCommands::CmdVerticalAlign Ogre::OverlayElement::msVerticalAlignCmd [static, protected, inherited] |
Definition at line 118 of file OgreOverlayElement.h.
OverlayElementCommands::CmdVisible Ogre::OverlayElement::msVisibleCmd [static, protected, inherited] |
Definition at line 119 of file OgreOverlayElement.h.
String Ogre::OverlayElement::mName [protected, inherited] |
Definition at line 122 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mVisible [protected, inherited] |
Definition at line 123 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mCloneable [protected, inherited] |
Definition at line 124 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mLeft [protected, inherited] |
Definition at line 125 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mTop [protected, inherited] |
Definition at line 126 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mWidth [protected, inherited] |
Definition at line 127 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mHeight [protected, inherited] |
Definition at line 128 of file OgreOverlayElement.h.
String Ogre::OverlayElement::mMaterialName [protected, inherited] |
Definition at line 129 of file OgreOverlayElement.h.
MaterialPtr Ogre::OverlayElement::mpMaterial [protected, inherited] |
Definition at line 130 of file OgreOverlayElement.h.
DisplayString Ogre::OverlayElement::mCaption [protected, inherited] |
Definition at line 131 of file OgreOverlayElement.h.
ColourValue Ogre::OverlayElement::mColour [protected, inherited] |
Definition at line 132 of file OgreOverlayElement.h.
Rectangle Ogre::OverlayElement::mClippingRegion [protected, inherited] |
Definition at line 133 of file OgreOverlayElement.h.
GuiMetricsMode Ogre::OverlayElement::mMetricsMode [protected, inherited] |
Definition at line 135 of file OgreOverlayElement.h.
GuiHorizontalAlignment Ogre::OverlayElement::mHorzAlign [protected, inherited] |
Definition at line 136 of file OgreOverlayElement.h.
GuiVerticalAlignment Ogre::OverlayElement::mVertAlign [protected, inherited] |
Definition at line 137 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelTop [protected, inherited] |
Definition at line 140 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelLeft [protected, inherited] |
Definition at line 141 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelWidth [protected, inherited] |
Definition at line 142 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelHeight [protected, inherited] |
Definition at line 143 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelScaleX [protected, inherited] |
Definition at line 144 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelScaleY [protected, inherited] |
Definition at line 145 of file OgreOverlayElement.h.
OverlayContainer* Ogre::OverlayElement::mParent [protected, inherited] |
Definition at line 148 of file OgreOverlayElement.h.
Overlay* Ogre::OverlayElement::mOverlay [protected, inherited] |
Definition at line 150 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mDerivedLeft [protected, inherited] |
Definition at line 153 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mDerivedTop [protected, inherited] |
Definition at line 154 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mDerivedOutOfDate [protected, inherited] |
Definition at line 155 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mGeomPositionsOutOfDate [protected, inherited] |
Flag indicating if the vertex positons need recalculating.
Definition at line 158 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mGeomUVsOutOfDate [protected, inherited] |
Flag indicating if the vertex uvs need recalculating.
Definition at line 160 of file OgreOverlayElement.h.
ushort Ogre::OverlayElement::mZOrder [protected, inherited] |
Definition at line 164 of file OgreOverlayElement.h.
Matrix4 Ogre::OverlayElement::mXForm [protected, inherited] |
Definition at line 167 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mEnabled [protected, inherited] |
Definition at line 170 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mInitialised [protected, inherited] |
Definition at line 173 of file OgreOverlayElement.h.
OverlayElement* Ogre::OverlayElement::mSourceTemplate [protected, inherited] |
Definition at line 176 of file OgreOverlayElement.h.
ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited] |
String Ogre::StringInterface::mParamDictName [protected, inherited] |
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h.
const PlaneList Ogre::Renderable::msDummyPlaneList [static, protected, inherited] |
Definition at line 284 of file OgreRenderable.h.
CustomParameterMap Ogre::Renderable::mCustomParameters [protected, inherited] |
Definition at line 286 of file OgreRenderable.h.
bool Ogre::Renderable::mPolygonModeOverrideable [protected, inherited] |
Definition at line 287 of file OgreRenderable.h.
bool Ogre::Renderable::mUseIdentityProjection [protected, inherited] |
Definition at line 288 of file OgreRenderable.h.
bool Ogre::Renderable::mUseIdentityView [protected, inherited] |
Definition at line 289 of file OgreRenderable.h.
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:54:38 2008