Move simpleanimation into animation directory.

3 files changed, 337 insertions, 1 deletions

diff --git a/src/resources/animation/simpleanimation.cpp b/src/resources/animation/simpleanimation.cpp
new file mode 100644
index 000000000..632bd6c6f
--- /dev/null
+++ b/src/resources/animation/simpleanimation.cpp
@@ -0,0 +1,237 @@
+/*
+ *  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/>.
+ */
+
+#include "resources/animation/simpleanimation.h"
+
+#include "const/resources/map/map.h"
+
+#include "render/graphics.h"
+
+#include "resources/imageset.h"
+#include "resources/resourcemanager.h"
+
+#include "resources/animation/animation.h"
+
+#include "resources/dye/dye.h"
+
+#include "utils/delete2.h"
+
+#include "debug.h"
+
+SimpleAnimation::SimpleAnimation(Animation *const animation) :
+    mAnimation(animation),
+    mAnimationTime(0),
+    mAnimationPhase(0),
+    mCurrentFrame(mAnimation ? &mAnimation->mFrames[0] : nullptr),
+    mInitialized(true),
+    mImageSet(nullptr)
+{
+}
+
+SimpleAnimation::SimpleAnimation(const XmlNodePtr animationNode,
+                                 const std::string& dyePalettes) :
+    mAnimation(new Animation),
+    mAnimationTime(0),
+    mAnimationPhase(0),
+    mCurrentFrame(nullptr),
+    mInitialized(false),
+    mImageSet(nullptr)
+{
+    initializeAnimation(animationNode, dyePalettes);
+    if (mAnimation)
+        mCurrentFrame = &mAnimation->mFrames[0];
+    else
+        mCurrentFrame = nullptr;
+}
+
+SimpleAnimation::~SimpleAnimation()
+{
+    delete2(mAnimation);
+    if (mImageSet)
+    {
+        mImageSet->decRef();
+        mImageSet = nullptr;
+    }
+}
+
+void SimpleAnimation::draw(Graphics *const graphics,
+                           const int posX, const int posY) const
+{
+    FUNC_BLOCK("SimpleAnimation::draw", 1)
+    if (!mCurrentFrame || !mCurrentFrame->image)
+        return;
+
+    graphics->drawImage(mCurrentFrame->image,
+        posX + mCurrentFrame->offsetX,
+        posY + mCurrentFrame->offsetY);
+}
+
+void SimpleAnimation::reset()
+{
+    mAnimationTime = 0;
+    mAnimationPhase = 0;
+}
+
+void SimpleAnimation::setFrame(int frame)
+{
+    if (!mAnimation)
+        return;
+
+    if (frame < 0)
+        frame = 0;
+    const unsigned int len = static_cast<unsigned>(mAnimation->getLength());
+    if (static_cast<unsigned>(frame) >= len)
+        frame = len - 1;
+    mAnimationPhase = frame;
+    mCurrentFrame = &mAnimation->mFrames[frame];
+}
+
+bool SimpleAnimation::update(const int timePassed)
+{
+    if (!mCurrentFrame || !mAnimation || !mInitialized)
+        return false;
+
+    bool updated(false);
+    mAnimationTime += timePassed;
+
+    while (mAnimationTime > mCurrentFrame->delay && mCurrentFrame->delay > 0)
+    {
+        updated = true;
+        mAnimationTime -= mCurrentFrame->delay;
+        mAnimationPhase++;
+
+        if (static_cast<size_t>(mAnimationPhase) >= mAnimation->getLength())
+            mAnimationPhase = 0;
+
+        mCurrentFrame = &mAnimation->mFrames[mAnimationPhase];
+    }
+    return updated;
+}
+
+int SimpleAnimation::getLength() const
+{
+    if (!mAnimation)
+        return 0;
+
+    return static_cast<int>(mAnimation->getLength());
+}
+
+Image *SimpleAnimation::getCurrentImage() const
+{
+    if (mCurrentFrame)
+        return mCurrentFrame->image;
+    else
+        return nullptr;
+}
+
+void SimpleAnimation::initializeAnimation(const XmlNodePtr animationNode,
+                                          const std::string &dyePalettes)
+{
+    mInitialized = false;
+
+    if (!animationNode)
+        return;
+
+    std::string imagePath = XML::getProperty(
+        animationNode, "imageset", "");
+
+    // Instanciate the dye coloration.
+    if (!imagePath.empty() && !dyePalettes.empty())
+        Dye::instantiate(imagePath, dyePalettes);
+
+    const ImageSet *const imageset = resourceManager->getImageSet(
+        XML::getProperty(animationNode, "imageset", ""),
+        XML::getProperty(animationNode, "width", 0),
+        XML::getProperty(animationNode, "height", 0));
+
+    if (!imageset)
+        return;
+
+    const int x1 = imageset->getWidth() / 2 - mapTileSize / 2;
+    const int y1 = imageset->getHeight() - mapTileSize;
+
+    // Get animation frames
+    for (XmlNodePtr frameNode = animationNode->xmlChildrenNode;
+         frameNode; frameNode = frameNode->next)
+    {
+        const int delay = XML::getIntProperty(
+            frameNode, "delay", 0, 0, 100000);
+        const int offsetX = XML::getProperty(frameNode, "offsetX", 0) - x1;
+        const int offsetY = XML::getProperty(frameNode, "offsetY", 0) - y1;
+        const int rand = XML::getIntProperty(frameNode, "rand", 100, 0, 100);
+
+        if (xmlNameEqual(frameNode, "frame"))
+        {
+            const int index = XML::getProperty(frameNode, "index", -1);
+
+            if (index < 0)
+            {
+                logger->log1("No valid value for 'index'");
+                continue;
+            }
+
+            Image *const img = imageset->get(index);
+
+            if (!img)
+            {
+                logger->log("No image at index %d", index);
+                continue;
+            }
+
+            if (mAnimation)
+                mAnimation->addFrame(img, delay, offsetX, offsetY, rand);
+        }
+        else if (xmlNameEqual(frameNode, "sequence"))
+        {
+            int start = XML::getProperty(frameNode, "start", -1);
+            const int end = XML::getProperty(frameNode, "end", -1);
+
+            if (start < 0 || end < 0)
+            {
+                logger->log1("No valid value for 'start' or 'end'");
+                continue;
+            }
+
+            while (end >= start)
+            {
+                Image *const img = imageset->get(start);
+
+                if (!img)
+                {
+                    logger->log("No image at index %d", start);
+                    continue;
+                }
+
+                if (mAnimation)
+                    mAnimation->addFrame(img, delay, offsetX, offsetY, rand);
+                start++;
+            }
+        }
+        else if (xmlNameEqual(frameNode, "end"))
+        {
+            if (mAnimation)
+                mAnimation->addTerminator(rand);
+        }
+    }
+
+    mInitialized = true;
+}
diff --git a/src/resources/animation/simpleanimation.h b/src/resources/animation/simpleanimation.h
new file mode 100644
index 000000000..1f89e82b3
--- /dev/null
+++ b/src/resources/animation/simpleanimation.h
@@ -0,0 +1,99 @@
+/*
+ *  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_SIMPLEANIMATION_H
+#define RESOURCES_ANIMATION_SIMPLEANIMATION_H
+
+#include "utils/xml.h"
+
+#include "localconsts.h"
+
+class Animation;
+class Graphics;
+class Image;
+class ImageSet;
+
+struct Frame;
+
+/**
+ * This class is a leightweight alternative to the AnimatedSprite class.
+ * It hosts a looping animation without actions and directions.
+ */
+class SimpleAnimation final
+{
+    public:
+        /**
+         * Creates a simple animation with an already created \a animation.
+         * Takes ownership over the given animation.
+         */
+        explicit SimpleAnimation(Animation *const animation);
+
+        /**
+         * Creates a simple animation that creates its animation from XML Data.
+         */
+        SimpleAnimation(const XmlNodePtr animationNode,
+                        const std::string& dyePalettes);
+
+        A_DELETE_COPY(SimpleAnimation)
+
+        ~SimpleAnimation();
+
+        void setFrame(int frame);
+
+        int getLength() const A_WARN_UNUSED;
+
+        bool update(const int timePassed);
+
+        void draw(Graphics *const graphics,
+                  const int posX, const int posY) const A_NONNULL(2);
+
+        /**
+         * Resets the animation.
+         */
+        void reset();
+
+        Image *getCurrentImage() const A_WARN_UNUSED;
+
+    private:
+        void initializeAnimation(const XmlNodePtr animationNode,
+                                 const std::string&
+                                 dyePalettes = std::string());
+
+        /** The hosted animation. */
+        Animation *mAnimation;
+
+        /** Time in game ticks the current frame is shown. */
+        int mAnimationTime;
+
+        /** Index of current animation phase. */
+        int mAnimationPhase;
+
+        /** Current animation phase. */
+        const Frame *mCurrentFrame;
+
+        /**  Tell whether the animation is ready */
+        bool mInitialized;
+
+        ImageSet *mImageSet;
+};
+
+#endif  // RESOURCES_ANIMATION_SIMPLEANIMATION_H
diff --git a/src/resources/map/tileanimation.cpp b/src/resources/map/tileanimation.cpp
index 0f0aa9b70..9ea19c611 100644
--- a/src/resources/map/tileanimation.cpp
+++ b/src/resources/map/tileanimation.cpp
@@ -22,7 +22,7 @@
 
 #include "resources/map/tileanimation.h"
 
-#include "simpleanimation.h"
+#include "resources/animation/simpleanimation.h"
 
 #include "resources/map/maplayer.h"