Changeset 3820 in orxonox.OLD for orxonox/trunk/src/animation_player.h

Timestamp:

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

Author:

bensch

Message:

orxonox/trunk: more descriptive comments

File:

• orxonox/trunk/src/animation_player.h (modified) (1 diff)

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 {