Changeset 8320 in orxonox.OLD for branches/terrain/src/lib

Timestamp:

Jun 11, 2006, 8:26:09 PM (18 years ago)

Author:

ponder

Message:

Added a bunch of comments to the terrain_page.h file

File:

• branches/terrain/src/lib/graphics/importer/terrain/terrain_page.h (modified) (9 diffs)

branches/terrain/src/lib/graphics/importer/terrain/terrain_page.h

@@ -44 +44 @@
                  */
                 TerrainPage( Terrain *_owner, int _xOffset, int _zOffset );
-                
+                /**
+                 * This is used only internally for communication between the TerrainPage and
+                 * the Terrain class itself.
+                 */
                 inline bool isActive() { return active; }
+                
+                
                 ~TerrainPage( )
                 { 
@@ -58 +63 @@
                 void mimick( int _level ) {}
                 
+                /**
+                 * Draws a box around the TerrainPage. For debugging purposes.
+                 */
                 void drawBox();
+                
+                /** 
+                 * Calculates the smallest fitting axis aligned bounding box for this TerrainPage.
+                 */
                 virtual void calculateBounds();         
+                
+                
                 /**
                  * Sets the visibility to _flag. If the visibility changed, the vertex and index
@@ -67 +81 @@
 
                 /**
-                 * If
+                 * Prepares the page for rendering.
                  */
                 void show( );
+                
+                /**
+                 *
+                 */
                 void hide( ); 
-                /**
-                 * 
+                
+                /**
+                 * Updates the tesselation if necessary.
                  */
                 void updateTesselation( );
@@ -82 +101 @@
                 
                 /**
-                 * Returns the curren tween factor. This is a number between 0.0f and 1.0f
+                 * Returns the curren tween factor. This is a floating point value  between 0.0f and 1.0f
                  */
                 float getTween() { return 0.0f; }
@@ -94 +113 @@
                  */
                 int chooseLOD();
+                
                 /**
                  * If the terrain pages tesselation level changed between the last and the
@@ -99 +119 @@
                  * return value.
                  */
-                bool isDirty() { return true; }
+                bool isDirty() { return forceTesselation; }
                 
                 /**
@@ -111 +131 @@
                  */
                 void calculateError( int _lod );
+                
+                
                 /**
                  * Tests if the terrain page would cull against the viewing frustum.
                  */
                 bool cull( );
-                
-                void calculateMinMax();
                 
                 /**
@@ -127 +147 @@
                         left = _left; right = _right; top = _top; bottom = _bottom;
                 }
+                
+                /**
+                 * Sets the position of the TerrainPage. Is this needed?
+                 */
                 inline void setPosition( const Triple& _pos )
                 {
@@ -139 +163 @@
                 void draw( );
                 
+                /**
+                 * Returns the next active page
+                 */
                 inline pTerrainPage getNext() { return next; }
+                
+                /**
+                 * Returns the previous active page
+                 */
                 inline pTerrainPage getPrevious() { return previous; }                  
+                
+                /**
+                 * Returns the wanted LOD. Make sure you call this method after a call to
+                 * chooseLOD() or you will get screwed values.
+                 */
                 inline int getWantedLOD() { return wantedLOD; }
+                
+                /**
+                 * Removes the page from the active page list.
+                 */
                 void deactivate();
+                
+                /** 
+                 * Inserts the page into the active page list.
+                 */
                 void activate();                
                 protected:
+                        
                         
                         inline void addIndex( unsigned short _index );