Vg3DModule::VgLinkDescriptor Struct Reference

A structure which describes the attributes of a Vg3DModule::VgLink. More...

Inheritance diagram for Vg3DModule::VgLinkDescriptor:

Public Types
typedef VgLink	Described

Public Member Functions
	VgLinkDescriptor ()
	Constructor. More...
	VgLinkDescriptor (const VgEngine::VgPosition &pSourcePosition, const VgEngine::VgColor &pSourceColor, const VgEngine::VgPosition &pTargetPosition, const VgEngine::VgColor &pTargetColor, VgEngine::VgRefPtr< VgEngine::VgITexture > pTexture, float pWidth, float pTextureRatio, float pAnimationSpeed)
	Parametrized constructor. More...
	VgLinkDescriptor (const VgLinkDescriptor &pOther)
	Copy Constructor. 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 < VgLinkDescriptor >	create ()
	This static method returns a new heap-allocated descriptor. More...

Public Attributes
VgEngine::VgPosition	mSourcePosition
	The source position. More...
VgEngine::VgColor	mSourceColor
	The source point's color, The link's color will be interpolated linearly from source color. More...
VgEngine::VgPosition	mTargetPosition
	The 'end' position. More...
VgEngine::VgColor	mTargetColor
	The end's color. More...
VgEngine::VgRefPtr < VgEngine::VgITexture >	mTexture
	The optional texture to apply to the link's geometry. More...
float	mWidth
	Width of the link. More...
float	mTextureRatio
	Texture's width/height ratio. More...
float	mAnimationSpeed
	Texture's animation speed. More...

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

Detailed Description

A structure which describes the attributes of a Vg3DModule::VgLink.

Version

2.0

Member Typedef Documentation

typedef VgLink Vg3DModule::VgLinkDescriptor::Described

Constructor & Destructor Documentation

Vg3DModule::VgLinkDescriptor::VgLinkDescriptor

(

)

Constructor.

Vg3DModule::VgLinkDescriptor::VgLinkDescriptor	(	const VgEngine::VgPosition &	pSourcePosition,
		const VgEngine::VgColor &	pSourceColor,
		const VgEngine::VgPosition &	pTargetPosition,
		const VgEngine::VgColor &	pTargetColor,
		VgEngine::VgRefPtr< VgEngine::VgITexture >	pTexture,
		float	pWidth,
		float	pTextureRatio,
		float	pAnimationSpeed
	)

Parametrized constructor.

Vg3DModule::VgLinkDescriptor::VgLinkDescriptor

(

const VgLinkDescriptor &

pOther

)

Copy Constructor.

Member Function Documentation

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

Member Data Documentation

float Vg3DModule::VgLinkDescriptor::mAnimationSpeed

Texture's animation speed.

Default value 0.0f

Version

2.1.3 Updated doc with default value (before 2.1.3 it was 1.0)

VgEngine::VgColor Vg3DModule::VgLinkDescriptor::mSourceColor

The source point's color, The link's color will be interpolated linearly from source color.

Default value VgColor(1.0f, 1.0f, 1.0f, 1.0f)

Version

2.1.3 Updated doc with default value.

VgEngine::VgPosition Vg3DModule::VgLinkDescriptor::mSourcePosition

The source position.

Note

This position will be constantly converted to scene coordinates. This will result in having the start end of the link to "follow" the provided SRS as it is updated. This also means that positions provided in the scene's SRS or the WGS84 SRS will always appear at the same scene position

VgEngine::VgColor Vg3DModule::VgLinkDescriptor::mTargetColor

The end's color.

Default value VgColor(1.0f, 1.0f, 1.0f, 1.0f)

Version

2.1.3 Updated doc with default value.

VgEngine::VgPosition Vg3DModule::VgLinkDescriptor::mTargetPosition

The 'end' position.

Same note applies as for Vg3DModule::VgLinkDescriptor::mSourcePosition.

VgEngine::VgRefPtr< VgEngine::VgITexture > Vg3DModule::VgLinkDescriptor::mTexture

The optional texture to apply to the link's geometry.

float Vg3DModule::VgLinkDescriptor::mTextureRatio

Texture's width/height ratio.

Default value 1.0f

Version

2.1.3 Updated doc with default value.

float Vg3DModule::VgLinkDescriptor::mWidth

Width of the link.

Default value 1.0f

Version

2.1.3 Updated doc with default value.

---

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

• VgLink.h