Changeset 7498 in orxonox.OLD

Timestamp:

May 3, 2006, 1:16:35 AM (18 years ago)

Author:

patrick

Message:

orxonox: finished first ruff cleanup. now its about the algorithms

Location:

trunk/src/lib/graphics/importer

Files:

• height_map.cc (modified) (10 diffs)
• height_map.h (modified) (1 diff)

trunk/src/lib/graphics/importer/height_map.cc

@@ -328 +328 @@
 
 
-
+/**
+ * constructor
+ *  @param heightMapName file name of the height map
+ */
 HeightMap::HeightMap(const std::string& heightMapName)
     : VertexArrayModel()
@@ -337 +340 @@
 }
 
+
+/**
+ * constructor
+ *  @param heightMapName file name of the height map
+ *  @param colorMapName file name of the color map
+ */
 HeightMap::HeightMap(const std::string& heightMapName, const std::string& colorMapName)
     : VertexArrayModel()
 {
-
   this->init(heightMapName);
 
@@ -355 +363 @@
     PRINTF(0)("Rmask: %i\n", this->colorMap->format->Rmask);
     PRINTF(0)("Gmask: %i\n", this->colorMap->format->Gmask);
+
+    this->colors = (unsigned char *) colorMap->pixels;
+    this->hasColourMap = true;
   }
   else
+  {
     PRINTF(0)("oops! couldn't load colorMap for some reason.\n");
-
-
-
-  if(colorMap != NULL)
-  {
-    colors = (unsigned char *) colorMap->pixels;
-    hasColourMap = true;
-  }
-  else
-    hasColourMap = false;
-
-
-  heights  = (unsigned char*) heightMap->pixels;
-  shiftX = 0;
-  shiftY = 0;
-  shiftZ = 0;
-}
-
-
+    this->hasColourMap = false;
+  }
+}
+
+
+/**
+ * deconstructor
+ */
 HeightMap::~HeightMap()
 {
@@ -430 +431 @@
 
   generateNormalVectorField();
-}
-
-
+
+  this->heights = (unsigned char*)heightMap->pixels;
+}
+
+
+/**
+ * this function loads the heightmap by creatin tiles
+ */
 void HeightMap::load()
 {
-
   //Create a Dynamicly sized 2D-Array for Tiles
   tiles =  new Tile** [heightMap->h/tileSize];
@@ -450 +455 @@
     }
   }
-
-}
-
-
-void HeightMap::draw()
+}
+
+
+/**
+ * this function draws the height map
+ */
+void HeightMap::draw() const
 {
   const PNode* camera = State::getCameraNode();
@@ -473 +480 @@
     }
   }
-
-}
+}
+
+
+/**
+ * this function generates the normal vector field
+ */
 void HeightMap::generateNormalVectorField()
 {
@@ -485 +496 @@
     normalVectorField [i]= new (Vector [heightMap->w]);
 
-
-
-
   // Initialize
   for(int i=0; i< heightMap->h; i++)
@@ -524 +532 @@
 
   }
-
-
-
-
-}
-
-
+}
+
+
+/**
+ * scales the height map about a vector
+ *  @param v scaling vector
+ */
 void HeightMap::scale(Vector v)
 {
@@ -539 +547 @@
 }
 
+
+/**
+ * sets the absolute coordinates of the height map
+ *  @param v the moving vector
+ */
 void HeightMap::setAbsCoor(Vector v)
 {
   offsetX = v.x;
   offsetY = v.y;
-  offsetZ  = v.z;
-}
-
-
+  offsetZ = v.z;
+}
+
+
+/**
+ * returns the height at a given 2D coordinate
+ *  @param x x coordinate of the height map (world space)
+ *  @param y y coordinate of the height map (world space)
+ *  @return the height (z)
+ */
 float HeightMap::getHeight(float x, float y)
 {
-
   x -= offsetX;
   y -= offsetZ;
-
 
   int xInt = (int)( x / scaleX);
@@ -571 +588 @@
   float height = heights[yInt + (xInt)*heightMap->w]*scaleY;
 
-
   float a = normalVectorField[(xInt)][yInt].x;
   float b = normalVectorField [(xInt)][yInt].z;

trunk/src/lib/graphics/importer/height_map.h

@@ -92 +92 @@
     void scale( Vector V);
 
-    void draw();
+    void draw() const;