CausticCasterRenderTechnique Class Reference

Base abstract class of a caustic caster. More...

Inheritance diagram for CausticCasterRenderTechnique:

List of all members.

Public Member Functions
	CausticCasterRenderTechnique (unsigned long startFrame, unsigned long photonMapUpdateInterval, unsigned int photonMapResolution, unsigned int causticCubeMapResolution, bool updateAllFace, bool useDistance, ElementaryRenderable *parentRenderable, TechniqueGroup *parentTechniqueGroup)
	Constructor.
void	runChanged (RenderingRunType runType, RenderingRun *run)
	Called after one of he shared runs changes.
Protected Member Functions
virtual void	photonMapRunChanged (RenderingRun *run)=0
	Called if the changed run is a PhotonMapRenderingRun.
virtual void	causticCubeMapRunChanged (RenderingRun *run)=0
	Called if the changed run is a CausticCubeMapRenderingRun.
virtual void	distanceCubeMapRunChanged (RenderingRun *run)=0
	Called if the changed run is a DistanceCubeMapRenderingRun.
virtual RenderingRun *	createPhotonMapRun ()=0
	Creates a PhotonMapRenderingRun.
virtual RenderingRun *	createCausticCubeMapRun ()=0
	Creates a CausticCubeMapRenderingRun.
virtual RenderingRun *	createDistanceCubeMapRun ()=0
	Creates a DistanceCubeMapRenderingRun.
Protected Attributes
bool	updateAllFace
	defines if all cubemap faces should be updated in a frame or only one face per frame
bool	useDistance
	tells if a distance cubemap impostor should be used in photon hit calculation (recommended)
unsigned long	photonMapUpdateInterval
	photonmap update frequency
unsigned int	photonMapResolution
	photonmap resolution
unsigned int	causticCubeMapResolution
	caustic cubemap resolution
unsigned long	startFrame
	offset in frame number used during update

---

Detailed Description

Base abstract class of a caustic caster.

This technique defines that the given object needs a caustic photon map and a caustic cubemap. These resources will be updated by caustic recievers.

---

Constructor & Destructor Documentation

CausticCasterRenderTechnique::CausticCasterRenderTechnique (  unsigned long  startFrame, unsigned long  photonMapUpdateInterval, unsigned int  photonMapResolution, unsigned int  causticCubeMapResolution, bool  updateAllFace, bool  useDistance, ElementaryRenderable *  parentRenderable, TechniqueGroup *  parentTechniqueGroup )

Constructor. Parameters: startFrame  adds an offset to the current frame number to help evenly distribute updates between frames photonMapUpdateInterval  photon map and caustic cubemap update frequency photonMapResolution  photon map resolution causticCubeMapResolution  caustic cubemap resolution updateAllFace  defines if all cubemap faces should be updated in a frame or only one face per frame useDistance  tells if a distance cubemap impostor should be used in photon hit calculation (recommended) parentRenderable  the object to operate on parentTechniqueGroup  the TechniqueGroup this RenderedTechnique is attached to

---

Member Function Documentation

virtual void CausticCasterRenderTechnique::causticCubeMapRunChanged (  RenderingRun *  run  )  [protected, pure virtual]

Called if the changed run is a CausticCubeMapRenderingRun. Parameters: run  pointer to the changed CausticCubeMapRenderingRun Implemented in OgreCausticCasterRenderTechnique.

virtual RenderingRun* CausticCasterRenderTechnique::createCausticCubeMapRun (   )  [protected, pure virtual]

Creates a CausticCubeMapRenderingRun. Returns: the new CausticCubeMapRenderingRun instance. Implemented in OgreCausticCasterRenderTechnique.

virtual RenderingRun* CausticCasterRenderTechnique::createDistanceCubeMapRun (   )  [protected, pure virtual]

Creates a DistanceCubeMapRenderingRun. Returns: the new DistanceCubeMapRenderingRun instance. Implemented in OgreCausticCasterRenderTechnique.

virtual RenderingRun* CausticCasterRenderTechnique::createPhotonMapRun (   )  [protected, pure virtual]

Creates a PhotonMapRenderingRun. Returns: the new PhotonMapRenderingRun instance. Implemented in OgreCausticCasterRenderTechnique.

virtual void CausticCasterRenderTechnique::distanceCubeMapRunChanged (  RenderingRun *  run  )  [protected, pure virtual]

Called if the changed run is a DistanceCubeMapRenderingRun. Parameters: run  pointer to the changed DistanceCubeMapRenderingRun Implemented in OgreCausticCasterRenderTechnique.

virtual void CausticCasterRenderTechnique::photonMapRunChanged (  RenderingRun *  run  )  [protected, pure virtual]

Called if the changed run is a PhotonMapRenderingRun. Parameters: run  pointer to the changed PhotonMapRenderingRun Implemented in OgreCausticCasterRenderTechnique.

void CausticCasterRenderTechnique::runChanged (  RenderingRunType  runType, RenderingRun *  run )  [virtual]

Called after one of he shared runs changes. Parameters: runType  enum describing the type of the changed run run  pointer to the changed RenderingRun Reimplemented from RenderTechnique.

---

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

• CausticCasterRenderTechnique.h
• CausticCasterRenderTechnique.cpp

---