A VgLine is created using Vg3DModule::VgInstanceFactory::instantiate. More...

Inheritance diagram for Vg3DModule::VgLine:

Public Types
typedef VgLineDescriptor	Descriptor

Public Types inherited from Vg3DModule::VgIGeometry
typedef std::vector < VgEngine::VgPosition >	PositionVector

Public Member Functions
virtual VgEngine::VgConstRefPtr < Descriptor >	getDescriptor () const
	Retrieves the descriptor containing line information. More...

virtual Vg3DModule::VgIGeometryType	getType () const

const VgEngine::VgRefPtr < VgEngine::VgITexture > &	getTexture () const

bool	setTexture (const VgEngine::VgRefPtr< VgEngine::VgITexture > &pTexture)
	Sets a new texture for this line. More...

float	getTextureAnimationSpeed () const

void	setTextureAnimationSpeed (const float pSpeed)
	Sets the texture animation speed in meters/second for this line. More...

VgEngine::VgPosition	getInterpolatedPosition (float pValue)
	returns interpolated position for this line. More...

Vg3DModule::VgPoint *	asPoint ()
	Casts this instance into a VgPoint. More...

Vg3DModule::VgLine *	asLine ()
	Casts this instance into a VgLine. More...

Public Member Functions inherited from Vg3DModule::VgIGeometry
	VgIGeometry ()
	Constructor. More...

virtual	~VgIGeometry ()
	Destructor. More...

virtual VgEngine::VgRefPtr < VgEngine::VgLayer >	getLayer ()

virtual void	setLayer (VgEngine::VgRefPtr< VgEngine::VgLayer > pLayer, bool pHaveGeographicCoherence=true)
	Sets the associated layer. More...

virtual void	addListener (VgEngine::VgRefPtr< Vg3DModule::VgIGeometryCallback > pCallback)
	Adds a listener to the geometry object. More...

virtual void	removeListener (VgEngine::VgRefPtr< Vg3DModule::VgIGeometryCallback > pCallback)
	Removes a listener from the geometry object. More...

virtual const VgEngine::VgVisibilityRamp	getVisibilityRamp () const

virtual void	setVisibilityRamp (const VgEngine::VgVisibilityRamp &pRamp)
	Sets the visibility ramp. More...

virtual const std::string &	getID () const

virtual bool	getNotifyPOISelectedOnClick () const

virtual void	setNotifyPOISelectedOnClick (bool pValue)
	Sets the VgIGeometry to call the VgIMapModule::VgIPlaceListeners when the user clicks on the VgIGeometry. More...

virtual bool	getBoundingPositions (PositionVector &pResult)
	Returns a vector of points that can be used to determine a viewpoint where one is guaranteed that the whole object is visible. More...

Vg3DModule::VgIGeometry *	asGeometry ()
	Casts this instance into a VgIGeometry. More...

Public Member Functions inherited from VgEngine::VgSpatial
void	setAnimation (const std::string &pAnimationName, VgEngine::VgRefPtr< VgEngine::VgAnimation > &pAnimation)
	Sets an animation on this spatial. More...

void	setAnimation (VgEngine::VgRefPtr< VgEngine::VgAnimation > pAnimation)
	Sets an animation with an empty name on this spatial. More...

void	setLocalAnimation (VgEngine::VgRefPtr< VgEngine::VgAnimation > pAnimation)
	Sets an animation on this spatial. More...

VgConstRefPtr< VgAnimation >	getAnimation (const std::string &pName) const
	Gets an animation from the spatial's animation map. More...

VgRefPtr< VgAnimation >	editAnimation (const std::string &pName)
	Edits an animation from the spatial's animation map. More...

void	getAnimationNames (std::list< std::string > &pNameList) const
	Gets the list of the stored animation names. More...

VgEngine::VgPosition	getPosition () const
	Gets spatial's position. More...

virtual void	setPosition (const VgEngine::VgPosition &pPosition, bool pHaveGeographicCoherence=true)
	Sets the spatial position. More...

VgEngine::VgOrientation	getOrientation () const
	Gets spatial's orientation. More...

void	setOrientation (const VgEngine::VgOrientation &pOrientation)
	Sets the spatial orientation. More...

float	getScale () const

void	setScale (float pScale)
	Sets the spatial's scale. More...

int	getZIndex () const

void	setZIndex (int pZIndex)
	Sets the Z Index, an object with a smaller ZIndex will be drawn in front of another with a larger one. More...

bool	isDrawnOnTop () const

void	setDrawOnTop (bool pEnable)
	Sets the drawOnTop flag. More...

virtual void	setVisible (bool pIsVisible)
	Sets the visibility. More...

virtual bool	isVisible () const

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 Member Functions
	VgLine ()
	Constructor. More...

virtual	~VgLine ()
	Destructor. More...

Protected Member Functions inherited from VgEngine::VgSpatial
	VgSpatial ()
	Default constructor. More...

virtual	~VgSpatial ()
	Destructor. More...

Friends
class	VgEngine::VgInstanceFactory

class	VgEngine::VgObjectBridge

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgSpatial
Private *	mPrivate
	Private. More...

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

Detailed Description

A VgLine is created using Vg3DModule::VgInstanceFactory::instantiate.

Once created, it may be added to a layer using VgLine::setLayer.

...
VgApplication::VgIApplication* mVgApplication;
Vg3DModule::VgLineDescriptor lLineDesc;
...
VgEngine::VgRefPtr< Vg3DModule::VgLine > lLine = mVgApplication->editEngine()->editInstanceFactory()->instantiate(lLineDesc);
const VgEngine::VgLayerManager::LayerList& lLayers = mVgApplication->editEngine()->editLayerManager()->getLayers();
// Choose the first layer.
VgEngine::VgRefPtr< VgEngine::VgLayer > lLayer = lLayers.at(0);
// Note: The line will only be seen if it's associated layer is visible.
lLine->setLayer(lLayer);
// To hide the line. Pass true to show it again. By default, a line is visible.
lLine->setVisible(false);
// To query its visibility
bool lIsVisible = lLine->isVisible();
// To remove the line from the layer 
lLine->setLayer(NULL);
// If the line is no longer required, then release it's memory.
// VgLine is reference counted, so just null-out the VgRefPtr.
lLine = NULL;

Version: 2.0

Member Typedef Documentation

typedef VgLineDescriptor Vg3DModule::VgLine::Descriptor

Constructor & Destructor Documentation

Vg3DModule::VgLine::VgLine ( )

protected

Constructor.

virtual Vg3DModule::VgLine::~VgLine ( )

protectedvirtual

Destructor.

Member Function Documentation

Vg3DModule::VgLine* Vg3DModule::VgLine::asLine ( )

virtual

Casts this instance into a VgLine.

Returns: A valid pointer if this instance as the correct type, NULL otherwise.

Version: 2.0.9590

Reimplemented from Vg3DModule::VgIGeometry.

Vg3DModule::VgPoint* Vg3DModule::VgLine::asPoint ( )

virtual

Casts this instance into a VgPoint.

Returns: A valid pointer if this instance as the correct type, NULL otherwise.

Version: 2.0.9590

Reimplemented from Vg3DModule::VgIGeometry.

virtual VgEngine::VgConstRefPtr< Descriptor > Vg3DModule::VgLine::getDescriptor ( ) const

virtual

Retrieves the descriptor containing line information.

Returns: The descriptor.

VgEngine::VgPosition Vg3DModule::VgLine::getInterpolatedPosition ( float pValue )

returns interpolated position for this line.

Parameters

pValue between 0.0f and 1.0f

Returns: VgEngine::VgPosition with interpolated value.

Version: 2.1.3

const VgEngine::VgRefPtr< VgEngine::VgITexture >& Vg3DModule::VgLine::getTexture ( ) const

Returns: The line texture.

Version: 2.0.9263

float Vg3DModule::VgLine::getTextureAnimationSpeed ( ) const

Returns: The line texture animation speed in meters/second

Version: 2.0.9263

virtual Vg3DModule::VgIGeometryType Vg3DModule::VgLine::getType ( ) const

virtual

Returns: The geometry type for this object

Reimplemented from Vg3DModule::VgIGeometry.

bool Vg3DModule::VgLine::setTexture ( const VgEngine::VgRefPtr< VgEngine::VgITexture > & pTexture )

Sets a new texture for this line.

Version: 2.0.9263

void Vg3DModule::VgLine::setTextureAnimationSpeed ( const float pSpeed )

Sets the texture animation speed in meters/second for this line.

Version: 2.0.9263

Friends And Related Function Documentation

friend class VgEngine::VgInstanceFactory

friend

friend class VgEngine::VgObjectBridge

friend

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

VgLine.h

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation