/*
 *	An Animation Implementation
 *	Copyright(C) 2003-2013 Jinhao(cnjinhao@hotmail.com)
 *
 *	Distributed under the Boost Software License, Version 1.0.
 *	(See accompanying file LICENSE_1_0.txt or copy at
 *	http://www.boost.org/LICENSE_1_0.txt)
 *
 *	@file: nana/gui/animation.hpp
 */

#ifndef NANA_GUI_ANIMATION_HPP
#define NANA_GUI_ANIMATION_HPP

#include <nana/paint/image.hpp>

#include <functional>
#include <memory>


namespace nana
{
	class animation;
        /// Holds the frames and frame builders. Have reference semantics for efficiency.
	class frameset
	{
		friend class animation;
	public:
        /// function which builds frames.
		typedef std::function<bool(std::size_t pos, paint::graphics&, nana::size&)> framebuilder;

		struct impl;
	public:
		frameset();
		void push_back(const paint::image&);        ///< Inserts frames at the end.
		void push_back(paint::image&&);
		void push_back(framebuilder& fb, std::size_t length);  ///< Insters a framebuilder and the number of frames that it generates.
		void push_back(framebuilder&& fb, std::size_t length); ///< Insters a framebuilder and the number of frames that it generates.
	private:
		std::shared_ptr<impl> impl_;
	};
            /// Easy way to display an animation or create an animated GUI 
	class animation
	{
		struct branch_t
		{
			frameset frames;
			std::function<std::size_t(const std::string&, std::size_t, std::size_t&)> condition;
		};
		
		struct impl;
		class performance_manager;
	public:
		animation();

		void push_back(const frameset& frms);
		/*
		void branch(const std::string& name, const frameset& frms)
		{
			impl_->branches[name].frames = frms;
		}

		void branch(const std::string& name, const frameset& frms, std::function<std::size_t(const std::string&, std::size_t, std::size_t&)> condition)
		{
			auto & br = impl_->branches[name];
			br.frames = frms;
			br.condition = condition;
		}
		*/

		void looped(bool enable);       ///< Enables or disables the animation repeating playback.

		void play();

		void pause();

		void output(window wd, const nana::point& pos);
	private:
		impl * impl_;
	};
}	//end namespace nana
#endif	//NANA_GUI_ANIMATION_HPP