TechniqueGroup Class Reference

Base abstract class for a collection techniques. More...

Inheritance diagram for TechniqueGroup:

OgreTechniqueGroup List of all members.

Public Member Functions

 TechniqueGroup (void)
 Constructor.
void addSharedRun (SharedRuns *sharedRuns)
 Adds an empty SharedRuns parent.
SharedRunsgetSharedRuns ()
 Retrieves the shared runs.
virtual void addRenderTechnique (RenderTechnique *technique)=0
 Adds a rendertechnique to the group.
virtual void update (unsigned long frameNum)=0
 Updates all rendertechniques.
virtual void runChanged (RenderingRunType runType, RenderingRun *run)=0
 Called after one of he shared runs changes.
virtual void runUpdated (RenderingRunType runType, RenderingRun *run)=0
 Called after one of he shared runs updates.
virtual void updateBounds ()
 Updates the connected SharedRuns boundary.
virtual void validateSharedRuns ()
 Validates the connected SharedRuns instance.

Protected Attributes

SharedRunsparentSharedRuns
 Pointer to the connected SharedRuns instance each technique uses.

Detailed Description

Base abstract class for a collection techniques.

This is a helper class, to collect RenderTechnique instances bound to a single renderable. It's main task is to recieve and forward messages to each RenderTechnique.


Member Function Documentation

virtual void TechniqueGroup::addRenderTechnique RenderTechnique technique  )  [pure virtual]
 

Adds a rendertechnique to the group.

Parameters:
technique the RenderTechnique instance to add.

Implemented in OgreTechniqueGroup.

void TechniqueGroup::addSharedRun SharedRuns sharedRuns  )  [inline]
 

Adds an empty SharedRuns parent.

Used after creating a new TechniqueGroup.

Parameters:
sharedRuns the SharedRun instance the RenderTechniques will use.

SharedRuns* TechniqueGroup::getSharedRuns  )  [inline]
 

Retrieves the shared runs.

Returns:
the SharedRun instance the RenderTechniques use.

virtual void TechniqueGroup::runChanged RenderingRunType  runType,
RenderingRun run
[pure virtual]
 

Called after one of he shared runs changes.

This message will be forwarded to each RenderTechique.

Parameters:
runType enum describing the type of the changed run
run pointer to the changed RenderingRun

Implemented in OgreTechniqueGroup.

virtual void TechniqueGroup::runUpdated RenderingRunType  runType,
RenderingRun run
[pure virtual]
 

Called after one of he shared runs updates.

This message will be forwarded to each RenderTechique.

Parameters:
runType enum describing the type of the updated run
run pointer to the updated RenderingRun

Implemented in OgreTechniqueGroup.

virtual void TechniqueGroup::update unsigned long  frameNum  )  [pure virtual]
 

Updates all rendertechniques.

Parameters:
framenum current framenumber

Implemented in OgreTechniqueGroup.


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