/* * The ManaPlus Client * Copyright (C) 2004-2009 The Mana World Development Team * Copyright (C) 2009-2010 The Mana Developers * Copyright (C) 2011-2013 The ManaPlus Developers * * This file is part of The ManaPlus Client. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * any later version. * * This program 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ #ifndef RESOURCES_ANIMATION_H #define RESOURCES_ANIMATION_H #include <vector> #include <string> #include "localconsts.h" class Image; /** * A single frame in an animation, with a delay and an offset. */ struct Frame final { enum FrameType { ANIMATION = 0, JUMP, GOTO, LABEL, PAUSE }; Image *image; int delay; int offsetX; int offsetY; int rand; FrameType type; std::string nextAction; }; /** * An animation consists of several frames, each with their own delay and * offset. */ class Animation final { friend class AnimatedSprite; friend class ParticleEmitter; friend class SimpleAnimation; public: Animation(); /** * Appends a new animation at the end of the sequence. */ void addFrame(Image *const image, const int delay, const int offsetX, const int offsetY, const int rand); /** * Appends an animation terminator that states that the animation * should not loop. */ void addTerminator(const int rand); /** * Returns the length of this animation in frames. */ size_t getLength() const A_WARN_UNUSED { return mFrames.size(); } void addJump(const std::string &name, const int rand); void addLabel(const std::string &name); void addGoto(const std::string &name, const int rand); void addPause(const int delay, const int rand); void setLastFrameDelay(const int delay); typedef std::vector<Frame> Frames; typedef Frames::iterator FramesIter; typedef Frames::reverse_iterator FramesRevIter; #ifdef UNITTESTS Frames &getFrames() { return mFrames; } #endif /** * Determines whether the given animation frame is a terminator. */ static bool isTerminator(const Frame &phase) A_WARN_UNUSED; protected: Frames mFrames; int mDuration; }; #endif // RESOURCES_ANIMATION_H