Changeset 2150 for GTP/trunk/Lib/Geom/shared/GTGeometry/include/GeoLodTreeLibrary.h

Timestamp:

02/22/07 16:17:24 (17 years ago)

Author:

gumbau

Message:

Added comments to classes and methods

File:

• GTP/trunk/Lib/Geom/shared/GTGeometry/include/GeoLodTreeLibrary.h (modified) (1 diff)

GTP/trunk/Lib/Geom/shared/GTGeometry/include/GeoLodTreeLibrary.h

@@ -17 +17 @@
         class IndexData;
         class VertexData;
+        /// This class represents a tree object that is able to change its level of detail
+        /** It uses internally a LodStrips object to manage the level of detail of the trunk
+                The level of detail of the object initially is 1.0 (maximum quality)
+        */
         class LodTreeLibrary : public Geometry::LodObject
         {
         public:
+                /// Class constructor
+                /** Constructs an object from:
+                - LodStrips decimation info (for the trunk)
+                - LodTree simplification info (for the foliage)
+                - the Mesh containing the geometry of the tree
+                - a user-defined Geometry::IndexData instance */
                 LodTreeLibrary( const LodStripsLibraryData *,
                                                 const TreeSimplificationSequence *,
                                                 Geometry::Mesh *treeGeoMesh,
                                                 Geometry::IndexData *user_indexdata);
+
+                /// Class destructor
                 ~LodTreeLibrary(void);
 
-                // funciones ya descritas en la API
-/*              uint32 GoToTrunkLod(uint32 newlod);
-                uint32 MinTrunkLod(void) const;
-                uint32 MaxTrunkLod(void) const;
-                uint32 GoToFoliageLod(uint32 newlod);
-                uint32 MinFoliageLod(void) const;
-                uint32 MaxFoliageLod(void) const;*/
+                /// changes the lod of the entire object (trunk and leaves)
+                /** The value specified to chane the LOD must be in the range [0,1] ([min,max])
+                        After the LOD is calculated, this function automatically updates the indices
+                        using the IndexData interface provided in the constructor. */
+                virtual void GoToLod(Real);
 
+                /// changes the lod of the trunk
+                /** The value specified to chane the LOD must be in the range [0,1] ([min,max])
+                        After the LOD is calculated, this function automatically updates the indices
+                        using the IndexData interface provided in the constructor.*/
                 void GoToTrunkLod(Real);
+
+                /// changes the lod of the foliage
+                /** The value specified to chane the LOD must be in the range [0,1] ([min,max])
+                        After the LOD is calculated, this function automatically updates the indices
+                        using the IndexData interface provided in the constructor.*/
                 void GoToFoliageLod(Real);
 
-                // changes the lod of the entire object (trunk and leaves)
-                virtual void GoToLod(Real);
+                /// Retrieves the current real LOD factor of the object
                 virtual Real GetCurrentLodFactor(void) const { return (currentFoliageLodFactor+trunk->GetCurrentLodFactor())*0.5f; }
+
+                /// Retrieves a reference to the IndexData interface that manages the foliage, provided in the constructor
                 virtual Geometry::IndexData * GetIndexDataInterface(void){ return dataRetrievalInterface; }
 
-                // new proposed functions
-//              uint32 Get_Trunk_VertexCount(void) const;
-//              uint32 Get_Trunk_MaxIndexCount(uint32 istrip) const;
-//              uint32 CurrentLOD_Trunk_StripCount(void) const;
-//              uint32 CurrentLOD_Trunk_IndexCount(void) const;
-//              uint32 CurrentLOD_Trunk_IndexCountByStrip(uint32 istrip) const;
-/*              const VertexData* Get_Trunk_VertexData(void) const;*/
-                const IndexData* CurrentLOD_Trunk_Indices(void) const;
+                /// Retrieves a reference to the IndexData interface that manages the trunk
+                const Geometry::IndexData* CurrentLOD_Trunk_Indices(void) const;
+
+                /// Retrieves the index count of the trunk at the current level of detail
+                /** The maximum number of indices that the trunk will use to be rendered */
                 uint32 GetValidTrunkIndexCount(int isubmesh) const { return trunk->GetValidIndexCount(isubmesh); }
-//              uint32 GetValidTrunkOffset(int isubmesh) const { return trunk->GetValidOffset(isubmesh); }
 
-//              uint32 Get_Foliage_VertexCount(void) const;
+                /// Gets the index count of the foliage at its maximum level of detail
+                /** The maximum number of indices that the foliage will use to be rendered */
                 uint32 Get_Foliage_MaxIndexCount(void) const;
+
+                /// Retrieves the index count of the foliage at the current level of detail
                 uint32 CurrentLOD_Foliage_IndexCount(void) const;
-                const IndexData* CurrentLOD_Foliage_Indices(void) const;
-                const VertexData* Get_Foliage_VertexData(void) const;
+
+
+                        
+//              const IndexData* CurrentLOD_Foliage_Indices(void) const;
+//              const VertexData* Get_Foliage_VertexData(void) const;
+
+                /// Specifies which submesh of the Mesh (provided through the constructor) represents the foliage
+                /** The rest submeshes are considered as aprt of the trunk.
+                        This function is useful because the foliage must be rendered with triangle lists and the 
+                        trunk must be rendered with triangle strips */
                 uint32 GetLeavesSubMesh(void) const { return mLeavesSubMesh; }