OgreCausticRecieverRenderTechnique Class Reference

CausticRecieverRenderTechnique used in an OGRE environment. More...

Inheritance diagram for OgreCausticRecieverRenderTechnique:

OgreRenderTechnique CausticRecieverRenderTechnique RenderTechnique RenderTechnique List of all members.

Public Member Functions

 OgreCausticRecieverRenderTechnique (int maxcasters, String causticVertexProgram, String causticFragmentProgram, Pass *pass, OgreRenderable *parentRenderable, OgreTechniqueGroup *parentTechniqueGroup)
 Constructor.
 ~OgreCausticRecieverRenderTechnique ()
 Destructor.
virtual void update (unsigned long frameNum)
 Updates the resources in the given frame.

Protected Attributes

int maxcasters
 the maximum number of caustic casters from which this reciever can recieve caustic light
String causticVertexProgram
 the vertex program to be used in the caustic gathering passes
String causticFragmentProgram
 the fragment program to be used in the caustic gathering passes
std::vector< Pass * > passes
std::vector< OgreSharedRuns * > causticCasters
 the nearest caustic casters found during update

Detailed Description

CausticRecieverRenderTechnique used in an OGRE environment.

This technique defines that the object will recieve caustic lighting from caustic caster objects. The caustic light spots will be calculated by the caustic caster's RenderingRuns. These runs will only be updated if caustic redievers are visible, so it is the reciever technique's responsibility to update them.

Each caustic caster's light contribution will be added in separate passes. Each pass will add some light to the shaded image, so these passes should be the last passes. In the constructor the given Pass* parameter will be the pass after which the caustic lighting passes will be added by the technique.


Constructor & Destructor Documentation

OgreCausticRecieverRenderTechnique::OgreCausticRecieverRenderTechnique int  maxcasters,
String  causticVertexProgram,
String  causticFragmentProgram,
Pass *  pass,
OgreRenderable parentRenderable,
OgreTechniqueGroup parentTechniqueGroup
 

Constructor.

Parameters:
maxcasters the maximum number of caustic casters from which this reciever can recieve caustic light
causticVertexProgram the vertex program to be used in the caustic gathering passes
causticFragmentProgram the fragment program to be used in the caustic gathering passes. It should have one pass and the caustic cubemap of a caster will be bound to the first sampler unit.
pass the pass after which caustic gathering passes should be added
parentRenderable the object to operate on
parentTechniqueGroup the TechniqueGroup this RenderedTechnique is attached to


Member Function Documentation

void OgreCausticRecieverRenderTechnique::update unsigned long  frameNum  )  [virtual]
 

Updates the resources in the given frame.

A RenderTechnique is usually need some resources from several runs, so these runs will be updated.

Parameters:
frameNum the actual framenumber

Reimplemented from RenderTechnique.


Member Data Documentation

String OgreCausticRecieverRenderTechnique::causticFragmentProgram [protected]
 

the fragment program to be used in the caustic gathering passes

It should have one pass and the caustic cubemap of a caster will be bound to the first sampler unit.

std::vector<Pass*> OgreCausticRecieverRenderTechnique::passes [protected]
 

new passes created by this technique


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