eVision::Easy3D::TextLabel Class Reference

A class representing a text label that can be displayed using E3DViewer. More...

#include <eVision/Easy3D/TextLabel.h>

Collaboration diagram for eVision::Easy3D::TextLabel:

Public Member Functions
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, float posX, float posY, eVision::EC24 color, float size, const std::string &text, bool displayAnchor, eVision::EC24A backgroundColor, eVision::Easy3D::ETextLabelAlignment alignment)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, float posX, float posY, eVision::EC24 color, float size, const std::string &text, bool displayAnchor, eVision::EC24A backgroundColor)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, float posX, float posY, eVision::EC24 color, float size, const std::string &text, bool displayAnchor)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, float posX, float posY, eVision::EC24 color, float size, const std::string &text)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, eVision::EC24 color, float size, const std::string &text, bool fixLabelPosition, bool displayAnchor, eVision::EC24A backgroundColor, eVision::Easy3D::ETextLabelAlignment alignment)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, eVision::EC24 color, float size, const std::string &text, bool fixLabelPosition, bool displayAnchor, eVision::EC24A backgroundColor)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, eVision::EC24 color, float size, const std::string &text, bool fixLabelPosition, bool displayAnchor)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, eVision::EC24 color, float size, const std::string &text, bool fixLabelPosition)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::E3DPoint &anchor, eVision::EC24 color, float size, const std::string &text)
	Constructs a text label.
	TextLabel (float posX, float posY, eVision::EC24 color, float size, const std::string &text, eVision::EC24A backgroundColor, eVision::Easy3D::ETextLabelAlignment alignment)
	Constructs a text label.
	TextLabel (float posX, float posY, eVision::EC24 color, float size, const std::string &text, eVision::EC24A backgroundColor)
	Constructs a text label.
	TextLabel (float posX, float posY, eVision::EC24 color, float size, const std::string &text)
	Constructs a text label.
	TextLabel (const eVision::Easy3D::TextLabel &other)
	Constructs a text label.
virtual	~TextLabel () throw ()
eVision::Easy3D::TextLabel &	operator= (const eVision::Easy3D::TextLabel &other)
	Assignment operator.
eVision::Easy3D::E3DPoint	GetAnchor () const
	The E3DPoint linked to the text label.
void	SetAnchor (eVision::Easy3D::E3DPoint value)
	The E3DPoint linked to the text label.
float	GetPosX () const
	The x coordinate of the text box. Value between -1 (left) and 1 (right).
void	SetPosX (float value)
	The x coordinate of the text box. Value between -1 (left) and 1 (right).
float	GetPosY () const
	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
void	SetPosY (float value)
	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
eVision::EC24	GetColor () const
	The color of the text label.
void	SetColor (eVision::EC24 value)
	The color of the text label.
float	GetSize () const
	The size of the text font. Value between 0 et 1.
void	SetSize (float value)
	The size of the text font. Value between 0 et 1.
std::string	GetText () const
	The text of the text label.
void	SetText (const std::string &value)
	The text of the text label.
bool	GetDisplayAnchor () const
	If set to true, a line is drawn between the anchor and the label.
void	SetDisplayAnchor (bool value)
	If set to true, a line is drawn between the anchor and the label.
bool	GetFixed () const
	If set to true, the label stays fixed when the view changes.
void	SetFixed (bool value)
	If set to true, the label stays fixed when the view changes.
eVision::EC24A	GetBackgroundColor () const
	The background of the label is set to this color.
void	SetBackgroundColor (eVision::EC24A value)
	The background of the label is set to this color.
eVision::Easy3D::ETextLabelAlignment	GetAlignment () const
	The alignment of the label.
void	SetAlignment (eVision::Easy3D::ETextLabelAlignment value)
	The alignment of the label.
	TextLabel (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

A class representing a text label that can be displayed using E3DViewer.

License(s): Easy3D

Constructor & Destructor Documentation

TextLabel() [1/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		float	posX,
		float	posY,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		bool	displayAnchor,
		eVision::EC24A	backgroundColor,
		eVision::Easy3D::ETextLabelAlignment	alignment )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
posX	The x coordinate of the text box. Value between -1 (left) and 1 (right).
posY	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
displayAnchor	If set to true, a line is drawn between the anchor and the label (default: true).
backgroundColor	If specified, the background of the label is set to this color (default: black).
alignment	The alignment of the label. (Defaults to FromPosition.)

TextLabel() [2/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		float	posX,
		float	posY,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		bool	displayAnchor,
		eVision::EC24A	backgroundColor )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
posX	The x coordinate of the text box. Value between -1 (left) and 1 (right).
posY	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
displayAnchor	If set to true, a line is drawn between the anchor and the label (default: true).
backgroundColor	If specified, the background of the label is set to this color (default: black).

TextLabel() [3/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		float	posX,
		float	posY,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		bool	displayAnchor )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
posX	The x coordinate of the text box. Value between -1 (left) and 1 (right).
posY	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
displayAnchor	If set to true, a line is drawn between the anchor and the label (default: true).

TextLabel() [4/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		float	posX,
		float	posY,
		eVision::EC24	color,
		float	size,
		const std::string &	text )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
posX	The x coordinate of the text box. Value between -1 (left) and 1 (right).
posY	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.

TextLabel() [5/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		bool	fixLabelPosition,
		bool	displayAnchor,
		eVision::EC24A	backgroundColor,
		eVision::Easy3D::ETextLabelAlignment	alignment )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
fixLabelPosition	If set to true, the label stays fixed when the view changes (default: false).
displayAnchor	If set to true, a line is drawn between the anchor and the label (default: true).
backgroundColor	If specified, the background of the label is set to this color (default: black).
alignment	The alignment of the label. (Defaults to FromPosition.)

TextLabel() [6/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		bool	fixLabelPosition,
		bool	displayAnchor,
		eVision::EC24A	backgroundColor )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
fixLabelPosition	If set to true, the label stays fixed when the view changes (default: false).
displayAnchor	If set to true, a line is drawn between the anchor and the label (default: true).
backgroundColor	If specified, the background of the label is set to this color (default: black).

TextLabel() [7/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		bool	fixLabelPosition,
		bool	displayAnchor )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
fixLabelPosition	If set to true, the label stays fixed when the view changes (default: false).
displayAnchor	If set to true, a line is drawn between the anchor and the label (default: true).

TextLabel() [8/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		bool	fixLabelPosition )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
fixLabelPosition	If set to true, the label stays fixed when the view changes (default: false).

TextLabel() [9/14]

eVision::Easy3D::TextLabel::TextLabel	(	const eVision::Easy3D::E3DPoint &	anchor,
		eVision::EC24	color,
		float	size,
		const std::string &	text )

Constructs a text label.

Parameters

anchor	The E3DPoint linked to the text label.
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.

TextLabel() [10/14]

eVision::Easy3D::TextLabel::TextLabel	(	float	posX,
		float	posY,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		eVision::EC24A	backgroundColor,
		eVision::Easy3D::ETextLabelAlignment	alignment )

Constructs a text label.

Parameters

posX	The x coordinate of the text box. Value between -1 (left) and 1 (right).
posY	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
backgroundColor	If specified, the background of the label is set to this color (default: black).
alignment	The alignment of the label. (Defaults to FromPosition.)

TextLabel() [11/14]

eVision::Easy3D::TextLabel::TextLabel	(	float	posX,
		float	posY,
		eVision::EC24	color,
		float	size,
		const std::string &	text,
		eVision::EC24A	backgroundColor )

Constructs a text label.

Parameters

posX	The x coordinate of the text box. Value between -1 (left) and 1 (right).
posY	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.
backgroundColor	If specified, the background of the label is set to this color (default: black).

TextLabel() [12/14]

eVision::Easy3D::TextLabel::TextLabel	(	float	posX,
		float	posY,
		eVision::EC24	color,
		float	size,
		const std::string &	text )

Constructs a text label.

Parameters

posX	The x coordinate of the text box. Value between -1 (left) and 1 (right).
posY	The y coordinate of the text box. Value between -1 (bottom) and 1 (top).
color	The color of the text label.
size	The size of the text font. Value between 0 et 1.
text	The text of the text label.

TextLabel() [13/14]

eVision::Easy3D::TextLabel::TextLabel

(

const eVision::Easy3D::TextLabel &

other

)

Constructs a text label.

Parameters

other

The other TextLabel that we will copy into this one.

~TextLabel()

eVision::Easy3D::TextLabel::~TextLabel ( ) throw (  )

virtual

TextLabel() [14/14]

eVision::Easy3D::TextLabel::TextLabel

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetAlignment()

eVision::Easy3D::ETextLabelAlignment eVision::Easy3D::TextLabel::GetAlignment

(

)

const

The alignment of the label.

GetAnchor()

eVision::Easy3D::E3DPoint eVision::Easy3D::TextLabel::GetAnchor

(

)

const

The E3DPoint linked to the text label.

GetBackgroundColor()

eVision::EC24A eVision::Easy3D::TextLabel::GetBackgroundColor

(

)

const

The background of the label is set to this color.

GetColor()

eVision::EC24 eVision::Easy3D::TextLabel::GetColor

(

)

const

The color of the text label.

GetDisplayAnchor()

bool eVision::Easy3D::TextLabel::GetDisplayAnchor

(

)

const

If set to true, a line is drawn between the anchor and the label.

GetFixed()

bool eVision::Easy3D::TextLabel::GetFixed

(

)

const

If set to true, the label stays fixed when the view changes.

GetPosX()

float eVision::Easy3D::TextLabel::GetPosX

(

)

const

The x coordinate of the text box. Value between -1 (left) and 1 (right).

GetPosY()

float eVision::Easy3D::TextLabel::GetPosY

(

)

const

The y coordinate of the text box. Value between -1 (bottom) and 1 (top).

GetSize()

float eVision::Easy3D::TextLabel::GetSize

(

)

const

The size of the text font. Value between 0 et 1.

GetText()

std::string eVision::Easy3D::TextLabel::GetText

(

)

const

The text of the text label.

operator=()

eVision::Easy3D::TextLabel & eVision::Easy3D::TextLabel::operator=

(

const eVision::Easy3D::TextLabel &

other

)

Assignment operator.

Parameters

other

The other TextLabel that we will copy into this one.

SetAlignment()

void eVision::Easy3D::TextLabel::SetAlignment

(

eVision::Easy3D::ETextLabelAlignment

value

)

The alignment of the label.

SetAnchor()

void eVision::Easy3D::TextLabel::SetAnchor

(

eVision::Easy3D::E3DPoint

value

)

The E3DPoint linked to the text label.

SetBackgroundColor()

void eVision::Easy3D::TextLabel::SetBackgroundColor

(

eVision::EC24A

value

)

The background of the label is set to this color.

SetColor()

void eVision::Easy3D::TextLabel::SetColor

(

eVision::EC24

value

)

The color of the text label.

SetDisplayAnchor()

void eVision::Easy3D::TextLabel::SetDisplayAnchor

(

bool

value

)

If set to true, a line is drawn between the anchor and the label.

SetFixed()

void eVision::Easy3D::TextLabel::SetFixed

(

bool

value

)

If set to true, the label stays fixed when the view changes.

SetPosX()

void eVision::Easy3D::TextLabel::SetPosX

(

float

value

)

The x coordinate of the text box. Value between -1 (left) and 1 (right).

Parameters

value

The new value of the x position.

SetPosY()

void eVision::Easy3D::TextLabel::SetPosY

(

float

value

)

The y coordinate of the text box. Value between -1 (bottom) and 1 (top).

Parameters

value

The new value of the y position.

SetSize()

void eVision::Easy3D::TextLabel::SetSize

(

float

value

)

The size of the text font. Value between 0 et 1.

SetText()

void eVision::Easy3D::TextLabel::SetText

(

const std::string &

value

)

The text of the text label.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::Easy3D::TextLabel::wrappedClass_