Vg3DModule::VgLine Class Reference

Inheritance diagram for Vg3DModule::VgLine:

Public Types
typedef VgLineDescriptor	Descriptor

Public Member Functions
virtual VgEngine::VgConstRefPtr< Descriptor >	getDescriptor () const
virtual Vg3DModule::VgIGeometryType	getType () const
const VgEngine::VgRefPtr< VgEngine::VgITexture > &	getTexture () const
bool	setTexture (const VgEngine::VgRefPtr< VgEngine::VgITexture > &pTexture)
float	getTextureAnimationSpeed () const
void	setTextureAnimationSpeed (const float pSpeed)
VgEngine::VgPosition	getInterpolatedPosition (float pValue)
Vg3DModule::VgPoint *	asPoint ()
Vg3DModule::VgLine *	asLine ()
Public Member Functions inherited from Vg3DModule::VgIGeometry
	VgIGeometry ()
virtual	~VgIGeometry ()
virtual VgEngine::VgRefPtr< VgEngine::VgLayer >	getLayer ()
virtual void	setLayer (VgEngine::VgRefPtr< VgEngine::VgLayer > pLayer, bool pHaveGeographicCoherence=true)
virtual void	addListener (VgEngine::VgRefPtr< Vg3DModule::VgIGeometryCallback > pCallback)
virtual void	removeListener (VgEngine::VgRefPtr< Vg3DModule::VgIGeometryCallback > pCallback)
virtual const VgEngine::VgVisibilityRamp	getVisibilityRamp () const
virtual void	setVisibilityRamp (const VgEngine::VgVisibilityRamp &pRamp)
virtual const std::string &	getID () const
virtual bool	getNotifyPOISelectedOnClick () const
virtual void	setNotifyPOISelectedOnClick (bool pValue)
virtual bool	getBoundingPositions (std::vector< VgEngine::VgPosition > &pResult)
virtual VgEngine::VgPosition	getLocalPosition () const
virtual void	setLocalPosition (VgEngine::VgPosition const &pPosition)
Vg3DModule::VgIGeometry *	asGeometry ()
Public Member Functions inherited from VgEngine::VgSpatial
void	setAnimation (const std::string &pAnimationName, VgEngine::VgRefPtr< VgEngine::VgAnimation > &pAnimation)
void	setAnimation (VgEngine::VgRefPtr< VgEngine::VgAnimation > pAnimation)
void	setLocalAnimation (VgEngine::VgRefPtr< VgEngine::VgAnimation > pAnimation)
VgConstRefPtr< VgAnimation >	getAnimation (const std::string &pName) const
VgRefPtr< VgAnimation >	editAnimation (const std::string &pName)
void	getAnimationNames (std::list< std::string > &pNameList) const
VgValue	getAnimationChannelValue (const std::string &pChannelName) const
VgEngine::VgPosition	getPosition () const
virtual void	setPosition (const VgEngine::VgPosition &pPosition, bool pHaveGeographicCoherence=true)
VgEngine::VgOrientation	getOrientation () const
void	setOrientation (const VgEngine::VgOrientation &pOrientation)
float	getScale () const
void	setScale (float pScale)
int	getZIndex () const
void	setZIndex (int pZIndex)
bool	isDrawnOnTop () const
void	setDrawOnTop (bool pEnable)
virtual void	setVisible (bool pIsVisible)
virtual bool	isVisible () const
Public Member Functions inherited from VgEngine::VgReferenced
	VgReferenced ()
	VgReferenced (const VgReferenced &pThis)
virtual	~VgReferenced ()
VgReferenced &	operator= (const VgReferenced &pThis)
void	ref () const
int	unref () const
int	getNbReferences () const

Protected Member Functions
	VgLine ()
virtual	~VgLine ()
Protected Member Functions inherited from VgEngine::VgSpatial
	VgSpatial ()
virtual	~VgSpatial ()

Friends
class	VgEngine::VgInstanceFactory
class	VgEngine::VgObjectBridge

Additional Inherited Members
Protected Attributes inherited from VgEngine::VgSpatial
Private *	mPrivate
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

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