Changeset 4923 in orxonox.OLD for orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.cc

Timestamp:

Jul 21, 2005, 4:27:06 PM (19 years ago)

Author:

patrick

Message:

orxonox/trunk: more cleanup, and more cleanup to come

File:

• orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.cc (modified) (7 diffs)

orxonox/trunk/src/lib/graphics/spatial_separation/quadtree_node.cc

@@ -17 +17 @@
 
 #include "quadtree_node.h"
+
 #include "quadtree.h"
 #include "material.h"
@@ -94 +95 @@
 
 /**
- * takes the rest of the initialisation process
+ *  takes the rest of the initialisation process
  */
 void QuadtreeNode::init()
@@ -136 +137 @@
 
 /**
-
+  \brief this functions builds up a hash table containing all leafs of the Quadtree in a sorted array
+  \param nodeList the nodelist array to add them
+  \param index the current index in the array
+
+  The algorithm used for this purpose is home-brown. its not to fast but and the nodes are not always in the right
+  order. this is why there will be needed a quicksort later on.
  */
 void QuadtreeNode::buildHashTable(QuadtreeNode** nodeList, int* index)
@@ -160 +166 @@
  *  gives the signal to separate the model into a quadtree
  * @param treeDepth the max depth, the steps to go if treeDept == 0 leaf reached
-*/
+ */
 void QuadtreeNode::separateNode(float minLength)
 {
@@ -361 +367 @@
 
 
+ /**
+  * checks if a point is included in this quadtree
+  * @param v the vector to be checked
+  * @returns true if the vector is included
+  */
 bool QuadtreeNode::includesPoint(const Vector& v)
 {
@@ -377 +388 @@
 
 /**
- *  draws the debug quadtree boxes around the model
+ *  draws all the debug quadtree squares
  */
 void QuadtreeNode::drawTree() const
@@ -408 +419 @@
 
 
+/**
+ *  draws only this quadtree square
+ */
 void QuadtreeNode::draw() const
 {