VgEngine::VgLayer Class Reference

This class exposes the layer concept. More...

Inheritance diagram for VgEngine::VgLayer:

Collaboration diagram for VgEngine::VgLayer:

List of all members.

Public Types
typedef VgLayerDescriptor	Descriptor
Public Member Functions
const std::string &	getName () const
	Get the layer's name.
void	setHostedVisible (bool pVisible)
	Sets the visibility of hosted (i.e.
bool	isVisible () const
	Gets the visibility of the layer.
void	setVisible (bool pVisible)
	Sets the overall visibility of the layer.
void	setLODFactor (float pLODFactor)
	Sets the LOD factor of the layer.
void	setLoadFactor (float pLoadFactor)
	Sets the load factor of the layer.
float	getLODFactor () const
	Gets the LOD factor of the layer.
float	getLoadFactor () const
	Gets the load factor of the layer.
VgEngine::VgConstRefPtr < VgEngine::VgSRS >	getSRS () const
Friends
class	VgInstanceFactory
class	VgLayerManager
class	VgObjectBridge

---

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

bool VgEngine::VgLayer::isVisible

(

)

const

Gets the visibility of the layer.

Returns:

true if the layer is visible, false if invisible.

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.

Parameters:

pLODFactor

The LOD factor to assign to the layer.

void VgEngine::VgLayer::setVisible

(

bool

pVisible )

Sets the overall visibility of the layer.

Parameters:

pVisible

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

---

Friends And Related Function Documentation

friend class VgInstanceFactory [friend]

friend class VgLayerManager [friend]

friend class VgObjectBridge [friend]

Reimplemented from VgEngine::VgSpatial.

---

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

• VgLayer.h