VgTextMarkerDescriptor Class Reference

Inheritance diagram for VgTextMarkerDescriptor:

Public Member Functions
void	setMText (String value)
String	getMText ()
void	setMTextAttributesMask (long value)
long	getMTextAttributesMask ()
void	setMColor (VgColor value)
VgColor	getMColor ()
void	setMScale (double value)
double	getMScale ()
VgMarkerType	getType ()
Public Member Functions inherited from VgMarkerDescriptor
VgMarkerType	getType ()
Public Member Functions inherited from VgReferenced
synchronized void	release ()
	VgReferenced ()
	VgReferenced (VgReferenced pThis)
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgTextMarkerDescriptorRefPtr	create ()

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

Member Function Documentation

static VgTextMarkerDescriptorRefPtr 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.

VgColor VgTextMarkerDescriptor.getMColor

(

)

double VgTextMarkerDescriptor.getMScale

(

)

String VgTextMarkerDescriptor.getMText

(

)

long VgTextMarkerDescriptor.getMTextAttributesMask

(

)

VgMarkerType VgTextMarkerDescriptor.getType

(

)

Returns

the type of marker

References VgMarkerType.swigToEnum().

void VgTextMarkerDescriptor.setMColor

(

VgColor

value

)

void VgTextMarkerDescriptor.setMScale

(

double

value

)

void VgTextMarkerDescriptor.setMText

(

String

value

)

void VgTextMarkerDescriptor.setMTextAttributesMask

(

long

value

)

---

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

• VgTextMarkerDescriptor.java