Changeset 2012 in orxonox.OLD for orxonox/branches/chris/src/coordinates.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/coordinates.h (modified) (1 diff)

orxonox/branches/chris/src/coordinates.h

@@ -4 +4 @@
 #include "vector.h"
 
-typedef struct Location // place of a thing on the track system
+//! Coordinates relative to track
+/**
+  This identifies the position of an object on the track system
+*/
+typedef struct Location
 {
-  unsigned long part;   // ID of the track part the object is on
-  float dist;           // distance already traveled on a track
-  Vector pos;           // position relative to the distance already covered
-  Rotation rot;         // direction the object is heading (relative to track direction)
+  unsigned long part;   //!< ID of the track part the object is on
+  float dist;           //!< The distance that has already been traveled on the track
+  Vector pos;           //!< The position relative to the offset marked by the distance already covered
+  Rotation rot;         //!< The direction the object is heading (relative to track direction)
 } Location;
 
-typedef struct Placement // place of a thing in the rendered coordinate system
+//! Absolute coordinates
+/**
+  This is used to store the position of a object in the rendered coordinate system
+*/
+typedef struct Placement
 {
-  Vector r;              // x/y/z coordinated
-  Rotation w;            // orientation
+  Vector r;              //!< Absolute x/y/z coordinates
+  Rotation w;            //!< Absolute orientation
 } Placement;