OgreDistanceCubeMapRenderingRun Class Reference

ColorCubeMapRenderingRun used in an OGRE environment. More...

Inheritance diagram for OgreDistanceCubeMapRenderingRun:

OgreRenderingRun DistanceCubeMapRenderingRun RenderingRun RenderingRun List of all members.

Public Member Functions

 OgreDistanceCubeMapRenderingRun (OgreSharedRuns *sharedRuns, String name, unsigned long startFrame, unsigned long updateInterval, unsigned int resolution, bool useDistCalc=false, bool useFaceAngleCalc=false, float distTolerance=15, float angleTolerance=10, bool updateAllFace=false)
 Constructor.
String getDistanceCubeMapTextureName ()
 returns the name of the resulting distance cubemap texture

Protected Member Functions

void createDistanceCubeMap ()
 Creates a cubemap texture used for the color-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

OgreSharedRunssharedRuns
 a pointer to the OgreSharedRuns this run belongs to
String name
 the name of the cubemap texture that was created by this run
Texture * distanceCubemapTexture
 a pointer to the cubemap texture that was created by this run

Detailed Description

ColorCubeMapRenderingRun used in an OGRE environment.


Constructor & Destructor Documentation

OgreDistanceCubeMapRenderingRun::OgreDistanceCubeMapRenderingRun OgreSharedRuns sharedRuns,
String  name,
unsigned long  startFrame,
unsigned long  updateInterval,
unsigned int  resolution,
bool  useDistCalc = false,
bool  useFaceAngleCalc = false,
float  distTolerance = 15,
float  angleTolerance = 10,
bool  updateAllFace = false
 

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
useDistCalc flag to skip cube face update if object is far away
useFaceAngleCalc flag to skip cube face update if face is neglible
distTolerance distance tolerance used in face skip
angleTolerance angle tolerance used in face skip
updateAllFace defines if all cubemap faces should be updated in a frame or only one face per frame


Member Function Documentation

bool OgreDistanceCubeMapRenderingRun::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 DistanceCubeMapRenderingRun.

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

Updates one face of the cubemap.

Parameters:
facenum the number of the face to be updated

Implements DistanceCubeMapRenderingRun.


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