/*******************************************************************************

 Copyright (c) 2009, Charles McGarvey
 All rights reserved.
 
 Redistribution   and   use  in  source  and  binary  forms,  with  or  without
 modification, are permitted provided that the following conditions are met:
 
   * Redistributions  of  source  code  must retain the above copyright notice,
     this list of conditions and the following disclaimer.
   * Redistributions  in binary form must reproduce the above copyright notice,
     this  list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
 
 THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*******************************************************************************/

#ifndef _ANIMATION_HH_
#define _ANIMATION_HH_

/**
 * @file Animation.hh
 * Motion picture!!
 */

#include <string>

#include <boost/shared_ptr.hpp>

#include <Moof/Math.hh>
#include <Moof/Resource.hh>


class Animation;
typedef boost::shared_ptr<Animation> AnimationP;

/**
 * A class to manage frame-based animation.  Animation sequences can be loaded
 * from file, then named sequences are started.  The animation is updated
 * periodically (each update cycle), and the correct current frame is
 * determined.  This class is generic enough that a frame can mean just about
 * anything to whatever drawing context is used to render the frame.
 */

class Animation : public Mf::Resource
{
	class Impl;
	boost::shared_ptr<Impl> mImpl;

public:

	Animation(const std::string& name);

	static AnimationP alloc(const std::string& name)
	{
		return AnimationP(new Animation(name));
	}


	void startSequence(const std::string& name);

	void update(Mf::Scalar t, Mf::Scalar dt);
	unsigned getFrame() const;

	static std::string getPath(const std::string& name);
};


#endif // _ANIMATION_HH_

/** vim: set ts=4 sw=4 tw=80: *************************************************/