Movable text.
More...
#include <rendering/rendering.hh>
Inherits MovableObject, and Renderable.
◆ HorizAlign
Horizontal alignment.
Enumerator |
---|
H_LEFT | Left alignment.
|
H_CENTER | Center alignment.
|
◆ VertAlign
vertical alignment
Enumerator |
---|
V_BELOW | Align below.
|
V_ABOVE | Align above.
|
◆ MovableText()
◆ ~MovableText()
◆ _setupGeometry()
◆ _updateColors()
◆ AABB()
ignition::math::Box AABB |
( |
| ) |
|
Get the axis aligned bounding box of the text.
- Returns
- The axis aligned bounding box.
- Deprecated:
- See ignition::math::Box AABB();
◆ GetAABB()
Get the axis aligned bounding box of the text.
- Returns
- The axis aligned bounding box.
- Deprecated:
- See ignition::math::Box AABB();
◆ GetBaseline()
float GetBaseline |
( |
| ) |
const |
Get the baseline height.
- Returns
- Baseline height
◆ getBoundingRadius()
float getBoundingRadius |
( |
| ) |
const |
|
protected |
◆ GetCharHeight()
float GetCharHeight |
( |
| ) |
const |
Set the height of a characters return Height of the characters.
◆ GetColor()
Get the text color.
- Returns
- Texture color.
◆ GetFont()
const std::string& GetFont |
( |
| ) |
const |
Get the font.
- Returns
- The font name
◆ getLights()
const Ogre::LightList& getLights |
( |
void |
| ) |
const |
|
protected |
◆ getMaterial()
const Ogre::MaterialPtr& getMaterial |
( |
void |
| ) |
const |
|
protected |
◆ getRenderOperation()
void getRenderOperation |
( |
Ogre::RenderOperation & |
op | ) |
|
|
protected |
◆ GetShowOnTop()
bool GetShowOnTop |
( |
| ) |
const |
True = text is displayed on top.
- Returns
- True if MovableText::SetShownOnTop(true) was called.
◆ GetSpaceWidth()
float GetSpaceWidth |
( |
| ) |
const |
Get the width of a space.
- Returns
- Space width
◆ getSquaredViewDepth()
float getSquaredViewDepth |
( |
const Ogre::Camera * |
cam | ) |
const |
|
protected |
◆ GetText()
const std::string& GetText |
( |
| ) |
const |
Get the displayed text.
- Returns
- The displayed text.
◆ getWorldTransforms()
void getWorldTransforms |
( |
Ogre::Matrix4 * |
xform | ) |
const |
|
protected |
◆ Load()
void Load |
( |
const std::string & |
_name, |
|
|
const std::string & |
_text, |
|
|
const std::string & |
_fontName = "Arial" , |
|
|
float |
_charHeight = 1.0 , |
|
|
const common::Color & |
_color = common::Color::White |
|
) |
| |
Loads text and font info.
- Parameters
-
[in] | _name | Name of the text object |
[in] | _text | Text to render |
[in] | _fontName | Font to use |
[in] | _charHeight | Height of the characters |
[in] | _color | Text color |
◆ SetBaseline()
void SetBaseline |
( |
float |
_height | ) |
|
Set the baseline height of the text.
- Parameters
-
[in] | _height | Baseline height |
◆ SetCharHeight()
void SetCharHeight |
( |
float |
_height | ) |
|
Set the height of a character.
- Parameters
-
[in] | _height | Height of the characters. |
◆ SetColor()
Set the text color.
- Parameters
-
◆ SetFontName()
void SetFontName |
( |
const std::string & |
_font | ) |
|
Set the font.
- Parameters
-
[in] | _font | Name of the font |
◆ SetShowOnTop()
void SetShowOnTop |
( |
bool |
_show | ) |
|
True = text always is displayed ontop.
- Parameters
-
[in] | _show | Set to true to render the text on top of all other drawables. |
◆ SetSpaceWidth()
void SetSpaceWidth |
( |
float |
_width | ) |
|
Set the width of a space.
- Parameters
-
◆ SetText()
void SetText |
( |
const std::string & |
_text | ) |
|
Set the text to display.
- Parameters
-
[in] | _text | The text to display. |
◆ SetTextAlignment()
Set the alignment of the text.
- Parameters
-
[in] | _hAlign | Horizontal alignment |
[in] | _vAlign | Vertical alignment |
◆ Update()
◆ visitRenderables()
virtual void visitRenderables |
( |
Ogre::Renderable::Visitor * |
_visitor, |
|
|
bool |
_debug = false |
|
) |
| |
|
virtual |
The documentation for this class was generated from the following file: