Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

PhotonMapFilteringRenderingRun Class Reference

Computes a filtered photon map texture for an entity. More...

#include <PhotonMapFilteringRenderingRun.h>

Inheritance diagram for PhotonMapFilteringRenderingRun:

PreComputingRun RenderingRun List of all members.

Public Member Functions

TexturePtr getAreaMapTexturePtr ()
 Obtaining the area map.
NormalMapPassgetNormalMapPass ()
 Obtaining the normal map pass.
PhotonMapFilteringPassgetPhotonMapFilteringPass ()
 Obtaining the photon map filtering pass.
virtual const String & getResultTextureName ()
 Getter method to obtain the name of the filtered photon map texture object.
TexturePtr getUnfilteredPhotonMapTexturePtr ()
 Obtaining the unfiltered photon map texture.
void init (float areaCompensation=-1.0, float normalThreshold=-1.0)
 Initializes the uniform rendering parameters.
 PhotonMapFilteringRenderingRun (Entity *entity, const String &areaMapName, const String &unfilteredPhotonMapName)
void setAreaMapTexturePtr (TexturePtr areaMap)
 Setting up the area map texture.
void setNormalMapPass (NormalMapPass *normalMapPass)
 Setting up the normal map pass.
void setPhotonMapFilteringPass (PhotonMapFilteringPass *photonMapFilteringPass)
 Setting up the photon map filtering pass.
void setUnfilteredPhotonMapTexturePtr (TexturePtr unfilteredPhotonMap)
 Setting up the unfiltered photon map texture.
virtual void update ()
 Updates the filtered photon map texture corresponding to the actual parameters.
 ~PhotonMapFilteringRenderingRun ()

Private Attributes

TexturePtr areaMap
 Area map texture pointer.
Entity * entity
NormalMapPassnormalMapPass
 Normal map generator pass.
PhotonMapFilteringPassphotonMapFilteringPass
 Photon map filtering pass.
TexturePtr unfilteredPhotonMap
 Unfiltered photon map texture pointer.

Detailed Description

Computes a filtered photon map texture for an entity.


Constructor & Destructor Documentation

PhotonMapFilteringRenderingRun Entity *  entity,
const String &  areaMapName,
const String &  unfilteredPhotonMapName
 

Constructor.

Parameters:
entity The owner entity of an entity-bound precomputing run.
areaMapName The name of a texture file, which contains the area map.
unfilteredPhotonMapName The name of a texture file, which contains the unfiltered photon map.

~PhotonMapFilteringRenderingRun  ) 
 

Destructor.


Member Function Documentation

TexturePtr getAreaMapTexturePtr  )  [inline]
 

Obtaining the area map.

Returns:
TexturePtr object, which represents the the actual area map texture.
A getter method to obtain the area map texture object of the application.

NormalMapPass* getNormalMapPass  )  [inline]
 

Obtaining the normal map pass.

Returns:
pointer to the actual NormalMapPass object.
A getter method to obtain a pointer to the normal map pass object of the application.

PhotonMapFilteringPass* getPhotonMapFilteringPass  )  [inline]
 

Obtaining the photon map filtering pass.

Returns:
pointer to the actual PhotonMapFilteringPass object.
A getter method to obtain a pointer to the photon map filtering pass object of the application.

virtual const String& getResultTextureName  )  [virtual]
 

Getter method to obtain the name of the filtered photon map texture object.

Returns:
a reference to a String object, which represents the name of the filtered photon map texture object.

Reimplemented from PreComputingRun.

TexturePtr getUnfilteredPhotonMapTexturePtr  )  [inline]
 

Obtaining the unfiltered photon map texture.

Returns:
TexturePtr object, which represents the the actual unfiltered photon map texture.
A getter method to obtain the unfiltered photon map texture object of the application.

void init float  areaCompensation = -1.0,
float  normalThreshold = -1.0
 

Initializes the uniform rendering parameters.

Calling this method the area compensation and the normal threshold parameter of the filtering algorithm will be initialized. If the input parameters are -1.0 the corresponding member variables will not be changed.

void setAreaMapTexturePtr TexturePtr  areaMap  )  [inline]
 

Setting up the area map texture.

Parameters:
areaMap TexturePtr object, which represents the area map texture.
A setter method to define the area map texture object of the application.

void setNormalMapPass NormalMapPass normalMapPass  )  [inline]
 

Setting up the normal map pass.

Parameters:
normalMapPass pointer to a NormalMapPass object.
A setter method to define the normal map pass object of the application.

void setPhotonMapFilteringPass PhotonMapFilteringPass photonMapFilteringPass  )  [inline]
 

Setting up the photon map filtering pass.

Parameters:
photonMapFilteringPass pointer to a PhotonMapFilteringPass object.
A setter method to define the photon map filtering pass object of the application.

void setUnfilteredPhotonMapTexturePtr TexturePtr  unfilteredPhotonMap  )  [inline]
 

Setting up the unfiltered photon map texture.

Parameters:
unfilteredPhotonMap TexturePtr object, which represents the unfiltered photon map texture.
A setter method to define the unfiltered photon map texture object of the application.

virtual void update  )  [virtual]
 

Updates the filtered photon map texture corresponding to the actual parameters.

This method calls the update method of the normal map pass and the photon map filtering pass.

Implements PreComputingRun.


Member Data Documentation

TexturePtr areaMap [private]
 

Area map texture pointer.

A pointer to a texture which represents the area map of the surface of the scene. This map is loaded from file.

Entity* entity [private]
 

The owner entity

NormalMapPass* normalMapPass [private]
 

Normal map generator pass.

A pass to generate the normal map of the surface of the scene. The result will be contained in its member render texture object.

PhotonMapFilteringPass* photonMapFilteringPass [private]
 

Photon map filtering pass.

A pass to generate the filtered photon map of the surface of the scene. The result will be contained in its member render texture object.

TexturePtr unfilteredPhotonMap [private]
 

Unfiltered photon map texture pointer.

A pointer to a texture which represents the unfiltered photon map of the surface of the scene. This map is loaded from file.


The documentation for this class was generated from the following file:
Generated on Mon Apr 18 10:59:28 2005 for OGRE_IllumModule by  doxygen 1.4.2