Changeset 3449 in orxonox.OLD for orxonox/trunk/src/vector.h

Timestamp:

Mar 2, 2005, 2:23:47 PM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: documented orxonox.cc/h world.cc/h vector.cc/h

File:

• orxonox/trunk/src/vector.h (modified) (4 diffs)

orxonox/trunk/src/vector.h

@@ -10 +10 @@
 
 #include <math.h>
+//! PI the circle-constant
 #define PI 3.14159265359f
 
@@ -20 +21 @@
   public:
  
-  float x, y, z;
+  float x; //!< The x Coordinate of the Vector.
+  float y; //!< The y Coordinate of the Vector.
+  float z; //!< The z Coordinate of the Vector.
 
   Vector (float x, float y, float z) : x(x), y(y), z(z) {}  //!< assignment constructor
@@ -51 +54 @@
  public:
         Vector v;       //!< Imaginary Vector
-        float w; //!< Real part of the number
+        float w;        //!< Real part of the number
 
         Quaternion ();
@@ -72 +75 @@
 
  private:
-        float DELTA;
+        float DELTA;      //!< resolution of calculation
 
 };