Changeset 2014 in orxonox.OLD for orxonox/branches/chris/src

Timestamp:

Jun 22, 2004, 6:12:59 PM (21 years ago)

Author:

chris

Message:

orxonox/branches/chris: Even more doxygen stuff as well as removal of the deprecated rotation.h/.cc

Location:

orxonox/branches/chris/src

Files:

• collision.h (modified) (2 diffs)
• coordinates.h (modified) (3 diffs)
• rotation.cc (deleted)
• rotation.h (deleted)
• vector.h (modified) (4 diffs)

orxonox/branches/chris/src/collision.h

@@ +1 @@
+/*! 
+    \file collision.h
+    \brief Basic collision detection
+*/ 
 
 #ifndef COLLISION_H
@@ -9 +13 @@
 #include <strings.h>
 
+//! Tree structure used by the CollisionCluster
 typedef struct CC_Tree
 {

orxonox/branches/chris/src/coordinates.h

@@ +1 @@
+/*! 
+    \file coordinates.h
+    \brief Basic coordinate system definitions
+*/ 
+
 #ifndef COORDINATES_H
 #define COORDINATES_H
@@ -8 +13 @@
   This identifies the position of an object on the track system
 */
-typedef struct Location
+typedef struct
 {
   unsigned long part;   //!< ID of the track part the object is on
@@ -20 +25 @@
   This is used to store the position of a object in the rendered coordinate system
 */
-typedef struct Placement
+typedef struct
 {
   Vector r;              //!< Absolute x/y/z coordinates

orxonox/branches/chris/src/vector.h

@@ +1 @@
+/*! 
+    \file vector.h
+    \brief A basic 3D math framework
+    
+    Contains classes to handle vectors, lines, rotations and planes
+*/ 
 
 #ifndef VECTOR_H
@@ -38 +44 @@
 //! 3D rotation
 /**
-  Class to handle 3-dimensional rotations
-  
+  Class to handle 3-dimensional rotations.
   Can create a rotation from several inputs, currently stores rotation using a 3x3 Matrix
 */
@@ -45 +50 @@
   public:
   
-  float m[9]; //< 3x3 Rotation Matrix
+  float m[9]; //!< 3x3 Rotation Matrix
   
   Rotation ( const Vector& v);
@@ -55 +60 @@
 };
 
+//!< Apply a rotation to a vector
 Vector rotate_vector( const Vector& v, const Rotation& r);