This class exposes the layer concept. More...

Inheritance diagram for VgEngine::VgLayer:

Public Types
typedef VgLayerDescriptor	Descriptor

Public Member Functions
const std::string &	getName () const
	Get the layer's name. More...

void	setHostedVisible (bool pVisible)
	Sets the visibility of hosted (i.e. More...

virtual bool	isVisible () const
	Gets the visibility of the layer. More...

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

void	setLODFactor (float pLODFactor)
	Sets the LOD factor of the layer. More...

void	setLoadFactor (float pLoadFactor)
	Sets the load factor of the layer. More...

float	getLODFactor () const
	Gets the LOD factor of the layer. More...

float	getLoadFactor () const
	Gets the load factor of the layer. More...

VgEngine::VgConstRefPtr < VgEngine::VgSRS >	getSRS () const

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 Vg3DModule::VgIGeometry *	asGeometry ()
	Casts this instance into a VgIGeometry. More...

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

virtual Vg3DModule::VgLine *	asLine ()
	Casts this instance into a VgLine. 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...

Friends
class	VgInstanceFactory

class	VgLayerManager

class	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

This class exposes the layer concept.

There are two types of layers, one is the type of layers which come from the XML configuration file. This type of layer can't be instantiated except through XML configuration. The other type of layer (called user created layer) may be instantiated by the user through the VgInstanceFactory class using a VgEngine::VgLayer::Descriptor.

Version: 2.0

Member Typedef Documentation

typedef VgLayerDescriptor VgEngine::VgLayer::Descriptor

Member Function Documentation

float VgEngine::VgLayer::getLoadFactor ( ) const

Gets the load factor of the layer.

Only applicable on layers created through XML configuration.

Returns: The current load factor.

float VgEngine::VgLayer::getLODFactor ( ) const

Gets the LOD factor of the layer.

Only applicable on layers created through XML configuration.

Returns: The current LOD factor.

const std::string& VgEngine::VgLayer::getName ( ) const

Get the layer's name.

Returns: The layer's name.

VgEngine::VgConstRefPtr< VgEngine::VgSRS > VgEngine::VgLayer::getSRS ( ) const

Returns: The layers SRS

virtual bool VgEngine::VgLayer::isVisible ( ) const

virtual

Gets the visibility of the layer.

Returns: true if the layer is visible, false if invisible.

Reimplemented from VgEngine::VgSpatial.

void VgEngine::VgLayer::setHostedVisible ( bool pVisible )

Sets the visibility of hosted (i.e.

user or database created) visuals.

Parameters

pVisible If true, the visuals are visible, invisible if false.

void VgEngine::VgLayer::setLoadFactor ( float pLoadFactor )

Sets the load factor of the layer.

This will impact how much data is loadeded at a same time. May be a usefull handle to control memory footprint and loading speeds. Higher values will cause more data to be loaded at the same time. Only applicable on layers created through XML configuration.

Parameters

pLoadFactor The load factor to assign to the layer.

void VgEngine::VgLayer::setLODFactor ( float pLODFactor )

Sets the LOD factor of the layer.

This will impact how much data is displayed at a same time. May be a usefull handle to control frame rate. Higher values lead to more geometry being displayed. Only applicable on layers created through XML configuration. Does not affect hosted visuals (e.g. labels).

Parameters

pLODFactor The LOD factor to assign to the layer.

virtual void VgEngine::VgLayer::setVisible ( bool pIsVisible )

virtual

Sets the overall visibility of the layer.

Parameters

pIsVisible If true the layer will be visible, invisible if false.

Reimplemented from VgEngine::VgSpatial.

Friends And Related Function Documentation

friend class VgInstanceFactory

friend

friend class VgLayerManager

friend

friend class VgObjectBridge

friend

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

VgLayer.h

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Function Documentation

Friends And Related Function Documentation