tileanim.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/>.
 *
 */

#ifndef ULTIMA4_MAP_TILEANIM_H
#define ULTIMA4_MAP_TILEANIM_H

#include "ultima/ultima4/map/direction.h"

namespace Ultima {
namespace Ultima4 {

class ConfigElement;
class Image;
class Tile;
struct RGBA;

class TileAnimTransform {
public:
    static TileAnimTransform *create(const ConfigElement &config);

    static RGBA *loadColorFromConf(const ConfigElement &conf);

    virtual void draw(Image *dest, Tile *tile, MapTile &mapTile) = 0;
    virtual ~TileAnimTransform() {}
    virtual bool drawsTile() const = 0;

    // Properties
    int _random;
};

class TileAnimInvertTransform : public TileAnimTransform {
public:
    TileAnimInvertTransform(int xp, int yp, int width, int height);
    void draw(Image *dest, Tile *tile, MapTile &mapTile) override;
    bool drawsTile() const override;

private:
    int x, y, w, h;
};

class TileAnimPixelTransform : public TileAnimTransform {
public:
    TileAnimPixelTransform(int xp, int yp);
    void draw(Image *dest, Tile *tile, MapTile &mapTile) override;
    bool drawsTile() const override;

    int x, y;
    Common::Array<RGBA *> _colors;
};

class TileAnimScrollTransform : public TileAnimTransform {
public:
    TileAnimScrollTransform(int increment);
    void draw(Image *dest, Tile *tile, MapTile &mapTile) override;
    bool drawsTile() const override;
private:
    int _increment, _current, _lastOffset;
};

class TileAnimFrameTransform : public TileAnimTransform {
public:
    TileAnimFrameTransform() : _currentFrame(0) {
    }
    void draw(Image *dest, Tile *tile, MapTile &mapTile) override;

    bool drawsTile() const override;
protected:
    int _currentFrame;
};

class TileAnimPixelColorTransform : public TileAnimTransform {
public:
    TileAnimPixelColorTransform(int xp, int yp, int width, int height);
    ~TileAnimPixelColorTransform() override;

    void draw(Image *dest, Tile *tile, MapTile &mapTile) override;
    bool drawsTile() const override;

    int x, y, w, h;
    RGBA *_start, *_end;
};

class TileAnimContext {
public:
    typedef Common::Array<TileAnimTransform *> TileAnimTransformList;
    typedef enum {
        FRAME,
        DIR
    } Type;

    static TileAnimContext *create(const ConfigElement &config);

    void add(TileAnimTransform *);
    virtual bool isInContext(Tile *t, MapTile &mapTile, Direction d) = 0;
    TileAnimTransformList &getTransforms() {
        return _animTransforms;   
    }
    virtual ~TileAnimContext() {}
private:

    TileAnimTransformList _animTransforms;
};

class TileAnimFrameContext : public TileAnimContext {
public:
    TileAnimFrameContext(int frame);
    bool isInContext(Tile *t, MapTile &mapTile, Direction d) override;

private:
    int _frame;
};

class TileAnimPlayerDirContext : public TileAnimContext {
public:
    TileAnimPlayerDirContext(Direction dir);
    bool isInContext(Tile *t, MapTile &mapTile, Direction d) override;

private:
    Direction _dir;
};

class TileAnim {
public:
    TileAnim(const ConfigElement &conf);
    ~TileAnim();

    Common::String _name;
    Common::Array<TileAnimTransform *> _transforms;
    Common::Array<TileAnimContext *> _contexts;

    /* returns the frame to set the mapTile to (only relevant if persistent) */
    void draw(Image *dest, Tile *tile, MapTile &mapTile, Direction dir);

    int _random;   /* true if the tile animation occurs randomely */
};

class TileAnimSet {
    typedef Common::HashMap<Common::String, TileAnim *> TileAnimMap;

public:
    TileAnimSet(const ConfigElement &conf);
    ~TileAnimSet();

    TileAnim *getByName(const Common::String &name);

    Common::String _name;
    TileAnimMap _tileAnims;
};

} // End of namespace Ultima4
} // End of namespace Ultima

#endif