VgTextMarkerDescriptorRefPtr Class Reference

Public Member Functions
	VgTextMarkerDescriptorRefPtr ()
	VgTextMarkerDescriptorRefPtr (VgTextMarkerDescriptor pPointer)
	VgTextMarkerDescriptorRefPtr (VgTextMarkerDescriptorRefPtr pRefPtr)
VgTextMarkerDescriptorRefPtr	set (VgTextMarkerDescriptor pPointer)
VgTextMarkerDescriptor	__ref__ ()
VgTextMarkerDescriptor	__deref__ ()
VgTextMarkerDescriptor	get ()
boolean	isValid ()
VgTextMarkerDescriptorRefPtr	create ()
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 ()
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgTextMarkerDescriptorRefPtr	getNull ()

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

VgTextMarkerDescriptorRefPtr.VgTextMarkerDescriptorRefPtr

(

)

VgTextMarkerDescriptorRefPtr.VgTextMarkerDescriptorRefPtr

(

VgTextMarkerDescriptor

pPointer

)

VgTextMarkerDescriptorRefPtr.VgTextMarkerDescriptorRefPtr

(

VgTextMarkerDescriptorRefPtr

pRefPtr

)

Member Function Documentation

VgTextMarkerDescriptor VgTextMarkerDescriptorRefPtr.__deref__

(

)

VgTextMarkerDescriptor VgTextMarkerDescriptorRefPtr.__ref__

(

)

VgTextMarkerDescriptorRefPtr VgTextMarkerDescriptorRefPtr.create

(

)

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.

VgTextMarkerDescriptor VgTextMarkerDescriptorRefPtr.get

(

)

VgColor VgTextMarkerDescriptorRefPtr.getMColor

(

)

double VgTextMarkerDescriptorRefPtr.getMScale

(

)

String VgTextMarkerDescriptorRefPtr.getMText

(

)

long VgTextMarkerDescriptorRefPtr.getMTextAttributesMask

(

)

int VgTextMarkerDescriptorRefPtr.getNbReferences

(

)

static VgTextMarkerDescriptorRefPtr VgTextMarkerDescriptorRefPtr.getNull ( )

static

VgMarkerType VgTextMarkerDescriptorRefPtr.getType

(

)

Returns

the type of marker

References VgMarkerType.swigToEnum().

boolean VgTextMarkerDescriptorRefPtr.isValid

(

)

void VgTextMarkerDescriptorRefPtr.ref

(

)

VgTextMarkerDescriptorRefPtr VgTextMarkerDescriptorRefPtr.set

(

VgTextMarkerDescriptor

pPointer

)

void VgTextMarkerDescriptorRefPtr.setMColor

(

VgColor

value

)

void VgTextMarkerDescriptorRefPtr.setMScale

(

double

value

)

void VgTextMarkerDescriptorRefPtr.setMText

(

String

value

)

void VgTextMarkerDescriptorRefPtr.setMTextAttributesMask

(

long

value

)

int VgTextMarkerDescriptorRefPtr.unref

(

)

---

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

• VgTextMarkerDescriptorRefPtr.java