Changeset 2150 for GTP/trunk/Lib/Geom/shared/GTGeometry/include/GeoLodStripsLibrary.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/GeoLodStripsLibrary.h (modified) (4 diffs)

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

@@ -51 +51 @@
         typedef std::vector     <Long>                                          LongVector;
 
-        /// LodStripsLibrary interface class.
+
+        class LodStripsLibraryData
+        {
+                public:
+
+                        SmallIntVector                                                          mFileVertices;
+                        std::vector     <LODRegisterType>       mFileChangesLOD;
+                        LongVector                                                                              mData;
+                        std::vector<unsigned int>                       p_changes;
+        };
+
+        /// The LodStripsLibrary interface class.
         /** This module contains functions that handle the levels of detail 
          *      of the input multiresolution objects made of polygonal meshes.
@@ -58 +69 @@
          *      that is, at the level of detail requested. These models use 
          *      triangle strips to reduce storage usage and to speed up realistic 
-         *      rendering.
-        \n\n
-
-Inputs:\n
-        - The module receives a file describing a multiresolution object.
-        .
-
-Outputs:\n
-        - The module returns a strip set that represents the level of 
-                detail requested.
-        .
-
-        */
-        class LodStripsLibraryData
-        {
-                public:
-
-                        SmallIntVector                                                          mFileVertices;
-                        std::vector     <LODRegisterType>       mFileChangesLOD;
-                        LongVector                                                                              mData;
-                        std::vector<unsigned int>                       p_changes;
-        };
+         *      rendering. */
 
         class GEOLODLIBRARYDLL_API LodStripsLibrary : public Geometry::LodObject
@@ -138 +128 @@
                         void    LoadStripMesh(const LodStripsLibraryData *, Mesh *geomesh);
 
-//                      Geometry::CREATEINDEXDATAFUNC create_index_data_func;
-
                         //      Strips vector.
                         SmallIntVector  *mStrips;
@@ -159 +147 @@
                 public:
 
-                        IndexData *GetIndexDataInterface(void)
+                        /// Class constructor
+                        /**     Constructs a LodStrips multiresolution object from:
+                                - The LodStrips decimation information (this can be obtained using the class Geometry::MeshLoader)
+                                - The Mesh object defining the geometry of the model at its full level of detail (this can be obtained using the class Geometry::MeshLoader)
+                                - a user-defined Geometry::IndexData instance
+                        */
+                        LodStripsLibrary(const  LodStripsLibraryData *,
+                                                         Mesh   *geomesh,
+                                                         IndexData      *userindexdata);
+
+                        /// Class destructor.
+                        ~LodStripsLibrary(void);
+
+                        /// changes the level of detail of the object to a specified factor
+                        /** 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);
+
+                        /// Returns the number of triangles of the highest LOD.
+                        uint32  MaxFaces() const;
+
+                        /// Returns the number of triangles of the lowest LOD.
+                        uint32  MinFaces() const;
+
+                        /// Returns the index count at the current LOD of a certain submesh
+                        uint32 GetValidIndexCount(int submeshid)        const
+                        {
+                                return indices_x_submesh[submeshid];
+                        }
+
+                        /// Retrieves the total number of strips of all submeshes
+                        uint32 GetTotalStripCount(void) const
+                        {
+                                return mTotalStrips;
+                        }
+
+                        /// Returns the number of strips of a given submesh
+                        uint32 GetSubMeshtripCount(int submeshid)       const
+                        {
+                                return mStripsSubmesh[submeshid];
+                        }
+
+                        /// Gets the triangle count at the current LOD
+                        uint32 GetCurrentTriangleCount(void)    const
+                        {
+                                return current_triangle_count;
+                        }
+
+                        /// Gets the current LOD factos
+                        virtual Real GetCurrentLodFactor(void)  const
+                        {
+                                return lodFactor;
+                        }
+
+                        // Retrieves the IndexData index interface
+                        Geometry::IndexData *GetIndexDataInterface(void) const
                         {
                                 return dataRetrievalInterface;
                         }
-                        
-                        /**     Constructor, receives as a parameter the name of the file
-                         *      including the multiresolution object.
-                        */
-                        LodStripsLibrary(       const   LodStripsLibraryData *,
-                                                                                                Mesh    *geomesh,
-                                                                                                IndexData       *userindexdata = NULL);
-
-                        /// Destructor.
-                        ~LodStripsLibrary(void);
-
-                        /// Returns de current LOD and changes to the specified LOD.
-                        virtual void GoToLod(Real);
-
-                        /// Establishes the new LOD range.
-                        /// Only the LODs in that range are stored and used.
-                        void    TrimByLod(uint32, uint32);
-
-                        /// Returns the number of triangles of the highest LOD.
-                        uint32  MaxFaces();
-
-                        /// Returns the number of triangles of the lowest LOD.
-                        uint32  MinFaces();
-
-                        /// Returns the number of vertices of the highest LOD.
-                        uint32  MaxVertices();
-
-                        /// Returns the number of vertices of the lowest LOD.
-                        uint32  MinVertices();
-
-                        uint32 GetValidIndexCount(int submeshid)        const
-                        {
-                                return indices_x_submesh[submeshid];
-                        }
-
-                        uint32 GetTotalStripCount(void) const
-                        {
-                                return mTotalStrips;
-                        }
-
-                        uint32 GetSubMeshtripCount(int submeshid)       const
-                        {
-                                return mStripsSubmesh[submeshid];
-                        }
-
-                        uint32 GetCurrentTriangleCount(void)    const
-                        {
-                                return current_triangle_count;
-                        }
-
-                        virtual Real GetCurrentLodFactor(void)  const
-                        {
-                                return lodFactor;
-                        }
+
+                        // deprecated functions
+//                      void    TrimByLod(uint32, uint32);
+/*                      uint32  MaxVertices();
+                        uint32  MinVertices();*/
         };
 }