Vg3DModule::VgIconMarkerDescriptor Struct Reference

Describes an icon marker. More...

Inheritance diagram for Vg3DModule::VgIconMarkerDescriptor:

Collaboration diagram for Vg3DModule::VgIconMarkerDescriptor:

List of all members.

Public Member Functions
const VgMarkerType	getType () const
Static Public Member Functions
static VgEngine::VgRefPtr < Vg3DModule::VgIconMarkerDescriptor >	create ()
	This static method returns a new heap-allocated descriptor.
Public Attributes
VgEngine::VgRefPtr < VgEngine::VgITexture >	mIcon
	The icon's texture.
float	mScale
	Scales the icon (which sides always mesure 1x1 meter), by default 70.0.
Protected Member Functions
	VgIconMarkerDescriptor ()
	Constructor.
virtual	~VgIconMarkerDescriptor ()

---

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
     Vg3DModule::VgIconMarkerDescriptor lIconMarkerDescr;
     
     // Change the scale
     lIconMarkerDescr.mScale = 10.f;
     lIconMarkerDescr.mIcon = mTexture.get();
     ...

Version:

2.0

---

Constructor & Destructor Documentation

Vg3DModule::VgIconMarkerDescriptor::VgIconMarkerDescriptor

(

)

[inline, protected]

Constructor.

virtual Vg3DModule::VgIconMarkerDescriptor::~VgIconMarkerDescriptor

(

)

[protected, virtual]

---

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 [inline, virtual]

Returns:

the type of marker

Implements Vg3DModule::VgMarkerDescriptor.

---

Member Data Documentation

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

The icon's texture.

Note:

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

float Vg3DModule::VgIconMarkerDescriptor::mScale

Scales the icon (which sides always mesure 1x1 meter), by default 70.0.

The visible size can also be determined by the distance of the VgPoint from the camera, see the property VgPointDescriptor::mGeometryConstantSizeDistance for further explanation.

---

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

• VgIconMarkerDescriptor.h