CubeMapRenderTechnique Class Reference

Base abstract class of rendering a color cube map. More...

Inheritance diagram for CubeMapRenderTechnique:

List of all members.

Public Member Functions
	CubeMapRenderTechnique (unsigned long startFrame, unsigned long cubeMapUpdateInterval, unsigned int cubeMapResolution, bool useDistCalc, bool useFaceAngleCalc, float distTolerance, float angleTolerance, bool updateAllFace, ElementaryRenderable *parentRenderable, TechniqueGroup *parentTechniqueGroup)
	Constructor.
virtual void	update (unsigned long frameNum)
	Updates the resources in the given frame.
void	runChanged (RenderingRunType runType, RenderingRun *run)
	Called after one of he shared runs changes.
Protected Member Functions
virtual void	colorCubeMapRunChanged (RenderingRun *run)=0
	Called if the changed run is a ColorCubeMapRenderingRun.
virtual RenderingRun *	createColorCubeMapRun ()=0
	Creates a ColorCubeMapRenderingRun.
Protected Attributes
bool	useDistCalc
	a flag to skip cube face update if object is far away or too small.
bool	useFaceAngleCalc
	a flag to skip cube face update the face is neglible.
float	distTolerance
	A value used in face skip test.
float	angleTolerance
	A value used in face skip test.
bool	updateAllFace
	defines if all cubemap faces should be updated in a frame or only one face per frame
unsigned long	cubeMapUpdateInterval
	color-cubemap update frequency
unsigned int	cubeMapResolution
	color-cubemap resolution
unsigned long	startFrame
	offset in frame number used during update

---

Detailed Description

Base abstract class of rendering a color cube map.

This technique defines that the final rendering of an object needs a cubmap of the colors of the surrounding environment.

---

Constructor & Destructor Documentation

CubeMapRenderTechnique::CubeMapRenderTechnique (  unsigned long  startFrame, unsigned long  cubeMapUpdateInterval, unsigned int  cubeMapResolution, bool  useDistCalc, bool  useFaceAngleCalc, float  distTolerance, float  angleTolerance, bool  updateAllFace, ElementaryRenderable *  parentRenderable, TechniqueGroup *  parentTechniqueGroup )

Constructor. Parameters: startFrame  adds an offset to the current frame number to help evenly distribute updates between frames cubeMapUpdateInterval  update frequency cubeMapResolution  color 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 parentRenderable  the object to operate on parentTechniqueGroup  the TechniqueGroup this RenderedTechnique is attached to

---

Member Function Documentation

virtual void CubeMapRenderTechnique::colorCubeMapRunChanged (  RenderingRun *  run  )  [protected, pure virtual]

Called if the changed run is a ColorCubeMapRenderingRun. Parameters: run  pointer to the changed ColorCubeMapRenderingRun Implemented in OgreCubeMapRenderTechnique.

virtual RenderingRun* CubeMapRenderTechnique::createColorCubeMapRun (   )  [protected, pure virtual]

Creates a ColorCubeMapRenderingRun. Returns: the new ColorCubeMapRenderingRun instance. Implemented in OgreCubeMapRenderTechnique.

void CubeMapRenderTechnique::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.

void CubeMapRenderTechnique::update (  unsigned long  frameNum  )  [virtual]

Updates the resources in the given frame. Parameters: frameNum  the actual framenumber Reimplemented from RenderTechnique. Reimplemented in OgreCubeMapRenderTechnique.

---

Member Data Documentation

float CubeMapRenderTechnique::angleTolerance [protected]

A value used in face skip test. The higher this value gets the more precise, but slower the method will be.

float CubeMapRenderTechnique::distTolerance [protected]

A value used in face skip test. The higher this value gets the more precise, but slower the method will be.

bool CubeMapRenderTechnique::useDistCalc [protected]

a flag to skip cube face update if object is far away or too small. See also: distTolerance

bool CubeMapRenderTechnique::useFaceAngleCalc [protected]

a flag to skip cube face update the face is neglible. See also: angleTolerance

---

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

• CubeMapRenderTechnique.h
• CubeMapRenderTechnique.cpp

---