VgEngine::VgLayer Class Reference

Inheritance diagram for VgEngine::VgLayer:

Public Types
typedef VgLayerDescriptor	Descriptor

Public Member Functions
const std::string &	getName () const
void	setHostedVisible (bool pVisible)
virtual bool	isVisible () const
virtual void	setVisible (bool pIsVisible)
void	setLODFactor (float pLODFactor)
void	setLoadFactor (float pLoadFactor)
float	getLODFactor () const
float	getLoadFactor () const
VgEngine::VgConstRefPtr< VgEngine::VgSRS >	getSRS () const
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 Vg3DModule::VgIGeometry *	asGeometry ()
virtual Vg3DModule::VgPoint *	asPoint ()
virtual Vg3DModule::VgLine *	asLine ()
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

Friends
class	VgInstanceFactory
class	VgLayerManager
class	VgObjectBridge

Additional Inherited Members
Protected Member Functions inherited from VgEngine::VgSpatial
	VgSpatial ()
virtual	~VgSpatial ()
Protected Attributes inherited from VgEngine::VgSpatial
Private *	mPrivate
Protected Attributes inherited from VgEngine::VgReferenced
int	mNbReferences

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