animation.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_VIDEO_ANIMATION_H
#define FIFE_VIDEO_ANIMATION_H

// Standard C++ library includes
#include <cassert>
#include <map>
#include <vector>

// Platform specific includes
#include "util/base/fife_stdint.h"
#include "util/resource/resource.h"

#include "image.h"

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder

namespace FIFE {

    class Animation : public IResource {
    public:
        Animation(IResourceLoader* loader = 0);
        Animation(const std::string& name, IResourceLoader* loader = 0);

        ~Animation();

        virtual size_t getSize();

        virtual void load();
        virtual void free();

        void invalidate();

        void addFrame(ImagePtr image, uint32_t duration);

        int32_t getFrameIndex(uint32_t timestamp);

        ImagePtr getFrame(int32_t index);

        ImagePtr getFrameByTimestamp(uint32_t timestamp);

        std::vector<ImagePtr> getFrames();

        int32_t getFrameDuration(int32_t index) const;

        uint32_t getFrameCount() const;

        void setActionFrame(int32_t num) { m_action_frame = num; }

        int32_t getActionFrame() const { return m_action_frame; }

        void setDirection(uint32_t direction);

        uint32_t getDirection() const { return m_direction; }

        uint32_t getDuration() const { return m_animation_endtime; }

    private:
        struct FrameInfo {
            uint32_t index;
            uint32_t duration;
            ImagePtr image;
        };
        
        std::string createUniqueAnimationName();

        bool isValidIndex(int32_t index) const;

        // Map of timestamp + associated frame
        std::map<uint32_t, FrameInfo> m_framemap;
        // vector of frames for fast indexed access
        std::vector<FrameInfo> m_frames;
        // Action frame of the Animation.
        int32_t m_action_frame;
        // time when animation ends (zero based)
        int32_t m_animation_endtime;
        // Direction for this animation
        uint32_t m_direction;

    };

    typedef SharedPtr<Animation> AnimationPtr;

}

#endif