Vg3DModule::VgIconMarkerDescriptor Struct Reference

Describes an icon marker. More...

Inheritance diagram for Vg3DModule::VgIconMarkerDescriptor:

Public Member Functions
const VgMarkerType	getType () const
Public Member Functions inherited from Vg3DModule::VgMarkerDescriptor
virtual	~VgMarkerDescriptor ()
	Destructor. More...
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	Constructor. More...
	VgReferenced (const VgReferenced &pThis)
	Copy constructor. More...
virtual	~VgReferenced ()
	Destructor. More...
VgReferenced &	operator= (const VgReferenced &pThis)
	Assignment operator. More...
void	ref () const
	This method is used to add a reference to this object. More...
int	unref () const
	This method is used to remove a reference to this object. More...
int	getNbReferences () const
	Retrieves the number of references to this object. More...

Static Public Member Functions
static VgEngine::VgRefPtr < Vg3DModule::VgIconMarkerDescriptor >	create ()
	This static method returns a new heap-allocated descriptor. More...

Public Attributes
VgEngine::VgRefPtr < VgEngine::VgITexture >	mIcon
	The icon's texture. More...
float	mScale
	Controls the size of the VgIconMarker in meters if the Vg3DModule::VgPointDescriptor::mSizePolicy is VgEngine::eVgSizePolicyConstantScale, by default 1.0. More...

Protected Member Functions
	VgIconMarkerDescriptor ()
	Constructor. More...
virtual	~VgIconMarkerDescriptor ()

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

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

Vg3DModule::VgIconMarkerDescriptor::VgIconMarkerDescriptor ( )

inlineprotected

Constructor.

virtual Vg3DModule::VgIconMarkerDescriptor::~VgIconMarkerDescriptor ( )

protectedvirtual

Member Function Documentation

static VgEngine::VgRefPtr< Vg3DModule::VgIconMarkerDescriptor > Vg3DModule::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.

const VgMarkerType Vg3DModule::VgIconMarkerDescriptor::getType ( ) const

inlinevirtual

Returns

the type of marker

Implements Vg3DModule::VgMarkerDescriptor.

References Vg3DModule::eVgMarkerIcon.

Member Data Documentation

VgEngine::VgRefPtr< VgEngine::VgITexture > Vg3DModule::VgIconMarkerDescriptor::mIcon

The icon's texture.

if mIcon is NULL, then the marker and the point will still be created use VgIconMarker::setIcon() to update it later.

Note

When added to the screen, the icon's pixel size is independant from its distance to the camera.

float Vg3DModule::VgIconMarkerDescriptor::mScale

Controls the size of the VgIconMarker 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.

---

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

• VgIconMarkerDescriptor.h