VgIconMarkerDescriptorRefPtr Class Reference

Public Member Functions
	VgIconMarkerDescriptorRefPtr ()
	VgIconMarkerDescriptorRefPtr (VgIconMarkerDescriptor pPointer)
	VgIconMarkerDescriptorRefPtr (VgIconMarkerDescriptorRefPtr pRefPtr)
VgIconMarkerDescriptorRefPtr	set (VgIconMarkerDescriptor pPointer)
VgIconMarkerDescriptor	__ref__ ()
VgIconMarkerDescriptor	__deref__ ()
VgIconMarkerDescriptor	get ()
boolean	isValid ()
VgIconMarkerDescriptorRefPtr	create ()
void	setMIcon (VgITextureRefPtr value)
VgITextureRefPtr	getMIcon ()
void	setMScale (float value)
float	getMScale ()
void	setMColor (VgColor value)
VgColor	getMColor ()
VgMarkerType	getType ()
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgIconMarkerDescriptorRefPtr	getNull ()

Detailed Description

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

...
VgApplication::VgIApplication* mVgApplication;
VgEngine::VgRefPtr< VgEngine::VgITexture > mTexture;
...

// Allocate a VgIconMarkerDescriptor object
VgEngine::VgRefPtr< Vg3DModule::VgIconMarkerDescriptor > lIconMarkerDescriptor = Vg3DModule::VgIconMarkerDescriptor::create();

// Change the scale
lIconMarkerDescr.mScale = 10.f;
lIconMarkerDescr.mIcon = mTexture.get();
...

Version

2.0

2.1.3 Updated documentation

Constructor & Destructor Documentation

VgIconMarkerDescriptorRefPtr.VgIconMarkerDescriptorRefPtr

(

)

VgIconMarkerDescriptorRefPtr.VgIconMarkerDescriptorRefPtr

(

VgIconMarkerDescriptor

pPointer

)

VgIconMarkerDescriptorRefPtr.VgIconMarkerDescriptorRefPtr

(

VgIconMarkerDescriptorRefPtr

pRefPtr

)

Member Function Documentation

VgIconMarkerDescriptor VgIconMarkerDescriptorRefPtr.__deref__

(

)

VgIconMarkerDescriptor VgIconMarkerDescriptorRefPtr.__ref__

(

)

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

VgIconMarkerDescriptor VgIconMarkerDescriptorRefPtr.get

(

)

VgColor VgIconMarkerDescriptorRefPtr.getMColor

(

)

VgITextureRefPtr VgIconMarkerDescriptorRefPtr.getMIcon

(

)

float VgIconMarkerDescriptorRefPtr.getMScale

(

)

int VgIconMarkerDescriptorRefPtr.getNbReferences

(

)

static VgIconMarkerDescriptorRefPtr VgIconMarkerDescriptorRefPtr.getNull ( )

static

VgMarkerType VgIconMarkerDescriptorRefPtr.getType

(

)

Returns

the type of marker

References VgMarkerType.swigToEnum().

boolean VgIconMarkerDescriptorRefPtr.isValid

(

)

void VgIconMarkerDescriptorRefPtr.ref

(

)

VgIconMarkerDescriptorRefPtr VgIconMarkerDescriptorRefPtr.set

(

VgIconMarkerDescriptor

pPointer

)

void VgIconMarkerDescriptorRefPtr.setMColor

(

VgColor

value

)

void VgIconMarkerDescriptorRefPtr.setMIcon

(

VgITextureRefPtr

value

)

void VgIconMarkerDescriptorRefPtr.setMScale

(

float

value

)

int VgIconMarkerDescriptorRefPtr.unref

(

)

---

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

• VgIconMarkerDescriptorRefPtr.java