AnimationFrame.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 of the License, or
 * (at your option) 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/>.
 *
 */

/*
 * This code is based on the CRAB engine
 *
 * Copyright (c) Arvind Raja Yadav
 *
 * Licensed under MIT
 *
 */

#ifndef CRAB_ANIMATIONFRAME_H
#define CRAB_ANIMATIONFRAME_H

#include "crab/animation/AnimationEffect.h"
#include "crab/image/ImageManager.h"
#include "crab/text/TextManager.h"
#include "crab/ui/HoverInfo.h"

namespace Crab {

namespace pyrodactyl {
namespace anim {

struct AnimationFrame : public Vector2i {
    // The image drawn in this frame
    ImageKey _img;

    // This is the time in we draw the frame milliseconds relative to the start of the entire animation
    uint32 _start, _finish;

    // The effect applied to the image
    AnimationEffect _eff;

    // In case we want to display any words during the animation
    pyrodactyl::ui::HoverInfo _text;

    // The color drawn on the screen
    Color _col;

    AnimationFrame() {
        _img = 0;
        _start = 0;
        _finish = 0;
        _col.r = 0;
        _col.g = 0;
        _col.b = 0;
        _col.a = 255;
    }

    AnimationFrame(rapidxml::xml_node<char> *node);

    void reset();
    void draw(const uint32 &timestamp);
    DrawType internalEvents(const uint32 &timestamp);
};
} // End of namespace anim
} // End of namespace pyrodactyl

} // End of namespace Crab

#endif // CRAB_ANIMATIONFRAME_H