MovableText Class Reference
#include <MovableText.hh>
Detailed Description
Movable textPublic Types | |
| enum | HorizAlign { H_LEFT, H_CENTER } |
| enum | VertAlign { V_BELOW, V_ABOVE } |
Public Member Functions | |
| MovableText (const std::string &name, const Ogre::UTFString &text, const std::string fontName="Arial", float charHeight=1.0, const Ogre::ColourValue &color=Ogre::ColourValue::White) | |
| virtual | ~MovableText () |
| void | SetFontName (const std::string &font) |
| const std::string & | GetFont () const |
| void | SetText (const Ogre::UTFString &caption) |
| const Ogre::UTFString & | GetText () const |
| void | SetColor (const Ogre::ColourValue &color) |
| const Ogre::ColourValue & | GetColor () const |
| void | SetCharHeight (float height) |
| float | GetCharHeight () const |
| void | SetSpaceWidth (float width) |
| float | GetSpaceWidth () const |
| void | SetTextAlignment (const HorizAlign &hAlign, const VertAlign &vAlign) |
| void | SetBaseline (float height) |
| float | GetBaseline () const |
| void | SetShowOnTop (bool show) |
| bool | GetShowOnTop () const |
| Ogre::AxisAlignedBox | GetAABB () |
Protected Member Functions | |
| void | _setupGeometry () |
| void | _updateColors () |
| void | getWorldTransforms (Ogre::Matrix4 *xform) const |
| float | getBoundingRadius () const |
| float | getSquaredViewDepth (const Ogre::Camera *cam) const |
| void | getRenderOperation (Ogre::RenderOperation &op) |
| const Ogre::MaterialPtr & | getMaterial (void) const |
| const Ogre::LightList & | getLights (void) const |
Member Enumeration Documentation
| enum HorizAlign |
Horizontal alignment
| enum VertAlign |
vertical alignment
Constructor & Destructor Documentation
| MovableText | ( | const std::string & | name, | |
| const Ogre::UTFString & | text, | |||
| const std::string | fontName = "Arial", |
|||
| float | charHeight = 1.0, |
|||
| const Ogre::ColourValue & | color = Ogre::ColourValue::White | |||
| ) |
Constructor
| virtual ~MovableText | ( | ) | [virtual] |
Destructor
Member Function Documentation
| void SetFontName | ( | const std::string & | font | ) |
Set the font
| const std::string& GetFont | ( | ) | const |
Get the font
| void SetText | ( | const Ogre::UTFString & | caption | ) |
Set the text to display
| const Ogre::UTFString& GetText | ( | ) | const |
Get the displayed text
| void SetColor | ( | const Ogre::ColourValue & | color | ) |
Set the text color
| const Ogre::ColourValue& GetColor | ( | ) | const |
Get the text color
| void SetCharHeight | ( | float | height | ) |
Set the height of a character
| float GetCharHeight | ( | ) | const |
Set the height of a characters
| void SetSpaceWidth | ( | float | width | ) |
Set the width of a space
| float GetSpaceWidth | ( | ) | const |
Get the width of a space
| void SetTextAlignment | ( | const HorizAlign & | hAlign, | |
| const VertAlign & | vAlign | |||
| ) |
Set the alignment of the text
| void SetBaseline | ( | float | height | ) |
Set the baseline height of the text
| float GetBaseline | ( | ) | const |
Get the baseline height
| void SetShowOnTop | ( | bool | show | ) |
True=text always is displayed ontop
| bool GetShowOnTop | ( | ) | const |
True=text is displayed on top
| Ogre::AxisAlignedBox GetAABB | ( | ) |
Get the axis aligned bounding box of the text
| void _setupGeometry | ( | ) | [protected] |
setup the geometry (from MovableText)
| void _updateColors | ( | ) | [protected] |
update the color(from MovableText)
| void getWorldTransforms | ( | Ogre::Matrix4 * | xform | ) | const [protected] |
Get the world transform (from MovableObject)
| float getBoundingRadius | ( | ) | const [protected] |
Get the bounding radiu (from MovableObject)
| float getSquaredViewDepth | ( | const Ogre::Camera * | cam | ) | const [protected] |
Get the squared view depth (from MovableObject)
| void getRenderOperation | ( | Ogre::RenderOperation & | op | ) | [protected] |
Get the render operation
| const Ogre::MaterialPtr& getMaterial | ( | void | ) | const [protected] |
Get the material
| const Ogre::LightList& getLights | ( | void | ) | const [protected] |
Get the lights
The documentation for this class was generated from the following file: