Movable text.
More...
#include <rendering/rendering.hh>
Inherits MovableObject, and Renderable.
|
| MovableText () |
| Constructor.
|
|
virtual | ~MovableText () |
| Destructor.
|
|
ignition::math::Box | AABB () |
| Get the axis aligned bounding box of the text.
|
|
float | Baseline () const |
| Get the baseline height in meters.
|
|
float | CharHeight () const |
| Get the height of the characters in meters return Height of the characters.
|
|
const ignition::math::Color & | Color () const |
| Get the text color.
|
|
const std::string & | FontName () const |
| Get the font name.
|
|
void | Load (const std::string &_name, const std::string &_text, const std::string &_fontName="Arial", float _charHeight=1.0, const ignition::math::Color &_color=ignition::math::Color::White) |
| Loads text and font info.
|
|
void | SetBaseline (const float _height) |
| Set the baseline height of the text.
|
|
void | SetCharHeight (const float _height) |
| Set the height of the character in meters.
|
|
void | SetColor (const ignition::math::Color &_color) |
| Set the text color.
|
|
void | SetFontName (const std::string &_font) |
| Set the font.
|
|
void | SetShowOnTop (const bool _show) |
| True = text always is displayed ontop.
|
|
void | SetSpaceWidth (const float _width) |
| Set the width of spaces between words.
|
|
void | SetText (const std::string &_text) |
| Set the text to display.
|
|
void | SetTextAlignment (const HorizAlign &_hAlign, const VertAlign &_vAlign) |
| Set the alignment of the text.
|
|
bool | ShowOnTop () const |
| Get whether the is displayed above other objects.
|
|
float | SpaceWidth () const |
| Get the width of spaces between words.
|
|
const std::string & | Text () const |
| Get the displayed text.
|
|
void | Update () |
| Update the text.
|
|
virtual void | visitRenderables (Ogre::Renderable::Visitor *_visitor, bool _debug=false) override |
|
◆ 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()
◆ AABB()
ignition::math::Box AABB |
( |
| ) |
|
Get the axis aligned bounding box of the text.
- Returns
- The axis aligned bounding box.
◆ Baseline()
Get the baseline height in meters.
- Returns
- Baseline height
- See also
- SetBaseline()
◆ CharHeight()
float CharHeight |
( |
| ) |
const |
Get the height of the characters in meters return Height of the characters.
- See also
- SetCharHeight()
◆ Color()
const ignition::math::Color & Color |
( |
| ) |
const |
Get the text color.
- Returns
- Text color.
- See also
- SetColor()
◆ FontName()
const std::string & FontName |
( |
| ) |
const |
◆ getBoundingRadius()
float getBoundingRadius |
( |
| ) |
const |
|
overrideprotected |
◆ getLights()
const Ogre::LightList & getLights |
( |
| ) |
const |
|
overrideprotected |
◆ getMaterial()
const Ogre::MaterialPtr & getMaterial |
( |
| ) |
const |
|
overrideprotected |
◆ getRenderOperation()
void getRenderOperation |
( |
Ogre::RenderOperation & | _op | ) |
|
|
overrideprotected |
◆ getSquaredViewDepth()
float getSquaredViewDepth |
( |
const Ogre::Camera * | _cam | ) |
const |
|
overrideprotected |
◆ getWorldTransforms()
void getWorldTransforms |
( |
Ogre::Matrix4 * | _xform | ) |
const |
|
overrideprotected |
◆ Load()
void Load |
( |
const std::string & | _name, |
|
|
const std::string & | _text, |
|
|
const std::string & | _fontName = "Arial", |
|
|
float | _charHeight = 1.0, |
|
|
const ignition::math::Color & | _color = ignition::math::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 |
( |
const float | _height | ) |
|
Set the baseline height of the text.
- Parameters
-
[in] | _height | Baseline height |
- See also
- Baseline()
◆ SetCharHeight()
void SetCharHeight |
( |
const float | _height | ) |
|
Set the height of the character in meters.
- Parameters
-
[in] | _height | Height of the characters. |
- See also
- CharHeight()
◆ SetColor()
void SetColor |
( |
const ignition::math::Color & | _color | ) |
|
Set the text color.
- Parameters
-
- See also
- Color()
◆ SetFontName()
void SetFontName |
( |
const std::string & | _font | ) |
|
Set the font.
Valid fonts are defined on media/fonts/Gazebo.fontdef
- Parameters
-
[in] | _font | Name of the font |
- See also
- FontName()
◆ SetShowOnTop()
void SetShowOnTop |
( |
const bool | _show | ) |
|
True = text always is displayed ontop.
- Parameters
-
[in] | _show | Set to true to render the text on top of all other drawables. |
- See also
- ShowOnTop()
◆ SetSpaceWidth()
void SetSpaceWidth |
( |
const float | _width | ) |
|
Set the width of spaces between words.
- Parameters
-
- See also
- SpaceWidth()
◆ SetText()
void SetText |
( |
const std::string & | _text | ) |
|
Set the text to display.
- Parameters
-
[in] | _text | The text to display. |
- See also
- Text()
◆ SetTextAlignment()
Set the alignment of the text.
- Parameters
-
[in] | _hAlign | Horizontal alignment |
[in] | _vAlign | Vertical alignment |
◆ SetupGeometry()
◆ ShowOnTop()
Get whether the is displayed above other objects.
- Returns
- True if it is on top.
- See also
- SetShowOnTop()
◆ SpaceWidth()
float SpaceWidth |
( |
| ) |
const |
Get the width of spaces between words.
- Returns
- Space width
- See also
- SetSpaceWidth()
◆ Text()
const std::string & Text |
( |
| ) |
const |
Get the displayed text.
- Returns
- The displayed text.
- See also
- SetText()
◆ Update()
◆ UpdateColors()
◆ visitRenderables()
virtual void visitRenderables |
( |
Ogre::Renderable::Visitor * | _visitor, |
|
|
bool | _debug = false ) |
|
overridevirtual |
The documentation for this class was generated from the following file: