Changeset 4479 in orxonox.OLD

Timestamp:

Jun 2, 2005, 5:04:57 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: QuickAnimation - doxy

Location:

orxonox/trunk/src/lib/particles

Files:

• quick_animation.cc (modified) (1 diff)
• quick_animation.h (modified) (2 diffs)

orxonox/trunk/src/lib/particles/quick_animation.cc

@@ -169 +169 @@
 }
 
-
+/**
+   \brief outputs some nice information about this class
+*/
 void QuickAnimation::debug(void)
 {

orxonox/trunk/src/lib/particles/quick_animation.h

@@ -25 +25 @@
 
  public:
+
   //! a simple struct that stores keyframes for the QuickAnimation-Class.
   struct QuickKeyFrame
   {
-    float value;       //!< The starting value of this KeyFrame
-    float position;    //!< The end position of thies KeyFrame
+    float            value;             //!< The starting value of this KeyFrame
+    float            position;          //!< The end position of thies KeyFrame
 
-    QuickKeyFrame* next;    //!< The next Animation
+    QuickKeyFrame*   next;              //!< The next Animation
   };
 
@@ -44 +45 @@
       bool moveEntry(float position);
   */
+
   float getValue(float position);
 
   void debug(void);
+
  private:
-  QuickKeyFrame* first;
-  QuickKeyFrame* current;
+  QuickKeyFrame*       first;          //!< The first KeyFrame in a Sequence of Keyframes
+  QuickKeyFrame*       current;        //!< The currently selected KeyFrame
 };