OgreCausticCasterRenderTechnique Class Reference

CausticCasterRenderTechnique used in an OGRE environment. More...

Inheritance diagram for OgreCausticCasterRenderTechnique:

List of all members.

Public Member Functions
	OgreCausticCasterRenderTechnique (unsigned long startFrame, unsigned long photonMapUpdateInterval, unsigned int photonMapResolution, unsigned int custicCubeMapResolution, String photonMapMaterialName, String causticMapMaterialName, unsigned char photonMapTexID, bool updateAllFace, bool useDistance, Pass *pass, OgreRenderable *parentRenderable, OgreTechniqueGroup *parentTechniqueGroup)
	Constructor.
	~OgreCausticCasterRenderTechnique ()
	Destructor.
String &	getCausticCubeMapName ()
	Returns the name of the created caustic cubemap.
Protected Member Functions
virtual void	photonMapRunChanged (RenderingRun *run)
	Called if the changed run is a PhotonMapRenderingRun.
virtual void	causticCubeMapRunChanged (RenderingRun *run)
	Called if the changed run is a CausticCubeMapRenderingRun.
virtual void	distanceCubeMapRunChanged (RenderingRun *run)
	Called if the changed run is a DistanceCubeMapRenderingRun.
virtual RenderingRun *	createPhotonMapRun ()
	Creates a PhotonMapRenderingRun.
virtual RenderingRun *	createCausticCubeMapRun ()
	Creates a CausticCubeMapRenderingRun.
virtual RenderingRun *	createDistanceCubeMapRun ()
	Creates a DistanceCubeMapRenderingRun.
Protected Attributes
String	photonMapMaterialName
	name of the created photon hit map texture
String	causticMapMaterialName
	name of the created caustic cubemap texture
unsigned char	photonMapTexID
	the texture unit state id of the caustic map generation material where the photonhit map should be bound to.

---

Detailed Description

CausticCasterRenderTechnique used in an OGRE environment.

---

Constructor & Destructor Documentation

OgreCausticCasterRenderTechnique::OgreCausticCasterRenderTechnique (  unsigned long  startFrame, unsigned long  photonMapUpdateInterval, unsigned int  photonMapResolution, unsigned int  custicCubeMapResolution, String  photonMapMaterialName, String  causticMapMaterialName, unsigned char  photonMapTexID, bool  updateAllFace, bool  useDistance, Pass *  pass, OgreRenderable *  parentRenderable, OgreTechniqueGroup *  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 photonMapMaterialName  the name of the material should be used when rendering the choton hit map causticMapMaterialName  the name of the material that should be used when rendering the caustic cubemap photonMapTexID  the texture unit state id of the caustic map generation material where the photonhit map should be bound to 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) pass  the pass to operate on parentRenderable  the object to operate on parentTechniqueGroup  the TechniqueGroup this RenderedTechnique is attached to

---

Member Function Documentation

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

Called if the changed run is a CausticCubeMapRenderingRun. Parameters: run  pointer to the changed CausticCubeMapRenderingRun Implements CausticCasterRenderTechnique.

RenderingRun * OgreCausticCasterRenderTechnique::createCausticCubeMapRun (   )  [protected, virtual]

Creates a CausticCubeMapRenderingRun. Returns: the new CausticCubeMapRenderingRun instance. Implements CausticCasterRenderTechnique.

RenderingRun * OgreCausticCasterRenderTechnique::createDistanceCubeMapRun (   )  [protected, virtual]

Creates a DistanceCubeMapRenderingRun. Returns: the new DistanceCubeMapRenderingRun instance. Implements CausticCasterRenderTechnique.

RenderingRun * OgreCausticCasterRenderTechnique::createPhotonMapRun (   )  [protected, virtual]

Creates a PhotonMapRenderingRun. Returns: the new PhotonMapRenderingRun instance. Implements CausticCasterRenderTechnique.

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

Called if the changed run is a DistanceCubeMapRenderingRun. Parameters: run  pointer to the changed DistanceCubeMapRenderingRun Implements CausticCasterRenderTechnique.

String & OgreCausticCasterRenderTechnique::getCausticCubeMapName (   )

Returns the name of the created caustic cubemap. Returns: name of the caustic cubemap texture

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

Called if the changed run is a PhotonMapRenderingRun. Parameters: run  pointer to the changed PhotonMapRenderingRun Implements CausticCasterRenderTechnique.

---

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

• OgreCausticCasterRenderTechnique.h
• OgreCausticCasterRenderTechnique.cpp

---