Changeset 2012 in orxonox.OLD for orxonox/branches/chris/src/vector.h

Timestamp:

Jun 22, 2004, 12:45:28 PM (20 years ago)

Author:

chris

Message:

orxonox/branches/chris: Improved doxygen compatibility again

File:

• orxonox/branches/chris/src/vector.h (modified) (8 diffs)

orxonox/branches/chris/src/vector.h

@@ -6 +6 @@
 #define PI 3.14159265359f
 
+//! 3D vector
 /**
   Class for 3-dimensional vector calculation
@@ -17 +18 @@
   float x, y, z;
 
-  Vector (float x, float y, float z) : x(x), y(y), z(z) {}
+  Vector (float x, float y, float z) : x(x), y(y), z(z) {}  //!< assignment constructor
   Vector () : x(0), y(0), z(0) {}
   ~Vector () {}
@@ -35 +36 @@
 float angle_rad (const Vector& v1, const Vector& v2);
 
+//! 3D rotation
 /**
   Class to handle 3-dimensional rotations
@@ -43 +45 @@
   public:
   
-  float m[9];
+  float m[9]; //< 3x3 Rotation Matrix
   
   Rotation ( const Vector& v);
@@ -55 +57 @@
 Vector rotate_vector( const Vector& v, const Rotation& r);
 
+//! 3D line
 /**
   Class to store Lines in 3-dimensional space
@@ -64 +67 @@
   public:
   
-  Vector r, a;
+  Vector r;   //!< Offset
+  Vector a;   //!< Direction
   
-  Line ( Vector r, Vector a) : r(r), a(a) {}
+  Line ( Vector r, Vector a) : r(r), a(a) {}  //!< assignment constructor
   Line () : r(Vector(0,0,0)), a(Vector (1,1,1)) {}
   ~Line () {}
@@ -78 +82 @@
 };
 
+//! 3D plane
 /**
   Class to handle planes in 3-dimensional space
-
+  
   Critical for polygon-based collision detection
 */
@@ -87 +92 @@
   public:
   
-  Vector n;
-  float k;
+  Vector n;   //!< Normal vector
+  float k;    //!< Offset constant
   
   Plane (Vector a, Vector b, Vector c);
   Plane (Vector norm, Vector p);
-  Plane (Vector n, float k) : n(n), k(k) {}
+  Plane (Vector n, float k) : n(n), k(k) {} //!< assignment constructor
   Plane () : n(Vector(1,1,1)), k(0) {}
   ~Plane () {}