Vg3DModule::VgTextMarkerDescriptor Struct Reference

Inheritance diagram for Vg3DModule::VgTextMarkerDescriptor:

Public Member Functions
const VgMarkerType	getType () const
Public Member Functions inherited from Vg3DModule::VgMarkerDescriptor
virtual	~VgMarkerDescriptor ()
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	VgReferenced (const VgReferenced &pThis)
virtual	~VgReferenced ()
VgReferenced &	operator= (const VgReferenced &pThis)
void	ref () const
int	unref () const
int	getNbReferences () const

Static Public Member Functions
static VgEngine::VgRefPtr< Vg3DModule::VgTextMarkerDescriptor >	create ()

Public Attributes
std::string	mText
unsigned int	mTextAttributesMask
VgEngine::VgColor	mColor
double	mScale

Protected Member Functions
	VgTextMarkerDescriptor ()
virtual	~VgTextMarkerDescriptor ()

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

Detailed Description

Describes a text marker. The text will be displayed at the point associated. This descriptor will instanciate a VgTextMarker after the call to VgEngine::VgInstanceFactory::instantiate(VgPointDescriptor const&)

...
VgApplication::VgIApplication* mVgApplication;
...

// Allocate a VgTextMarkerDescriptor object
VgEngine::VgRefPtr< Vg3DModule::VgTextMarkerDescriptor > lTextMarkerDescriptor = Vg3DModule::VgTextMarkerDescriptor::create();

// Change the scale
lTextMarkerDescriptor.mScale = 10.f;
lTextMarkerDescriptor.mText = "hello";
...

Version

2.0

2.1.3 Updated documentation

Constructor & Destructor Documentation

Vg3DModule::VgTextMarkerDescriptor::VgTextMarkerDescriptor ( )

inlineprotected

Constructor

References ~VgTextMarkerDescriptor().

virtual Vg3DModule::VgTextMarkerDescriptor::~VgTextMarkerDescriptor ( )

protectedvirtual

Destructor

Referenced by VgTextMarkerDescriptor().

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, default white VgColor(1.0f,1.0f,1.0f,1.0f)

double Vg3DModule::VgTextMarkerDescriptor::mScale

Controls the size of the VgTextMarker in meters if the Vg3DModule::VgPointDescriptor::mSizePolicy is VgEngine::eVgSizePolicyConstantScale, by default 1.0. if Vg3DModule::VgPointDescriptor::mSizePolicy is VgEngine::eVgSizePolicyFitRectangle, will only impact the size relationship of the text marker to other markers on the VgPoint if any. The visible size is also determined by the distance of the POI from the camera (Vg3DModule::VgPointDescriptor::mGeometryConstantSizeDistance) as well as the scale of the VgPoint (Vg3DModule::VgGeometryDescriptor::mScale).

Version

2.1.0 changed default from 70.0 to 1.0, updated documentation.

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 eVgTextAttributeNone.

---

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

• VgTextMarkerDescriptor.h