Changeset 2153 for GTP/trunk/Lib/Geom/shared/GTGeometry/include

Timestamp:

02/22/07 17:41:33 (18 years ago)

Author:

gumbau

Message:

Added some comments to the class

File:

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

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

@@ -21 +21 @@
         class lodobj_node_t;
 
+        /// This class implements a LOD manager for level of detail objects such as (LodStrips and LodTree objects)
+        /** This class automatically manages the level of detail of all objects added to the lod manager. 
+                The key idea is to minimize the number of real changes in levels of detail because they consume 
+                CPU and that can cause stalls and CPU bottlenecks in massive applications. The LodManager solves
+                this issue by deciding which objects have to change the level of detail and which objects can just 
+                share an already calculated one. The system also decides whether an object can chage its level of 
+                detail or it is not needed because it would take not effect on the performance. This drastically 
+                reduces the CPU usage. in a completely transparent way to the user. */
+
         class LodManager
         {       
         public:
+                /// LodManager constructor
+                /** Constucts a LodManager object from the following parameters:
+                        - The near and far distances that define the active LOD range.
+                        - The initial camera position
+                        - The number of LOD slots in the snapshot list (this parameter is optional)
+                */
                 LodManager(Real near, Real far, const Geometry::Vector3 &campos, int numslots=10);
+
+                /// class destructor
                 ~LodManager(void);
+
+                /// Adds a new LOD object (a LodStrips or a LodTree object)
+                /** When an object is added to the system,  its level of detail is automatically managed, and the 
+                        client application does not need to manually change its level of detail. 
+                        The parameters needed to add an object to the system are:
+                        - The class name of the object. The class name is the type of object. This is used by the system to 
+                          know which objects are compatible to change the level of detail between themselves. 
+                        - A reference to the LodObject itself (a LodStrips or a LodTree object).
+                        - The initial position in the 3D space of the added object. */
                 void AddLodObj(const std::string &name, LodObject*, const Geometry::Vector3 &);
-                void UpdateLOD(uint32 currFPS, uint32 targetFPS=30);
+
+                /// Performs all needed LOD updates
+                /** This function should be called once per frame (or at some reasonable interval). 
+                        Internally it performs all needed steps to change the level of detail of the objects. */
+                void UpdateLOD(void);
+
+                /// Updates the camera position
                 void UpdateCamera(const Geometry::Vector3 &);
+
+                /// Updates the position of a certain LodObject
                 void UpdateLODObjectPos(LodObject*,const Geometry::Vector3 &);
 
-                bool always_calculate_lod; // if true, there is no instant LOD changing
-                bool force_highest_lod; // if set to true, all objects will be set to their highest level of detail
+                /// Set it to true to force all LOD calculations (disable the LodManager features)
+                bool always_calculate_lod;
+
+                /// if set to true, all objects will be set to their highest level of detail
+                bool force_highest_lod;
 
         private: