IlluminationManager Class Reference

Base abstract class of the illumination manager. More...

List of all members.

Public Member Functions

virtual void update (unsigned long frameNumber)=0
 The function to be called to render one frame.
virtual void sharedRunSplit (SharedRuns *old, SharedRuns *new1, SharedRuns *new2)
 The function to be called when a shared run is splitted.
virtual void sharedRunJoin (SharedRuns *old1, SharedRuns *old2, SharedRuns *newsr)
 The function to be called when two shared runs are joined.
virtual void joinSharedRuns ()
 Joins shared runs if needed.
virtual void addSharedRuns (SharedRuns *runs)
 Register a shared run object.


Detailed Description

Base abstract class of the illumination manager.

The illumination manager is responsible for refreshing rendering techniques connected to visible renderables, and to render the scene with these updated resources. It also has the resposibility to manage shared runs, to join and split them if needed.


Member Function Documentation

virtual void IlluminationManager::addSharedRuns SharedRuns runs  )  [inline, virtual]
 

Register a shared run object.

Only called when new techniques are created.

Parameters:
runs pointer to the SharedRuns instance to add

virtual void IlluminationManager::joinSharedRuns  )  [inline, virtual]
 

Joins shared runs if needed.

Searches the registered shared run roots and join them if necessary (they are close enough).

virtual void IlluminationManager::sharedRunJoin SharedRuns old1,
SharedRuns old2,
SharedRuns newsr
[inline, virtual]
 

The function to be called when two shared runs are joined.

Parameters:
old1 pointer to one of the SharedRuns instance that are joined
old2 pointer to the other SharedRuns instance that are joined
newsr pointer to the resulting parent SharedRuns instance

virtual void IlluminationManager::sharedRunSplit SharedRuns old,
SharedRuns new1,
SharedRuns new2
[inline, virtual]
 

The function to be called when a shared run is splitted.

Parameters:
old pointer to the SharedRuns instance that is split
new1 pointer to one of the SharedRuns instance that remain after split
new2 pointer to the other SharedRuns instance that remain after split

virtual void IlluminationManager::update unsigned long  frameNumber  )  [pure virtual]
 

The function to be called to render one frame.

This is the main refreshing function. It seasrches for visible objects, manages shared runs, updates render techniques and finally renders the scene to framebuffer.

Parameters:
frameNumber current framenumber


The documentation for this class was generated from the following file:
Generated on Thu Apr 27 17:29:37 2006 for GameTools Illumination Module by  doxygen 1.4.6-NO