animation.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana 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/>.
 */
 
#pragma once
 
#include "resources/imageset.h"
#include "utils/xml.h"
 
#include <vector>
 
class Image;
 
struct Frame
{
    Image *image;
    int delay;
    int offsetX;
    int offsetY;
};
 
class Animation final
{
    public:
        Animation() = default;
 
        void addFrame(Image *image, int delay, int offsetX, int offsetY);
 
        void addTerminator();
 
        Frame *getFrame(int index) { return &(mFrames[index]); }
 
        int getLength() const { return mFrames.size(); }
 
        int getDuration() const { return mDuration; }
 
        static bool isTerminator(const Frame &phase);
 
        static Animation fromXML(XML::Node node,
                                 const std::string &dyePalettes = {});
 
    protected:
        ResourceRef<ImageSet> mImageSet;
        std::vector<Frame> mFrames;
        int mDuration = 0;
};