Changeset 4485 in orxonox.OLD for orxonox/trunk/src/util/animation/animation_player.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/animation_player.h (modified) (3 diffs)

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

@@ -29 +29 @@
 
  public:
-  static AnimationPlayer* getInstance(void);
+  /** \returns a Pointer to the only object of this Class */
+  inline static AnimationPlayer* getInstance(void) { if (!singletonRef) singletonRef = new AnimationPlayer();  return singletonRef; };
+
   virtual ~AnimationPlayer(void);
 
@@ -42 +44 @@
   void pause(void);
 
-  Animation* getObjectFromBaseObject(const BaseObject* baseObject) const;
+  Animation* getAnimationFromBaseObject(const BaseObject* baseObject) const;
 
   void debug(void);
@@ -49 +51 @@
   /* singleton */
   AnimationPlayer(void);
-  static AnimationPlayer* singletonRef;
+  static AnimationPlayer*      singletonRef;          //!< SingletonReference to this class.
 
   /* class specific */
-  tList<Animation>* animationList;         //!< A List of Animations to be handled.
-  bool bRunning;                           //!< If the AnimationPlayer is running.
+  tList<Animation>*            animationList;         //!< A List of Animations to be handled.
+  bool                         bRunning;              //!< If the AnimationPlayer is running.
 };