Changeset 4485 in orxonox.OLD for orxonox/trunk/src/util/animation/animation3d.h

Timestamp:

Jun 3, 2005, 12:19:43 AM (20 years ago)

Author:

bensch

Message:

orxonox/trunk: more documentation in util

File:

• orxonox/trunk/src/util/animation/animation3d.h (modified) (2 diffs)

orxonox/trunk/src/util/animation/animation3d.h

@@ -16 +16 @@
 */
 typedef struct KeyFrame3D {
-  float duration;                   //!< The duration of this KeyFrame
-  Vector position;                  //!< The position of this KeyFrame
-  Vector lastPosition;
-  Quaternion direction;             //!< The direction of this KeyFrame
-  ANIM_FUNCTION animFuncMov;        //!< with whitch function to iterate movement to the next KeyFrame3D
-  ANIM_FUNCTION animFuncRot;        //!< with whitch function to iterate rotation to the next KeyFrame3D
+  float             duration;              //!< The duration of this KeyFrame
+  Vector            position;              //!< The position of this KeyFrame
+  Vector            lastPosition;          //!< The last known position
+  Quaternion        direction;             //!< The direction of this KeyFrame
+  ANIM_FUNCTION     animFuncMov;           //!< with whitch function to iterate movement to the next KeyFrame3D
+  ANIM_FUNCTION     animFuncRot;           //!< with whitch function to iterate rotation to the next KeyFrame3D
 };
 
-//! Animation Struct
+//! Animation Class for 3D-transformations (movement and rotation)
 /**
    This represents an animation for a object
@@ -65 +65 @@
   void (Animation3D::*animFuncRot)(float) const;      //!< A Function for the AnimationType
 
-  KeyFrame3D* currentKeyFrame;                     //!< The current KeyFrame
-  KeyFrame3D* nextKeyFrame;                        //!< The KeyFrame we iterate to
-  tList<KeyFrame3D>* keyFrameList;                 //!< The KeyFrameList
+
+ private:
+  KeyFrame3D*          currentKeyFrame;               //!< The current KeyFrame
+  KeyFrame3D*          nextKeyFrame;                  //!< The KeyFrame we iterate to
+  tList<KeyFrame3D>*   keyFrameList;                  //!< The KeyFrameList
+
 
   // more class-local description
-  PNode* object;                                   //!< The Object from which to Animate something
-  Vector lastPosition;   //!< ??
-  Vector tmpVect;        //!< what for??
-  float deltaT;          //!< ??
-  float expFactorMov;
-  float expFactorRot;
+  PNode*               object;                        //!< The Object from which to Animate something
+  Vector               lastPosition;                  //!< last Object
+  Vector               tmpVect;                       //!< temporary vector
+  float                deltaT;                        //!< time passed since last
+  float                expFactorMov;                  //!< exponential Factor for movement
+  float                expFactorRot;                  //!< exponential Factor for rotation
 };