Animator.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_ANIMATOR_HPP
#define THOR_ANIMATOR_HPP

#include <Thor/Config.hpp>
#include <Thor/Animations/AnimationMap.hpp>
#include <Thor/Animations/Playback.hpp>

#include <Aurora/Tools/Optional.hpp>
#include <Aurora/Tools/Algorithms.hpp>

#include <SFML/System/Time.hpp>

#include <queue>
#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:
        explicit                    Animator(const AnimationMap<Animated, Id>& animations);

        AURORA_IMPL_DEF(detail::PlayingQueue<Id>)   play();

        AURORA_IMPL_DEF(detail::PlayingQueue<Id>)   queue();

        void                        stop();

        void                        update(sf::Time dt);

        void                        animate(Animated& animated) const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private types
    private:
        typedef detail::TimedAnimation<Animated>    TimedAnimation;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        const AnimationMap<Animated, Id>*       mAnimations;
        std::queue<detail::PlaybackScheme<Id>>  mQueuedIds;
        std::vector<const TimedAnimation*>      mPlayingAnimations;
        sf::Time                                mProgressedTime;
};


} // namespace thor

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