VgIconMarkerDescriptor Class Reference

Inheritance diagram for VgIconMarkerDescriptor:

Public Member Functions
void	setMIcon (VgITextureRefPtr value)
VgITextureRefPtr	getMIcon ()
void	setMScale (float value)
float	getMScale ()
void	setMColor (VgColor value)
VgColor	getMColor ()
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 VgIconMarkerDescriptorRefPtr	create ()

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

Member Function Documentation

static VgIconMarkerDescriptorRefPtr VgIconMarkerDescriptor.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 VgIconMarkerDescriptor.getMColor

(

)

VgITextureRefPtr VgIconMarkerDescriptor.getMIcon

(

)

float VgIconMarkerDescriptor.getMScale

(

)

VgMarkerType VgIconMarkerDescriptor.getType

(

)

Returns

the type of marker

References VgMarkerType.swigToEnum().

void VgIconMarkerDescriptor.setMColor

(

VgColor

value

)

void VgIconMarkerDescriptor.setMIcon

(

VgITextureRefPtr

value

)

void VgIconMarkerDescriptor.setMScale

(

float

value

)

---

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

• VgIconMarkerDescriptor.java