Scene context. More...

#include <SceneContext.h>

Inheritance diagram for PLScene::SceneContext:

Public Member Functions
PLS_API	SceneContext (PLRenderer::RendererContext &cRendererContext)
	Constructor.
PLS_API	~SceneContext ()
	Destructor.
PLS_API PLRenderer::RendererContext &	GetRendererContext () const
	Returns the used renderer context.
PLS_API PLMesh::MeshManager &	GetMeshManager ()
	Returns the mesh manager.
PLS_API PLMath::GraphPathManager &	GetGraphPathManager ()
	Returns the graph path manager.
PLS_API SceneContainer *	GetRoot ()
	Returns the root of the scene graph.
PLS_API void	Cleanup ()
	Performs a cleanup-operation (garbage collection)
PLS_API void	Update (bool bRespectPause=true)
	Method that is called once per update loop.
PLS_API SceneRendererManager &	GetSceneRendererManager ()
	Returns the scene renderer manager.
PLS_API VisManager &	GetVisManager ()
	Returns the visibility manager.
PLS_API bool	StartProcess ()
	Starts a scene process.
PLS_API bool	IsNodeTouched (SceneNode &cSceneNode) const
	Checks whether a scene node was touched.
PLS_API bool	TouchNode (SceneNode &cSceneNode)
	Touches a scene node.
PLS_API bool	EndProcess ()
	Ends a scene process.
Public Attributes
PLCore::Event	EventUpdate

Detailed Description

Scene context.

Note:

There should be only one scene context instance per application

Constructor & Destructor Documentation

PLS_API PLScene::SceneContext::SceneContext ( PLRenderer::RendererContext & cRendererContext )

Constructor.

Parameters:

[in] cRendererContext Renderer context to use

PLS_API PLScene::SceneContext::~SceneContext ( )

Destructor.

Member Function Documentation

PLS_API PLRenderer::RendererContext& PLScene::SceneContext::GetRendererContext ( ) const

Returns the used renderer context.

Returns:: The used renderer context

PLS_API PLMesh::MeshManager& PLScene::SceneContext::GetMeshManager ( )

Returns the mesh manager.

Returns:: The mesh manager

PLS_API PLMath::GraphPathManager& PLScene::SceneContext::GetGraphPathManager ( )

Returns the graph path manager.

Returns:: The graph path manager

PLS_API SceneContainer* PLScene::SceneContext::GetRoot ( )

Returns the root of the scene graph.

Returns:: The root of the scene graph, a null pointer on (terrible) error

See also:

SceneNode and SceneContainer for more information

PLS_API void PLScene::SceneContext::Cleanup ( )

Performs a cleanup-operation (garbage collection)

Remarks:: If SceneNode::Delete() is called, scene nodes are not destroyed immediately, instead they register them self into a 'to delete' list of the scene graph. As soon this function is called, the scene nodes are destroyed. Normally this function is called once per frame automatically.

PLS_API void PLScene::SceneContext::Update ( bool bRespectPause = true )

Method that is called once per update loop.

Parameters:

[in] bRespectPause Respect pause? ("PLCore::Timing::GetInstance()->IsPaused()")

Remarks:: You can use this method to do work you have to to within each frame. It's recommended to keep the work done within the implementation as compact as possible. Don't use this method to perform 'polling'-everything, use events or if required for example timers instead.

PLS_API SceneRendererManager& PLScene::SceneContext::GetSceneRendererManager ( )

Returns the scene renderer manager.

Returns:: The scene renderer manager

PLS_API VisManager& PLScene::SceneContext::GetVisManager ( )

Returns the visibility manager.

Returns:: The visibility manager

PLS_API bool PLScene::SceneContext::StartProcess ( )

Starts a scene process.

Remarks:: During scene traversal using for instance the hierarchy of a scene container, a scene node can be processed multiple times. If this is NOT desired, a scene node must be 'marked' as already processed so it isn't touched multiple times. The scene graph class offers 3 functions for this purpose: StartProcess(), TouchNode() and EndProcess(). If a scene process starts, StartProcess() is called with internally increases a counter. If a node should be processes TouchNode() is called, if 'true' is returned the node was already processed. After the whole scene process is finished, call EndProcess(). This is NOT 'multi threading save' and only ONE scene process can be performed at the same time, but this technique is incredible fast because internally only counters are compared!

Returns:: 'true' if all went fine, else 'false' (there's already a process running)

PLS_API bool PLScene::SceneContext::IsNodeTouched ( SceneNode & cSceneNode ) const

Checks whether a scene node was touched.

Parameters:

[in] cSceneNode Scene node to check

Returns:: 'true' if the scene node was touched, else 'false'

See also:

StartProcess()

PLS_API bool PLScene::SceneContext::TouchNode ( SceneNode & cSceneNode )

Touches a scene node.

Parameters:

[in] cSceneNode Scene node to touch

Returns:: 'true' if all went fine and the scene node was touched the first time during the current process, else 'false' if the scene node was already touched during the current process or there's currently no active process or the given scene node is invalid

See also: