diff options
Diffstat (limited to 'src/resources/animation/animation.h')
-rw-r--r-- | src/resources/animation/animation.h | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/src/resources/animation/animation.h b/src/resources/animation/animation.h new file mode 100644 index 000000000..cb0c3afb6 --- /dev/null +++ b/src/resources/animation/animation.h @@ -0,0 +1,95 @@ +/* + * The ManaPlus Client + * Copyright (C) 2004-2009 The Mana World Development Team + * Copyright (C) 2009-2010 The Mana Developers + * Copyright (C) 2011-2015 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_ANIMATION_H +#define RESOURCES_ANIMATION_ANIMATION_H + +#include "resources/frame.h" + +#include <vector> + +#include "localconsts.h" + +class Image; + +/** + * 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() noexcept; + + /** + * 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) noexcept; + + /** + * Appends an animation terminator that states that the animation + * should not loop. + */ + void addTerminator(const int rand) noexcept; + + /** + * Returns the length of this animation in frames. + */ + size_t getLength() const noexcept A_WARN_UNUSED + { return mFrames.size(); } + + void addJump(const std::string &name, const int rand) noexcept; + + void addLabel(const std::string &name) noexcept; + + void addGoto(const std::string &name, const int rand) noexcept; + + void addPause(const int delay, const int rand) noexcept; + + void setLastFrameDelay(const int delay) noexcept; + + typedef std::vector<Frame> Frames; + typedef Frames::iterator FramesIter; + typedef Frames::reverse_iterator FramesRevIter; + +#ifdef UNITTESTS + Frames &getFrames() noexcept + { return mFrames; } +#endif + + /** + * Determines whether the given animation frame is a terminator. + */ + static bool isTerminator(const Frame &phase) noexcept A_WARN_UNUSED; + + protected: + Frames mFrames; + int mDuration; +}; + +#endif // RESOURCES_ANIMATION_ANIMATION_H |