OgreCausticCubeMapRenderingRun Class Reference

ColorCubeMapRenderingRun used in an OGRE environment. More...

Inheritance diagram for OgreCausticCubeMapRenderingRun:

List of all members.

Public Member Functions
	OgreCausticCubeMapRenderingRun (OgreSharedRuns *sharedRuns, String name, unsigned long startFrame, unsigned long updateInterval, unsigned int resolution, String materialName, unsigned char photonMapTexId, bool updateAllFace)
	Constructor.
String &	getCausticCubeMapTextureName ()
	returns the name of the resulting caustic cubemap texture
void	photonMapChanged (RenderingRun *run)
	Called if the changed run is a PhotonMapRenderingRun.
Protected Member Functions
void	createCausticCubeMap ()
	Creates a cubemap texture used for the caustic-cubemap.
void	updateCubeFace (int facenum)
	Updates one face of the cubemap.
bool	faceNeedsUpdate (int facenum)
	Checks if a cubemap face needs to be updated.
Protected Attributes
unsigned char	photonMapTexId
	the texture unit state id of the caustic map generation material where the photonhit map should be bound to
OgreSharedRuns *	sharedRuns
	a pointer to the OgreSharedRuns this run belongs to
String	name
	the name of the cubemap texture that was created by this run
Texture *	causticCubemapTexture
	a pointer to the cubemap texture that was created by this run
String	materialName
	the name of the material that should be used when rendering the caustic cubemap

---

Detailed Description

ColorCubeMapRenderingRun used in an OGRE environment.

---

Constructor & Destructor Documentation

OgreCausticCubeMapRenderingRun::OgreCausticCubeMapRenderingRun (  OgreSharedRuns *  sharedRuns, String  name, unsigned long  startFrame, unsigned long  updateInterval, unsigned int  resolution, String  materialName, unsigned char  photonMapTexId, bool  updateAllFace )

Constructor. Parameters: sharedRuns  a pointer to the OgreSharedRuns this run belongs to name  the name of the cubemap texture to be created startFrame  adds an offset to the current frame number to help evenly distribute updates between frames updateInterval  update frequency resolution  cubemap resolution materialName  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

---

Member Function Documentation

bool OgreCausticCubeMapRenderingRun::faceNeedsUpdate (  int  facenum  )  [protected, virtual]

Checks if a cubemap face needs to be updated. If the object we are updating the cubemap for is far from the camera, or too small, or the given cubemapface does not have significant effect on the rendering the face can be skipped. Parameters: facenum  the number of the face to be checked Implements CausticCubeMapRenderingRun.

void OgreCausticCubeMapRenderingRun::photonMapChanged (  RenderingRun *  run  )  [virtual]

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

void OgreCausticCubeMapRenderingRun::updateCubeFace (  int  facenum  )  [inline, protected, virtual]

Updates one face of the cubemap. Parameters: facenum  the number of the face to be updated Implements CausticCubeMapRenderingRun.

---

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

• OgreCausticCubeMapRenderingRun.h
• OgreCausticCubeMapRenderingRun.cpp

---