iDynTree::ILabel class
#include <iDynTree/Visualizer.h>

The interface to add a label in the visualizer.

Constructors, destructors, conversion operators

~ILabel() pure virtual
Destructor.

Public functions

void setText(const std::string& text) pure virtual
Set the text of the label.
auto getText() const -> std::string pure virtual
Get the label text.
void setSize(float height) pure virtual
Set the height of the label.
void setSize(float width, float height) pure virtual
Set the width and the height of the label.
auto width() const -> float pure virtual
Get the width of the label.
auto height() const -> float pure virtual
Get the height of the label.
void setPosition(const iDynTree::Position& position) pure virtual
Set the position of the label.
auto getPosition() const -> iDynTree::Position pure virtual
Get the position of the label.
void setColor(const iDynTree::ColorViz& color) pure virtual
Set the color of the label.
void setVisible(bool visible = true) pure virtual
Set the visibility of the label.

Function documentation

void iDynTree::ILabel::setText(const std::string& text) pure virtual

Set the text of the label.

Parameters
text The text to be displayed

std::string iDynTree::ILabel::getText() const pure virtual

Get the label text.

Returns The text shown in the label.

void iDynTree::ILabel::setSize(float height) pure virtual

Set the height of the label.

Parameters
height The height to be set

The width is computed automatically

void iDynTree::ILabel::setSize(float width, float height) pure virtual

Set the width and the height of the label.

Parameters
width The width of the label
height The height of the label

float iDynTree::ILabel::width() const pure virtual

Get the width of the label.

Returns The width of the label

float iDynTree::ILabel::height() const pure virtual

Get the height of the label.

Returns The height of the label

void iDynTree::ILabel::setPosition(const iDynTree::Position& position) pure virtual

Set the position of the label.

Parameters
position The position of the label

iDynTree::Position iDynTree::ILabel::getPosition() const pure virtual

Get the position of the label.

Returns The position of the label

void iDynTree::ILabel::setColor(const iDynTree::ColorViz& color) pure virtual

Set the color of the label.

Parameters
color The color of the label

void iDynTree::ILabel::setVisible(bool visible = true) pure virtual

Set the visibility of the label.

Parameters
visible The visibility of the label