Changeset 3517 in orxonox.OLD for orxonox/branches/trackManager/src/lib/math/curve.h

Timestamp:

Mar 12, 2005, 12:34:15 PM (19 years ago)

Author:

bensch

Message:

orxonox/branches/trackManager: some doxygen-tags.

File:

• orxonox/branches/trackManager/src/lib/math/curve.h (modified) (3 diffs)

orxonox/branches/trackManager/src/lib/math/curve.h

@@ -17 +17 @@
 
 //! An abstract class to handle curves. Needed for the Tracking system in orxonox.
+/**
+   A Curve is a smooth line which tries to approximate a path through the nodes given to it.
+   <br>
+
+   <b>Usage of Curves:</b><br>
+   \li Creation: Curve* newCurve = new BezierCurve();
+   \li Adding some Points: newCurve->addNode([Vector to the point to add]);
+   \li Get Point on Curve: newCurve->calcPos(timeIndex);    // where timeindex is in the interval [0,1]
+   <br>
+   More Fuctionality is:
+   \li debug():  outputs some info about this curve.
+   \li getNode(i): returns a Vector to the n'th node of the Curve.
+   \li getNodeCount(): returns the count of nodes.
+   <br>
+   General Info:
+   \li Curves take rather much power to be created/altered, but are fast calculated at runtime.
+*/
 class Curve
 {
@@ -39 +56 @@
 
  private:
+  //! rebuilds the Curve with the right algorithm
   virtual void rebuild(void) = 0;
  public:
@@ -45 +63 @@
   void addNode(const Vector& newNode, unsigned int insertPosition);
   Vector getNode(unsigned int nodeToFind);
+  /** \returns the Count of nodes of this Curve */
   inline int getNodeCount(void) { return this->nodeCount;}
 
-  virtual Vector calcPos(float t) = 0;
+  /**
+     \brief A virtual function to calculate the Position on the Curve
+     \returns positionVector
+     \param t the timeindex on this curve [0,1]f
+  */
+  virtual Vector calcPos(float t) = 0; 
+  /**
+     \brief A virtual function to calculate the Direction of the Curve
+     \returns directionVector
+     \param t the timeindex on this curve [0,1]f
+  */
   virtual Vector calcDir(float t) = 0;
+  /**
+     \brief A virtual function to calculate the acceleration on the Curve
+     \returns accelerationVector
+     \param t the timeindex on this curve [0,1]f
+  */
   virtual Vector calcAcc(float t) = 0;
+  /**
+     \brief A virtual function to calculate the Quaternion on the Curve
+     \returns directional Quaternion
+     \param t the timeindex on this curve [0,1]f
+  */
   virtual Quaternion calcQuat(float t) = 0;