Changeset 3820 in orxonox.OLD for orxonox

Timestamp:

Apr 14, 2005, 12:31:09 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: more descriptive comments

Location:

orxonox/trunk/src

Files:

• animation.cc (modified) (2 diffs)
• animation.h (modified) (2 diffs)
• animation_player.h (modified) (1 diff)

orxonox/trunk/src/animation.cc

@@ -24 +24 @@
   // initialize a beginning KeyFrame, that will be deleted afterwards
   this->bHasKeys = false;
+  this->bHandled = true;
 
   // setting default values
@@ -32 +33 @@
 }
 
-
 Anim::~Anim(void)
 {
-  AnimationPlayer::getInstance()->removeAnimation(this);
+  this->doNotHandle();
 }
+
+void Anim::doNotHandle(void)
+{
+  if (this->bHandled)
+    AnimationPlayer::getInstance()->removeAnimation(this);
+}
+
 
 void Anim::setInfinity(ANIM_INFINITY postInfinity)

orxonox/trunk/src/animation.h

@@ -51 +51 @@
  public:
   virtual ~Anim(void);
+  void doNotHandle(void);
 
   void setInfinity(ANIM_INFINITY postInfinity = ANIM_INF_CONSTANT);
@@ -80 +81 @@
 
   bool bHasKeys;
+  bool bHandled;                  //!< If this Animation is handled by the AnimationPlayer.
   bool bRunning;
 };

orxonox/trunk/src/animation_player.h

@@ -12 +12 @@
 
 //! A AnimationPlayer, that handles the animation of all the Animations in the scene.
+/**
+   <b>AnimationPlayer usage:</b> \n
+
+   <b>Initialisation</b>: AnimationPlayer::getInstance() does the trick this is 
+   usually done when initializing a world \n
+   <b>Adding Animations</b>: create an Animation the following Way:
+   \li Anim* animation = new Anim(); // also use any other Subclass of Animation to initialize this
+   \li set some parameters: also see the specific classes for more info
+   \n
+   if you do not want a specific Animation to be handled by the AnimationPlayer, you have to 
+   unload it explicitely with animation->doNotHandle();
+   \n
+   eveything else will be done by the AnimationPlayer itself.\n
+*/
 class AnimationPlayer : public BaseObject {