Animator.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2015 Jan Haller
// 
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
// 
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
// 
// 1. The origin of this software must not be misrepresented; you must not
//    claim that you wrote the original software. If you use this software
//    in a product, an acknowledgment in the product documentation would be
//    appreciated but is not required.
// 
// 2. Altered source versions must be plainly marked as such, and must not be
//    misrepresented as being the original software.
// 
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef THOR_ANIMATOR_HPP
#define THOR_ANIMATOR_HPP

#include <Thor/Config.hpp>

#include <SFML/System/Time.hpp>

#include <map>
#include <functional>
#include <cassert>
#include <cmath>


namespace thor
{


template <class Animated, typename Id>
class Animator
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public types
    public:
        typedef std::function<void(Animated&, float)>   AnimationFunction;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    Animator();

                                    Animator(const Animator& origin);

        Animator&                   operator= (const Animator& origin);

                                    Animator(Animator&& source);

        Animator&                   operator= (Animator&& source);

                                    ~Animator();

        void                        addAnimation(const Id& id, const AnimationFunction& animation, sf::Time duration);

        void                        playAnimation(const Id& id, bool loop = false);

        void                        stopAnimation();

        bool                        isPlayingAnimation() const;

        Id                          getPlayingAnimation() const;

        void                        update(sf::Time dt);

        void                        animate(Animated& animated) const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private types
    private:
        typedef std::pair<AnimationFunction, sf::Time>      ScaledAnimation;
        typedef std::map<Id, ScaledAnimation>               AnimationMap;
        typedef typename AnimationMap::iterator             AnimationMapIterator;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private member functions
    private:
        void                        playAnimation(AnimationMapIterator animation, bool loop);

        template <typename T>
        void                        adopt(T& source);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        AnimationMap                mAnimationMap;
        AnimationMapIterator        mPlayingAnimation;
        float                       mProgress;
        bool                        mLoop;
};


} // namespace thor

#include <Thor/Animations/Detail/Animator.inl>
#endif // THOR_ANIMATOR_HPP