Changeset 2264 for GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderingRuns/OgrePMWeightComputeRenderingRun.h

Timestamp:

03/19/07 13:02:58 (17 years ago)

Author:

szirmay

Message:

 

File:

• GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderingRuns/OgrePMWeightComputeRenderingRun.h (modified) (3 diffs)

GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/RenderingRuns/OgrePMWeightComputeRenderingRun.h

@@ -13 +13 @@
 
 /**
-        @brief ColorCubeMapRenderingRun used in an OGRE environment.
+        @brief Weight computing rendering run.
+
+        This run is used in the pathmap technique. 
+        It creates a texture for a light source that stores the weights that should be used for each cluster of entry points.
 */
 class OgrePMWeightComputeRenderingRun : public OgreRenderingRun                                                                 
@@ -22 +25 @@
                 @brief Constructor.
 
-                
+        @param name the name of the weight texture to be created
+                @param LightName the name of the light source to use
         */      
         OgrePMWeightComputeRenderingRun(String name, String LightName);
         /**
-                @brief returns the name of the camera depth texture
+                @brief returns the name of the weight texture
         */
         String getPMWeightTetureName(){return weightTexture->getName();}
+        //not used
         float* getWeights(){return weights;}
         
 protected:
         /**
-                @brief pointer to the player's viewport 
+                @brief light view-projection matrix
         */
         Matrix4 lightMatrix;
+        /**
+                @brief light view matrix
+        */
         Matrix4 lightViewMatrix;
         /**
@@ -42 +50 @@
         String name;
         /**
-                @brief a pointer to the scene depth texture that was created by this run
+                @brief a pointer to the weight texture that was created by this run
         */
         Texture* weightTexture;
+        /**
+                @brief A pointer to a texture that stores weights for all the entry point.
+
+                This texture will be used to determine the weights of the clusters.
+        */
         Texture* allWeightsTexture;
-        
+        /**
+                @brief A pointer to the light source.
+        */
         Light* light;
-
+        //not used
         float* weights;
-
         //inherited
         void updateFrame(unsigned long frameNum);       
-        
+        /**
+                @brief Creates the weight texture.
+
+                It also creates the texture storing all weights. @see allWeightsTexture
+        */
         inline void createWeightMap();
 };