Vg3DModule::VgIGeometry Class Reference

The Vg3DModule::VgIGeometry interface is used as an abstraction of geometric features that can be added to or removed from the scene. More...

Inheritance diagram for Vg3DModule::VgIGeometry:

Public Member Functions
	VgIGeometry ()
	Constructor. More...
virtual	~VgIGeometry ()
	Destructor. More...
virtual VgIGeometryType	getType () const
	Gets the geometry type. More...
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...
const VgEngine::VgVisibilityRamp	getVisibilityRamp () const
void	setVisibilityRamp (const VgEngine::VgVisibilityRamp &pRamp)
	Sets the visibility ramp. 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. More...
bool	isDrawnOnTop () const
void	setDrawOnTop (bool pEnable)
	Sets the drawOnTop flag. 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...
void	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...

Friends
class	VgEngine::VgObjectBridge

Additional Inherited Members
Protected Member Functions inherited from VgEngine::VgSpatial
	VgSpatial ()
	Default constructor. More...
virtual	~VgSpatial ()
	Destructor. More...
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

The Vg3DModule::VgIGeometry interface is used as an abstraction of geometric features that can be added to or removed from the scene.

Constructor & Destructor Documentation

Vg3DModule::VgIGeometry::VgIGeometry

(

)

Constructor.

virtual Vg3DModule::VgIGeometry::~VgIGeometry ( )

virtual

Destructor.

Member Function Documentation

virtual void Vg3DModule::VgIGeometry::addListener ( VgEngine::VgRefPtr< Vg3DModule::VgIGeometryCallback >  pCallback )

virtual

Adds a listener to the geometry object.

Parameters

pCallback

The callback to associate with this geometry object.

Version

2.0

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

virtual

Gets the geometry type.

Returns

The type of the geometry object.

Reimplemented in Vg3DModule::VgPoint, and Vg3DModule::VgLine.

const VgEngine::VgVisibilityRamp Vg3DModule::VgIGeometry::getVisibilityRamp

(

)

const

Returns

The visibility ramp.

Version

2.0.9263

virtual void Vg3DModule::VgIGeometry::removeListener ( VgEngine::VgRefPtr< Vg3DModule::VgIGeometryCallback >  pCallback )

virtual

Removes a listener from the geometry object.

Parameters

pCallback

The callback to disassociate from this geometry object.

Version

2.0

virtual void Vg3DModule::VgIGeometry::setLayer ( VgEngine::VgRefPtr< VgEngine::VgLayer >  pLayer, bool  pHaveGeographicCoherence = true  )

virtual

Sets the associated layer.

Parameters

pLayer	The VgLayer to associate with the geometry object. Pass pLayer as null to disassociate the geometry object from a layer.
pHaveGeographicCoherence	An optional parameter who by default is true. Is used to determine the geographic coherence of the geometry. If set to false, then the geometry will be coherent with the scene.

Version

2.0

void Vg3DModule::VgIGeometry::setVisibilityRamp

(

const VgEngine::VgVisibilityRamp &

pRamp

)

Sets the visibility ramp.

Version

2.0.9263

Friends And Related Function Documentation

friend class VgEngine::VgObjectBridge

friend

---

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

• VgIGeometry.h