Represents a billboard text geometry that is always facing the camera. More...

#include <gz/rendering/Text>

Public Member Functions
	Text ()=default
	Constructor.

virtual	~Text ()
	Destructor.

virtual gz::math::AxisAlignedBox	AABB () const =0
	Get the axis aligned bounding box of the text.

virtual float	Baseline () const =0
	Get the baseline height in meters.

virtual float	CharHeight () const =0
	Get the height of the characters in meters return Height of the characters.

virtual gz::math::Color	Color () const =0
	Get the text color.

virtual std::string	FontName () const =0
	Get the font name.

virtual TextHorizontalAlign	HorizontalAlignment () const =0
	Get the horizontal alignment of the text.

virtual void	SetBaseline (const float _baseline)=0
	Set the baseline height of the text.

virtual void	SetCharHeight (const float _height)=0
	Set the height of the character in meters.

virtual void	SetColor (const gz::math::Color &_color)=0
	Set the text color.

virtual void	SetFontName (const std::string &_font)=0
	Set the font.

virtual void	SetShowOnTop (const bool _onTop)=0
	True = text always is displayed ontop.

virtual void	SetSpaceWidth (const float _width)=0
	Set the width of spaces between words.

virtual void	SetTextAlignment (const TextHorizontalAlign &_hAlign, const TextVerticalAlign &_vAlign)=0
	Set the alignment of the text.

virtual void	SetTextString (const std::string &_text)=0
	Set the text to display.

virtual bool	ShowOnTop () const =0
	Get whether the is displayed above other objects.

virtual float	SpaceWidth () const =0
	Get the width of spaces between words.

virtual std::string	TextString () const =0
	Get the displayed text.

virtual TextVerticalAlign	VerticalAlignment () const =0
	Get the vertical alignment of the text.

Public Member Functions inherited from Geometry
virtual	~Geometry ()
	Destructor.

virtual GeometryPtr	Clone () const =0
	Clone the geometry.

virtual bool	HasParent () const =0
	Determine if this Geometry is attached to a Visual.

virtual MaterialPtr	Material () const =0
	Get the material of this geometry.

virtual VisualPtr	Parent () const =0
	Get the parent Visual.

virtual void	RemoveParent ()=0
	Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done.

virtual void	SetMaterial (const std::string &_name, bool _unique=true)=0
	Set the materials of this Geometry. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done.

virtual void	SetMaterial (MaterialPtr _material, bool _unique=true)=0
	Set the materials of this Geometry.

Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.

virtual void	Destroy ()=0
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.

virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.

virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.

virtual void	PreRender ()=0
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.

virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

Detailed Description

Represents a billboard text geometry that is always facing the camera.

Constructor & Destructor Documentation

◆ Text()

Text ( )

default

Constructor.

◆ ~Text()

virtual ~Text ( )

virtual

Destructor.

Member Function Documentation

◆ AABB()

virtual gz::math::AxisAlignedBox AABB ( ) const

pure virtual

Get the axis aligned bounding box of the text.

Returns: The axis aligned bounding box.

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ Baseline()

virtual float Baseline ( ) const

pure virtual

Get the baseline height in meters.

Returns: Baseline height

See also: SetBaseline()

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ CharHeight()

virtual float CharHeight ( ) const

pure virtual

Get the height of the characters in meters return Height of the characters.

See also: SetCharHeight()

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ Color()

virtual gz::math::Color Color ( ) const

pure virtual

Get the text color.

Returns: Text color.

See also: SetColor()

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ FontName()

virtual std::string FontName ( ) const

pure virtual

Get the font name.

Returns: The font name.

See also: SetFontName()

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ HorizontalAlignment()

virtual TextHorizontalAlign HorizontalAlignment ( ) const

pure virtual

Get the horizontal alignment of the text.

Returns: Text horizontal alignment

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ SetBaseline()

virtual void SetBaseline ( const float _baseline )

pure virtual

Set the baseline height of the text.

Parameters

[in] _baseline Baseline height

See also: Baseline()

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ SetCharHeight()

virtual void SetCharHeight ( const float _height )

pure virtual

Set the height of the character in meters.

Parameters

[in] _height Height of the characters.

See also: CharHeight()

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ SetColor()

virtual void SetColor ( const gz::math::Color & _color )

pure virtual

Set the text color.

Parameters

[in] _color Text color.

See also: Color()

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ SetFontName()

virtual void SetFontName ( const std::string & _font )

pure virtual

Set the font.

Parameters

[in] _font Name of the font

See also: FontName()

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ SetShowOnTop()

virtual void SetShowOnTop ( const bool _onTop )

pure virtual

True = text always is displayed ontop.

Parameters

[in] _onTop Set to true to render the text on top of all other drawables.

See also: ShowOnTop()

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ SetSpaceWidth()

virtual void SetSpaceWidth ( const float _width )

pure virtual

Set the width of spaces between words.

Parameters

[in] _width Space width

See also: SpaceWidth()

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ SetTextAlignment()

virtual void SetTextAlignment	(	const TextHorizontalAlign &	_hAlign,
		const TextVerticalAlign &	_vAlign
	)

pure virtual

Set the alignment of the text.

Parameters

[in]	_hAlign	Horizontal alignment
[in]	_vAlign	Vertical alignment

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ SetTextString()

virtual void SetTextString ( const std::string & _text )

pure virtual

Set the text to display.

Parameters

[in] _text The text to display.

See also: Text()

Implemented in BaseText< T >, BaseText< OgreGeometry >, and OgreText.

◆ ShowOnTop()

virtual bool ShowOnTop ( ) const

pure virtual

Get whether the is displayed above other objects.

Returns: True if it is on top.

See also: SetShowOnTop()

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ SpaceWidth()

virtual float SpaceWidth ( ) const

pure virtual

Get the width of spaces between words.

Returns: Space width

See also: SetSpaceWidth()

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ TextString()

virtual std::string TextString ( ) const

pure virtual

Get the displayed text.

Returns: The displayed text.

See also: SetText()

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

◆ VerticalAlignment()

virtual TextVerticalAlign VerticalAlignment ( ) const

pure virtual

Get the vertical alignment of the text.

Returns: Text verical alignment

Implemented in BaseText< T >, and BaseText< OgreGeometry >.

The documentation for this class was generated from the following file:

Text.hh

Gazebo Rendering

API Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Text()

◆ ~Text()

Member Function Documentation

◆ AABB()

◆ Baseline()

◆ CharHeight()

◆ Color()

◆ FontName()

◆ HorizontalAlignment()

◆ SetBaseline()

◆ SetCharHeight()

◆ SetColor()

◆ SetFontName()

◆ SetShowOnTop()

◆ SetSpaceWidth()

◆ SetTextAlignment()

◆ SetTextString()

◆ ShowOnTop()

◆ SpaceWidth()

◆ TextString()

◆ VerticalAlignment()