Changeset 2240 for GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/OgreSharedRuns.h

Timestamp:

03/13/07 09:27:17 (17 years ago)

Author:

szirmay

Message:

 

File:

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

GTP/trunk/Lib/Illum/IllumModule/OgreIllumModule/include/OgreSharedRuns.h

@@ -19 +19 @@
         RenderTarget* renderTarget;
 };
+
 /**
         @brief Class of SharedRuns used in an OGRE environment. 
@@ -183 +184 @@
         //inherited
         void destroy();
+        //inherited
         void runUpdated(RenderingRunType runType, RenderingRun* run);
+        //inherited
         void runChanged(RenderingRunType runType, RenderingRun* run);
+        //inherited
         virtual void addTechniqueGroup(TechniqueGroup* group){childTechniqueGroups.push_back(group);}
+        /**
+         @brief Sets the given material for all connected renderables.
+
+         The previous materials will be stored so later can be restored. @see restoreMaterial
+
+         @param name of the material to be set.
+        */
         void setMaterial(String materialName);
+        /**
+                @brief Restores the prevoius materials for the connected renderables. @see setMaterial
+        */
         void restoreMaterial();
 
@@ -203 +217 @@
         std::map<RenderingRunType, RenderingRun*> sharedRuns;
         /**
-                @brief map of connected renderablis with visibility information
+                @brief map of connected renderables with visibility information
 
                 Used to show or hide the renderables connected to a leaf OgreSharedRuns node.
         */
-        std::map<OgreRenderable*, bool> renderables; 
+        std::map<OgreRenderable*, bool> renderables;
+        /**
+                @brief map of connected renderables with material name information
+
+                Used to resture the original materials of the renderables connected to a leaf OgreSharedRuns node.
+        */
         std::map<OgreRenderable*, String> renderableMaterials;
         /**