Vg3DModule::VgTextMarkerDescriptor Struct Reference

Describes a text marker. More...

Inheritance diagram for Vg3DModule::VgTextMarkerDescriptor:

Public Member Functions
const VgMarkerType	getType () const
Public Member Functions inherited from Vg3DModule::VgMarkerDescriptor
virtual	~VgMarkerDescriptor ()
	Destructor. 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...
void	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...

Static Public Member Functions
static VgEngine::VgRefPtr < Vg3DModule::VgTextMarkerDescriptor >	create ()
	This static method returns a new heap-allocated descriptor. More...

Public Attributes
std::string	mText
	The POI's label. More...
unsigned int	mTextAttributesMask
	Text attributes. More...
VgEngine::VgColor	mColor
	The text's color. More...
double	mScale
	Controls the size of the POI in meters, by default 70.0. More...

Protected Member Functions
	VgTextMarkerDescriptor ()
	Constructor. More...
virtual	~VgTextMarkerDescriptor ()
	Destructor. More...

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

Detailed Description

Describes a text marker.

The text will be displayed at the point associated.

Version

2.0

Constructor & Destructor Documentation

Vg3DModule::VgTextMarkerDescriptor::VgTextMarkerDescriptor ( )

inlineprotected

Constructor.

virtual Vg3DModule::VgTextMarkerDescriptor::~VgTextMarkerDescriptor ( )

protectedvirtual

Destructor.

Member Function Documentation

static VgEngine::VgRefPtr< Vg3DModule::VgTextMarkerDescriptor > Vg3DModule::VgTextMarkerDescriptor::create ( )

static

This static method returns a new heap-allocated descriptor.

It is the only method that should be used to instantiate new descriptors. It is a way to make sure no one will delete it, except the last VgRefPtr pointing to it.

const VgMarkerType Vg3DModule::VgTextMarkerDescriptor::getType ( ) const

inlinevirtual

Returns

the type of marker

Implements Vg3DModule::VgMarkerDescriptor.

References Vg3DModule::eVgMarkerText.

Member Data Documentation

VgEngine::VgColor Vg3DModule::VgTextMarkerDescriptor::mColor

The text's color.

double Vg3DModule::VgTextMarkerDescriptor::mScale

Controls the size of the POI in meters, by default 70.0.

The visible size can also be determined by the distance of the POI from the camera, see the property mGeometryConstantSizeDistance.

std::string Vg3DModule::VgTextMarkerDescriptor::mText

The POI's label.

If an icon is defined, the icon will be placed on the left side of the label, with horizontal centers aligned By default this property is an empty string.

unsigned int Vg3DModule::VgTextMarkerDescriptor::mTextAttributesMask

Text attributes.

You specify the value of this mask by combining the constants described in VgEngine::VgTextAttributes using the C bitwise OR operator. Combining these constants lets you specify which attributes should be associated with the text. The default value of this property is eTextAttributeNone.

---

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

• VgTextMarkerDescriptor.h