simpleanimation.cpp

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  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/animation/animation.h"
 
#include "resources/dye/dye.h"
 
#include "resources/loaders/imagesetloader.h"
 
#include "utils/checkutils.h"
#include "utils/delete2.h"
 
#include "debug.h"
 
SimpleAnimation::SimpleAnimation(Animation *const animation) :
    mAnimation(animation),
    mAnimationTime(0),
    mAnimationPhase(0),
    mCurrentFrame(mAnimation != nullptr ? &mAnimation->mFrames[0] : nullptr),
    mInitialized(true),
    mImageSet(nullptr)
{
}
 
SimpleAnimation::SimpleAnimation(XmlNodeConstPtr animationNode,
                                 const std::string& dyePalettes) :
    mAnimation(new Animation("simple animation")),
    mAnimationTime(0),
    mAnimationPhase(0),
    mCurrentFrame(nullptr),
    mInitialized(false),
    mImageSet(nullptr)
{
    initializeAnimation(animationNode, dyePalettes);
    if (mAnimation != nullptr)
        mCurrentFrame = &mAnimation->mFrames[0];
    else
        mCurrentFrame = nullptr;
}
 
SimpleAnimation::~SimpleAnimation()
{
    delete2(mAnimation)
    if (mImageSet != nullptr)
    {
        mImageSet->decRef();
        mImageSet = nullptr;
    }
}
 
void SimpleAnimation::draw(Graphics *const graphics,
                           const int posX, const int posY) const
{
    FUNC_BLOCK("SimpleAnimation::draw", 1)
    if ((mCurrentFrame == nullptr) || (mCurrentFrame->image == nullptr))
        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 == nullptr)
        return;
 
    if (frame < 0)
        frame = 0;
    const unsigned int len = CAST_U32(mAnimation->getLength());
    if (CAST_U32(frame) >= len)
        frame = len - 1;
    mAnimationPhase = frame;
    mCurrentFrame = &mAnimation->mFrames[frame];
}
 
bool SimpleAnimation::update(const int timePassed)
{
    if ((mCurrentFrame == nullptr) || (mAnimation == nullptr) || !mInitialized)
        return false;
 
    bool updated(false);
    mAnimationTime += timePassed;
 
    while (mAnimationTime > mCurrentFrame->delay && mCurrentFrame->delay > 0)
    {
        updated = true;
        mAnimationTime -= mCurrentFrame->delay;
        mAnimationPhase++;
 
        if (CAST_SIZE(mAnimationPhase) >= mAnimation->getLength())
            mAnimationPhase = 0;
 
        mCurrentFrame = &mAnimation->mFrames[mAnimationPhase];
    }
    return updated;
}
 
int SimpleAnimation::getLength() const
{
    if (mAnimation == nullptr)
        return 0;
 
    return CAST_S32(mAnimation->getLength());
}
 
Image *SimpleAnimation::getCurrentImage() const
{
    if (mCurrentFrame != nullptr)
        return mCurrentFrame->image;
    return nullptr;
}
 
void SimpleAnimation::initializeAnimation(XmlNodeConstPtr animationNode,
                                          const std::string &dyePalettes)
{
    mInitialized = false;
 
    if (animationNode == nullptr)
        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 = Loader::getImageSet(
        XML::getProperty(animationNode, "imageset", ""),
        XML::getProperty(animationNode, "width", 0),
        XML::getProperty(animationNode, "height", 0));
 
    if (imageset == nullptr)
        return;
 
    const int x1 = imageset->getWidth() / 2 - mapTileSize / 2;
    const int y1 = imageset->getHeight() - mapTileSize;
 
    // Get animation frames
    for_each_xml_child_node (frameNode, animationNode)
    {
        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)
            {
                reportAlways("No valid value for 'index'")
                continue;
            }
 
            Image *const img = imageset->get(index);
 
            if (img == nullptr)
            {
                reportAlways("No image at index %d", index)
                continue;
            }
 
            if (mAnimation != nullptr)
                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)
            {
                reportAlways("No valid value for 'start' or 'end'")
                continue;
            }
 
            while (end >= start)
            {
                Image *const img = imageset->get(start);
 
                if (img == nullptr)
                {
                    reportAlways("No image at index %d", start)
                    continue;
                }
 
                if (mAnimation != nullptr)
                    mAnimation->addFrame(img, delay, offsetX, offsetY, rand);
                start++;
            }
        }
        else if (xmlNameEqual(frameNode, "end"))
        {
            if (mAnimation != nullptr)
                mAnimation->addTerminator(rand);
        }
    }
 
    mInitialized = true;
}