This structure encapsulates the point description parameters. More...

Inheritance diagram for Vg3DModule::VgPointDescriptor:

Collaboration diagram for Vg3DModule::VgPointDescriptor:

Public Types
typedef VgPoint	Described
Static Public Member Functions
static VgEngine::VgRefPtr < Vg3DModule::VgPointDescriptor >	create ()
	This static method returns a new heap-allocated descriptor.
static VgEngine::VgRefPtr < Vg3DModule::VgPointDescriptor >	create (VgEngine::VgRefPtr< Vg3DModule::VgPointDescriptor >const &pOther)
	This static method returns a new heap-allocated descriptor.
Public Attributes
VgEngine::VgPosition	mPosition
	The point's position.
VgEngine::VgAltitudeMode	mAltitudeMode
	The altitude mode tells how to interpret the VgPointDescriptor::mPosition::mZOrAltitude member.
VgEngine::VgAnchorMode	mAnchorPosition
	Controls the anchoring of the point's bounding box with its position.
float	mVisibilityRampStartVisible
	Distance in meters at which the VgPoint starts becoming visible.
float	mVisibilityRampFullyVisible
	Distance in meters at which the VgPoint is fully visible.
float	mVisibilityRampStartInvisible
	Distance in meters at which the VgPoint starts to become invisible.
float	mVisibilityRampFullyInvisible
	Distance in meters at which the VgPoint is fully invisible.
float	mGeometryConstantSizeDistance
	Controls the distance at which the VgPoint does not become bigger as you approach it.
float	mHeading
	Controls the heading of the VgPoint.
float	mPitch
	Controls the pitch of the VgPoint.
float	mRoll
	Controls the roll of the VgPoint.
bool	mForceFrontFace
	In cases where the camera can view the poi from behind, our engine will not display the label.
bool	mDrawOnTop
	In cases where an object is partially or completely hidden by an object in front, our engine will not display it (or partially display it).
VgEngine::VgOrientationType	mHeadingOrientationType
	Controls the orientation type of the Heading.
VgEngine::VgOrientationType	mPitchOrientationType
	Controls the orientation type of the Heading.
VgEngine::VgOrientationType	mRollOrientationType
	Controls the orientation type of the Roll.
std::vector < VgEngine::VgRefPtr < VgMarkerDescriptor > >	mMarkerDescriptors
	A vector of VgMarkerDescriptors which determine what markers and how many of them are associated with this VgPoint.
int	mZIndex
	This member sets the z-index of the point.
Protected Member Functions
	VgPointDescriptor ()
	Constructor.
	VgPointDescriptor (const VgPointDescriptor &pDescriptor)
	Copy Constructor.
	~VgPointDescriptor ()
	Destructor.
Friends
class	VgEngine::VgRefPtr

Detailed Description

This structure encapsulates the point description parameters.

The VgPointDescriptor contains the all the attributes that are useful for describing the behaviour of a VgPoint object.

Below is a code snippet showing how an allocated VgPointDescriptor can be configured:

    ...
    Vg3DModule::VgIconMarkerDescriptor lIconMarkerDesc;
    VgEngine::VgPosition lPos;
    ...
     
    // Allocate a VgPointDescriptor object
    Vg3DModule::VgPointDescriptor lPointDesc;

    // Configure the object
    //
    // Set the point's position anchor.
    lPointDesc.mAnchorPosition= VgEngine::eVgBottomCenter;
     
    // Set the points position
    lPointDesc.mPosition = lPos;
     
    // Associate the marker with VgPointDescriptor.  
    // Note: It's possible to associate several markers with a single point.
    lPointDesc.mMarkerDescriptors.push_back(&lIconMarkerDesc);
    ...

Version:: 2.0

Member Typedef Documentation

typedef VgPoint Vg3DModule::VgPointDescriptor::Described

Constructor & Destructor Documentation

Vg3DModule::VgPointDescriptor::VgPointDescriptor ( ) [inline, protected]

Constructor.

Vg3DModule::VgPointDescriptor::VgPointDescriptor ( const VgPointDescriptor & pDescriptor ) [inline, protected]

Copy Constructor.

Vg3DModule::VgPointDescriptor::~VgPointDescriptor ( ) [protected]

Destructor.

Member Function Documentation

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

static VgEngine::VgRefPtr< Vg3DModule::VgPointDescriptor > Vg3DModule::VgPointDescriptor::create ( VgEngine::VgRefPtr< Vg3DModule::VgPointDescriptor >const & pOther ) [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.

Friends And Related Function Documentation

friend class VgEngine::VgRefPtr [friend]

Member Data Documentation

VgEngine::VgAltitudeMode Vg3DModule::VgPointDescriptor::mAltitudeMode

The altitude mode tells how to interpret the VgPointDescriptor::mPosition::mZOrAltitude member.

Default is eAbsolute.

VgEngine::VgAnchorMode Vg3DModule::VgPointDescriptor::mAnchorPosition

Controls the anchoring of the point's bounding box with its position.

Default is VgEngine::eVgBottomCenter.

Version:: 1.1.6796

bool Vg3DModule::VgPointDescriptor::mDrawOnTop

In cases where an object is partially or completely hidden by an object in front, our engine will not display it (or partially display it).

Default value is false. Setting this to true will always display the VgPoint regardless of whether there are objects in front. This value is related to the concept of Depth Test. The points are drawn back to front.

Version:: 2.0.8744

bool Vg3DModule::VgPointDescriptor::mForceFrontFace

In cases where the camera can view the poi from behind, our engine will not display the label.

For example this will happen if the VgPoint has a fixed orientation (it will not happen if it is always camera facing). Default value is false. Setting this to true will allow to view fixed VgPoints from behind.

float Vg3DModule::VgPointDescriptor::mGeometryConstantSizeDistance

Controls the distance at which the VgPoint does not become bigger as you approach it.

When the camera is within this distance of the VgPoint, the visible size of the VgPoint on the screen will be the same as what it looked like when it was mGeometryConstantSizeDistance meters away. If set to 0.0, the size of the POI will be determined by mScale, regardless of it's distance from the camera. The default value of this property is 700.0.

float Vg3DModule::VgPointDescriptor::mHeading

Controls the heading of the VgPoint.

Default value is 0.0.

Note:: This value is only used if VgPointDescriptor::mHeadingOrientationType takes into account heading.

VgEngine::VgOrientationType Vg3DModule::VgPointDescriptor::mHeadingOrientationType

Controls the orientation type of the Heading.

By default is eVgOrientaitonCameraFacing.

std::vector< VgEngine::VgRefPtr< VgMarkerDescriptor > > Vg3DModule::VgPointDescriptor::mMarkerDescriptors

A vector of VgMarkerDescriptors which determine what markers and how many of them are associated with this VgPoint.

See Vg3DModule::VgMarkerType for a list of available markers.

Note:: It is the responsability of the caller to release the VgMarkerDescriptor objects.

Version:: 2.0

float Vg3DModule::VgPointDescriptor::mPitch

Controls the pitch of the VgPoint.

The valid range is between -90.0 and 90.0. A value of 0, means the VgPoint is facing the horizon. Default value is 0.0.

Note:: This value is only used if VgPointDescriptor::mPitchOrientationType takes into account pitch.

VgEngine::VgOrientationType Vg3DModule::VgPointDescriptor::mPitchOrientationType

Controls the orientation type of the Heading.

By default is eVgOrientaitonCameraFacing.

VgEngine::VgPosition Vg3DModule::VgPointDescriptor::mPosition

The point's position.

float Vg3DModule::VgPointDescriptor::mRoll

Controls the roll of the VgPoint.

The valid range is between -90.0 and 90.0. A value of 0, means the VgPoint is straight. Default value is 0.0.

Note:: This value is only used if VgPointDescriptor::mRollOrientationType takes into account roll.

VgEngine::VgOrientationType Vg3DModule::VgPointDescriptor::mRollOrientationType

Controls the orientation type of the Roll.

By default is eVgOrientationFixedModulo180degrees.

float Vg3DModule::VgPointDescriptor::mVisibilityRampFullyInvisible

Distance in meters at which the VgPoint is fully invisible.

By default 5000 meters. If set to a very large value, VgPoint will never fade out.

float Vg3DModule::VgPointDescriptor::mVisibilityRampFullyVisible

Distance in meters at which the VgPoint is fully visible.

If set to 0.0, the VgPoint is always visble when you are close. The default value of this property is 5.0.

float Vg3DModule::VgPointDescriptor::mVisibilityRampStartInvisible

Distance in meters at which the VgPoint starts to become invisible.

By default 3000 meters

float Vg3DModule::VgPointDescriptor::mVisibilityRampStartVisible

Distance in meters at which the VgPoint starts becoming visible.

If set to 0.0, the VgPoint is always visble no matter how close you are. The default value of this property is 2.0.

int Vg3DModule::VgPointDescriptor::mZIndex

This member sets the z-index of the point.

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.

Version:: 2.0.8955

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

VgPoint.h

Vg3DModule::VgPointDescriptor Struct Reference

Public Types

Static Public Member Functions

Public Attributes