simpleanimation.h

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/>.
 */
 
#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;
 
class SimpleAnimation final
{
    public:
        explicit SimpleAnimation(Animation *const animation);
 
        SimpleAnimation(XmlNodeConstPtr 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);
 
        void reset();
 
        Image *getCurrentImage() const A_WARN_UNUSED;
 
    private:
        void initializeAnimation(XmlNodeConstPtr animationNode,
                                 const std::string &dyePalettes);
 
        Animation *mAnimation;
 
        int mAnimationTime;
 
        int mAnimationPhase;
 
        const Frame *mCurrentFrame;
 
        bool mInitialized;
 
        ImageSet *mImageSet;
};
 
#endif  // RESOURCES_ANIMATION_SIMPLEANIMATION_H