Vg3DModule::VgTextMarker Class Reference

Displays text as a marker of a VgPoint. More...

Inheritance diagram for Vg3DModule::VgTextMarker:

Public Member Functions
	VgTextMarker ()
	Constructor. More...
virtual	~VgTextMarker ()
	Desctructor. More...
virtual VgTextMarker *	asTextMarker ()
const std::string	getText () const
bool	setText (const std::string &pText)
	Sets a new text. More...
const unsigned int	getTextAttributes () const
bool	setTextAttributes (const unsigned int pAttributesMask)
	Sets text's attributes. More...
const VgEngine::VgColor	getColor () const
void	setColor (const VgEngine::VgColor &pColor)
	Sets a new color. More...
const float	getScale () const
void	setScale (const float pScale)
	Sets the scale. More...
Public Member Functions inherited from Vg3DModule::VgMarker
virtual	~VgMarker ()
	Desctructor. More...
virtual VgIconMarker *	asIconMarker ()
	Casts this instance into a VgIconMarker. More...
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	Constructor. More...
	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...
virtual	~VgReferenced ()
	Destructor. More...
VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...
void	ref () const
	This method is used to add a reference to this object. More...
int	unref () const
	This method is used to remove a reference to this object. More...
int	getNbReferences () const
	Retrieves the number of references to this object. More...

Friends
class	VgEngine::VgObjectBridge

Additional Inherited Members
Protected Member Functions inherited from Vg3DModule::VgMarker
	VgMarker ()
	Constructor. More...
Protected Attributes inherited from Vg3DModule::VgMarker
Private *	mPrivate
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

Detailed Description

Displays text as a marker of a VgPoint.

Note

Do not instantiate this class manually. Use its associated descriptor instead (Vg3DModule::VgTextMarkerDescriptor)

Version

2.0

Constructor & Destructor Documentation

Vg3DModule::VgTextMarker::VgTextMarker

(

)

Constructor.

virtual Vg3DModule::VgTextMarker::~VgTextMarker ( )

virtual

Desctructor.

Member Function Documentation

virtual VgTextMarker* Vg3DModule::VgTextMarker::asTextMarker ( )

virtual

Returns

this.

Reimplemented from Vg3DModule::VgMarker.

const VgEngine::VgColor Vg3DModule::VgTextMarker::getColor

(

)

const

Returns

the text color.

Version

2.0.9263

const float Vg3DModule::VgTextMarker::getScale

(

)

const

Returns

the text scale.

Version

2.0.9263

const std::string Vg3DModule::VgTextMarker::getText

(

)

const

Returns

the text of this marker.

Version

2.0.9263

const unsigned int Vg3DModule::VgTextMarker::getTextAttributes

(

)

const

Returns

text's attributes.

Version

2.0.9263

void Vg3DModule::VgTextMarker::setColor

(

const VgEngine::VgColor &

pColor

)

Sets a new color.

Version

2.0.9263

void Vg3DModule::VgTextMarker::setScale

(

const float

pScale

)

Sets the scale.

Version

2.0.9263

bool Vg3DModule::VgTextMarker::setText

(

const std::string &

pText

)

Sets a new text.

Version

2.0.9263

bool Vg3DModule::VgTextMarker::setTextAttributes

(

const unsigned int

pAttributesMask

)

Sets text's attributes.

Version

2.0.9263

Friends And Related Function Documentation

friend class VgEngine::VgObjectBridge

friend

---

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

• VgTextMarker.h