Changeset 2010 in orxonox.OLD for orxonox/branches/chris

Timestamp:

Jun 22, 2004, 12:09:56 PM (20 years ago)

Author:

chris

Message:

orxonox/branches/chris: Even more doxygen tags added, now it gets dokumented without haveing to enable EXTRACT_ALL

Location:

orxonox/branches/chris/src

Files:

• collision.h (modified) (1 diff)
• vector.h (modified) (4 diffs)

orxonox/branches/chris/src/collision.h

@@ -20 +20 @@
   Vector m;
 } CC_Tree;
+
+/**
+  This class implements a more or less efficient collision system based on nested hitzones.
+  Instead of using a brute force approach (try if any hitzone intersects with any other hitzone)
+  this features a tree of spheric hitzones. Only some of them are actually the solid groundstones
+  the collision model bases on, the others serve to group them into sets of spheres that are only
+  checked for collision when the assigned top level sphere has registered a collision, preventing
+  unnessessary checks (like between every sphere of two collision clusters at the other end of the world)
+  from being performed.
+  The CollisionCluster features collision detection between multiple CollisionClusters as well as
+  traceing a collision between a line of defined length and a cluster. In both cases the base spheres
+  that have intersected are marked with a flag in an unsigned long for hitlocation queries. In the case
+  of a trace, the exact point of interception is returned as well.
+*/
 
 class CollisionCluster {

orxonox/branches/chris/src/vector.h

@@ -6 +6 @@
 #define PI 3.14159265359f
 
+/**
+  Class for 3-dimensional vector calculation
+  
+  Supports all common vector operations (dot, cross, lenght and so on)
+*/
 class Vector {
 
@@ -30 +35 @@
 float angle_rad (const Vector& v1, const Vector& v2);
 
-float line_distance (Vector* l1, Vector* l2);
-
+/**
+  Class to handle 3-dimensional rotations
+  
+  Can create a rotation from several inputs, currently stores rotation using a 3x3 Matrix
+*/
 class Rotation {
   public:
@@ -47 +55 @@
 Vector rotate_vector( const Vector& v, const Rotation& r);
 
+/**
+  Class to store Lines in 3-dimensional space
+
+  Supports line-to-line distance measurements and rotation
+*/
 class Line
 {
@@ -65 +78 @@
 };
 
+/**
+  Class to handle planes in 3-dimensional space
+
+  Critical for polygon-based collision detection
+*/
 class Plane
 {