Vg3DModule::VgGeometryDescriptor Struct Reference

Describes the common properties used to create a VgIGeometry object. More...

Inheritance diagram for Vg3DModule::VgGeometryDescriptor:

Public Attributes
double	mVisibilityRampStartVisible
	Distance in meters at which it starts becoming visible. More...
double	mVisibilityRampFullyVisible
	Distance in meters at which it is fully visible. More...
double	mVisibilityRampStartInvisible
	Distance in meters at which it starts to become invisible. More...
double	mVisibilityRampFullyInvisible
	Distance in meters at which it is fully invisible. More...
int	mZIndex
	This member sets the z-index of the line. More...
bool	mDrawOnTop
	Tells whether the line should draw on top (ignoring z-buffer). More...
float	mScale
	VgIGeometry's initial scale. More...
bool	mNotifyPOISelectedOnClick
	Call VgMapModule::VgIPlaceListener if the VgIGeometry has non-empty ID and is clicked This will be called after all the VgIGeometry callbacks have been called. More...

Protected Member Functions
	VgGeometryDescriptor ()
	Constructor. More...
virtual	~VgGeometryDescriptor ()
	Destructor. More...

Additional Inherited Members
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...
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences
	The number of references to this object. More...

Detailed Description

Describes the common properties used to create a VgIGeometry object.

Remarks

Once the VgIGeometry object is created, the VgGeometryDescriptor "visibility" members are stored within a VgEngine::VgVisibilityRamp structure.

Version

2.0.9263

Constructor & Destructor Documentation

Vg3DModule::VgGeometryDescriptor::VgGeometryDescriptor ( )

inlineprotected

Constructor.

Note

Do not use this constructor directly. Instead, use the static subclass method, create().

virtual Vg3DModule::VgGeometryDescriptor::~VgGeometryDescriptor ( )

inlineprotectedvirtual

Destructor.

Member Data Documentation

bool Vg3DModule::VgGeometryDescriptor::mDrawOnTop

Tells whether the line should draw on top (ignoring z-buffer).

The default value of this property is false.

bool Vg3DModule::VgGeometryDescriptor::mNotifyPOISelectedOnClick

Call VgMapModule::VgIPlaceListener if the VgIGeometry has non-empty ID and is clicked This will be called after all the VgIGeometry callbacks have been called.

The default value is true if the ID of the object is non empty, false otherwise.

Version

2.1.3

See Also

VgMapModule::VgIMapModule::addListener

VgMapModule::VgIPlaceListener

float Vg3DModule::VgGeometryDescriptor::mScale

VgIGeometry's initial scale.

The default value of this property is 1.0f.

Version

2.1.0

double Vg3DModule::VgGeometryDescriptor::mVisibilityRampFullyInvisible

Distance in meters at which it is fully invisible.

By default +infinity. If set to a very large value, it will never fade out.

The default value of this property is 5000.

double Vg3DModule::VgGeometryDescriptor::mVisibilityRampFullyVisible

Distance in meters at which it is fully visible.

If set to 0.0, it is always visble when you are close.

The default value of this property is 5.0.

double Vg3DModule::VgGeometryDescriptor::mVisibilityRampStartInvisible

Distance in meters at which it starts to become invisible.

The default value of this property is 3000.

double Vg3DModule::VgGeometryDescriptor::mVisibilityRampStartVisible

Distance in meters at which it starts becoming visible.

If set to 0.0, it is always visble no matter how close you are.

The default value of this property is 2.0.

int Vg3DModule::VgGeometryDescriptor::mZIndex

This member sets the z-index of the line.

This is used to solve cases where translucent objects can not be sorted correctly. Forces a rendering order (only used on translucent objects). Smaller values (can be negative) lead to object appearing "over" the others.

---

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

• VgIGeometry.h