Dogcows Code - chaz/yoink/blob - src/Animation.hh

   1
   2 /*]  Copyright (c) 2009-2010, Charles McGarvey  [**************************
   3 **]  All rights reserved.
   4 *
   5 * vi:ts=4 sw=4 tw=75
   6 *
   7 * Distributable under the terms and conditions of the 2-clause BSD license;
   8 * see the file COPYING for a complete text of the license.
   9 *
  10 **************************************************************************/
  11
  12 #ifndef _ANIMATION_HH_
  13 #define _ANIMATION_HH_
  14
  15 /**
  16  * @file Animation.hh
  17  * Motion picture!!
  18  */
  19
  20 #include <string>
  21
  22 #include <boost/shared_ptr.hpp>
  23
  24 #include <moof/math.hh>
  25
  26
  27 class Animation;
  28 typedef boost::shared_ptr<Animation> AnimationP;
  29
  30 /**
  31  * A class to manage frame-based animation.  Animation sequences can be
  32  * loaded from file, then named sequences are started.  The animation is
  33  * updated periodically (each update cycle), and the correct current frame
  34  * is determined.  This class is generic enough that a frame can mean just
  35  * about anything to whatever drawing context is used to render the frame.
  36  */
  37
  38 class Animation
  39 {
  40 public:
  41
  42         Animation(const std::string& name);
  43
  44         static AnimationP alloc(const std::string& name)
  45         {
  46                 return AnimationP(new Animation(name));
  47         }
  48
  49
  50         void startSequence(const std::string& name);
  51
  52         void update(moof::scalar t, moof::scalar dt);
  53         unsigned getFrame() const;
  54
  55
  56 private:
  57
  58         class impl;
  59         boost::shared_ptr<impl> impl_;
  60 };
  61
  62
  63 #endif // _ANIMATION_HH_
  64