VgEngine::VgLayerManager Class Reference

Manages the layers. More...

List of all members.

Public Types
typedef std::vector < VgEngine::VgRefPtr < VgEngine::VgLayer > >	LayerList
	A collection of VgEngine::VgLayer instances.
Public Member Functions
	VgLayerManager (VgIEngine *pEngine)
	Creates a layer manager for the provided engine.
	~VgLayerManager ()
	Creates a layer manager for the provided engine.
VgEngine::VgRefPtr < VgEngine::VgLayer >	editLayer (const std::string &pName)
	Access a VgLayer using it's name.
const LayerList &	getLayers () const
	Const access to the VgLayer collection.
LayerList &	editLayers ()
	Access to the VgLayer collection.
Friends
class	VgObjectBridge

---

Detailed Description

Manages the layers.

Version:

2.0

---

Member Typedef Documentation

typedef std::vector< VgEngine::VgRefPtr< VgEngine::VgLayer > > VgEngine::VgLayerManager::LayerList

A collection of VgEngine::VgLayer instances.

---

Constructor & Destructor Documentation

VgEngine::VgLayerManager::VgLayerManager

(

VgIEngine *

pEngine )

Creates a layer manager for the provided engine.

Public code should not call this. Instead, use the instance provided by VgEngine::VgIEngine.

Parameters:

pEngine

The engine instance this layer manager is built on.

See also:

VgEngine::VgIEngine::editLayerManager()

VgEngine::VgLayerManager::~VgLayerManager

(

)

Creates a layer manager for the provided engine.

Public code should not call this. Instead, use the instance provided by VgEngine::VgIEngine.

See also:

VgEngine::VgIEngine::editLayerManager()

---

Member Function Documentation

VgEngine::VgRefPtr< VgEngine::VgLayer > VgEngine::VgLayerManager::editLayer

(

const std::string &

pName )

Access a VgLayer using it's name.

Parameters:

pName

The name of the accessed layer.

Returns:

The named layer's pointer if any, null if not found.

LayerList& VgEngine::VgLayerManager::editLayers

(

)

Access to the VgLayer collection.

Returns:

A reference to the layer collection.

const LayerList& VgEngine::VgLayerManager::getLayers

(

)

const

Const access to the VgLayer collection.

Returns:

A const reference on the layer collection.

---

Friends And Related Function Documentation

friend class VgObjectBridge [friend]

---

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

• VgLayerManager.h