animation.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 Broken Sword 2.5 engine
 *
 * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
 *
 * Licensed under GNU GPL v2
 *
 */

#ifndef SWORD25_ANIMATION_H
#define SWORD25_ANIMATION_H

// Includes
#include "sword25/kernel/common.h"
#include "sword25/gfx/timedrenderobject.h"

namespace Sword25 {

// Forward declarations
class Kernel;
class AnimationResource;
class AnimationTemplate;
class AnimationDescription;
class InputPersistenceBlock;

class Animation : public TimedRenderObject {
    friend class RenderObject;

private:
    Animation(RenderObjectPtr<RenderObject> parentPtr, const Common::String &fileName);
    Animation(RenderObjectPtr<RenderObject> parentPtr, const AnimationTemplate &template_);
    Animation(InputPersistenceBlock &reader, RenderObjectPtr<RenderObject> parentPtr, uint handle);

public:
    enum ANIMATION_TYPES {
        AT_ONESHOT,
        AT_LOOP,
        AT_JOJO
    };

    ~Animation() override;

    void play();
    void pause();
    void stop();
    void setFrame(uint nr);

    void setPos(int x, int y) override;
    void setX(int x) override;
    void setY(int y) override;

    int getX() const override;
    int getY() const override;
    int getAbsoluteX() const override;
    int getAbsoluteY() const override;

    void setAlpha(int alpha);

    void setModulationColor(uint modulationColor);

    void setScaleFactor(float scaleFactor);

    void setScaleFactorX(float scaleFactorX);

    void setScaleFactorY(float scaleFactorY);

    float getScaleFactorX() const {
        return _scaleFactorX;
    }

    float getScaleFactorY() const {
        return _scaleFactorY;
    }

    bool persist(OutputPersistenceBlock &writer) override;
    bool unpersist(InputPersistenceBlock &reader) override;

    void frameNotification(int timeElapsed) override;

    ANIMATION_TYPES     getAnimationType() const;
    int                 getFPS() const;
    int                 getFrameCount() const;
    bool                isScalingAllowed() const;
    bool                isAlphaAllowed() const;
    bool                isColorModulationAllowed() const;
    uint getCurrentFrame() const {
        return _currentFrame;
    }
    const Common::String   &getCurrentAction() const;
    bool isRunning() const {
        return _running;
    }

    typedef bool (*ANIMATION_CALLBACK)(uint);

    void setCallbacks();

protected:
    bool doRender(RectangleList *updateRects) override;

private:
    enum Direction {
        FORWARD,
        BACKWARD
    };

    int32 _relX;
    int32 _relY;
    float _scaleFactorX;
    float _scaleFactorY;
    uint32 _modulationColor;
    uint32 _currentFrame;
    int32  _currentFrameTime;
    bool _running;
    bool _finished;
    Direction _direction;
    AnimationResource *_animationResourcePtr;
    uint32 _animationTemplateHandle;
    bool _framesLocked;

    ANIMATION_CALLBACK _loopPointCallback;
    ANIMATION_CALLBACK _actionCallback;
    ANIMATION_CALLBACK _deleteCallback;

    bool lockAllFrames();

    bool unlockAllFrames();

    void computeCurrentCharacteristics();

    int computeXModifier() const;

    int computeYModifier() const;

    void initMembers();
    AnimationDescription *getAnimationDescription() const;

    void initializeAnimationResource(const Common::String &fileName);
};

} // End of namespace Sword25

#endif