Animation/Animator.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2012 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/Animation/Animation.hpp>
#include <Thor/Config.hpp>

#include <SFML/System/Time.hpp>
#include <SFML/Graphics/Sprite.hpp>

#include <map>
#include <string>


namespace thor
{


class THOR_API Animator
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
                                    Animator();

        void                        AddAnimation(const std::string& name, Animation::Ptr animation, sf::Time duration);

        void                        PlayAnimation(const std::string& name, bool loop = false);

        void                        StopAnimation();

        void                        Update(sf::Time dt);

        void                        Animate(sf::Sprite& target) const;

        void                        SetDefaultAnimation(Animation::Ptr animation, sf::Time duration);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private types
    private:
        typedef std::pair<Animation::Ptr, sf::Time>     ScaledAnimation;
        typedef std::map<std::string, ScaledAnimation>  AnimationMap;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private member functions
    private:
        void                        PlayAnimation(ScaledAnimation& animation, bool loop);

            
    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        AnimationMap                mAnimationMap;
        const ScaledAnimation*      mPlayingAnimation;
        ScaledAnimation             mDefaultAnimation;
        float                       mProgress;
        bool                        mLoop;
};


} // namespace thor

#endif // THOR_ANIMATOR_HPP