AnimationMap.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2016 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_ANIMATIONMAP_HPP
#define THOR_ANIMATIONMAP_HPP

#include <Thor/Config.hpp>

#include <SFML/System/Time.hpp>

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


namespace thor
{
namespace detail
{

    template <class Animated>
    struct TimedAnimation
    {
        // @brief Functor to animate the objects.
        // @details Signature: <b>void (Animated& animated, float progress)</b>
        //  @arg @a animated is the object being animated.
        //  @arg @a progress is a number in [0,1] determining the animation state.
        typedef std::function<void(Animated&, float)>   AnimationFunction;

        TimedAnimation(AnimationFunction animation, sf::Time duration)
        : function(std::move(animation))
        , duration(duration)
        {
        }

        AnimationFunction           function;
        sf::Time                    duration;
    };

} // namespace detail



template <class Animated, typename Id>
class Animator;

template <class Animated, typename Id>
class AnimationMap
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private types
    private:
        typedef detail::TimedAnimation<Animated>                            TimedAnimation;


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

        void                        addAnimation(Id id, std::function<void(Animated&, float)> animation, sf::Time duration);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private member functions (accessible through friend)
    private:
        const TimedAnimation&       getAnimation(const Id& id) const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        std::map<Id, TimedAnimation>    mAnimationMap;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Friends
    friend class Animator<Animated, Id>;
};


} // namespace thor

#include <Thor/Animations/Detail/AnimationMap.inl>
#endif // THOR_ANIMATIONMAP_HPP