asurface.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 ACCESS_ASURFACE_H
#define ACCESS_ASURFACE_H

#include "common/scummsys.h"
#include "common/array.h"
#include "common/memstream.h"
#include "common/rect.h"
#include "graphics/screen.h"
#include "access/data.h"

namespace Access {

class SpriteResource;
class SpriteFrame;

class BaseSurface : virtual public Graphics::Screen {
private:
    Graphics::Surface _savedBlock;

    void flipHorizontal(BaseSurface &dest);
protected:
    Common::Rect _savedBounds;
public:
    int _leftSkip, _rightSkip;
    int _topSkip, _bottomSkip;
    int _orgX1, _orgY1;
    int _orgX2, _orgY2;
    int _lColor;

    Common::Point _printOrg;
    Common::Point _printStart;
    int _maxChars;
public:
    // These values need to be shared between the buffers
    static int _lastBoundsX, _lastBoundsY;
    static int _lastBoundsW, _lastBoundsH;
    static int _clipWidth, _clipHeight;
public:
    BaseSurface();

    ~BaseSurface() override;

    void clearBuffer();

    void plotImage(const SpriteResource *sprite, int frameNum, const Common::Point &pt);

    void sPlotF(const SpriteFrame *frame, const Common::Rect &bounds);

    void sPlotB(const SpriteFrame *frame, const Common::Rect &bounds);

    void plotF(const SpriteFrame *frame, const Common::Point &pt);

    void plotB(const SpriteFrame *frame, const Common::Point &pt);

    virtual void copyBlock(const BaseSurface *src, const Common::Rect &bounds);

    virtual void restoreBlock();

    virtual void drawRect();

    virtual void drawLine(int x1, int y1, int x2, int y2, int col);

    virtual void drawLine();

    virtual void drawBox();

    virtual void drawBox(int x1, int y1, int x2, int y2, int color);

    virtual void copyBuffer(Graphics::ManagedSurface *src);

    void copyTo(BaseSurface *dest);

    void saveBlock(const Common::Rect &bounds);

    void moveBufferLeft();

    void moveBufferRight();

    void moveBufferUp();

    void moveBufferDown();

    bool clip(Common::Rect &r);

    void dump(const char *fname) const;
};

class ASurface : public BaseSurface {
protected:
    void addDirtyRect(const Common::Rect &r) override {}
public:
    ASurface() : BaseSurface() {}
};

class SpriteFrame : public ASurface {
public:
    SpriteFrame(const AccessEngine *vm, Common::SeekableReadStream *stream, int frameSize);
    ~SpriteFrame() override;
};

class SpriteResource {
public:
    Common::Array<SpriteFrame *> _frames;
public:
    SpriteResource(const AccessEngine *vm, Resource *res);
    ~SpriteResource();

    int getCount() { return _frames.size(); }

    const SpriteFrame *getFrame(int idx) const { return _frames[idx]; }
};

enum ImageFlag {
    IMGFLAG_NONE = 0,
    IMGFLAG_CROPPED = 1,
    IMGFLAG_BACKWARDS = 2,
    IMGFLAG_DRAWN = 4,
    IMGFLAG_UNSCALED = 8
};

class ImageEntry {
public:
    int _frameNumber;
    SpriteResource *_spritesPtr;
    int _offsetY; // offset to apply to y position when sorting draw order
    Common::Point _position;
    int _flags;
    int _scaleOverride;
    Common::Point _sizeOverride;
public:
    ImageEntry();
};

class ImageEntryList : public Common::Array<ImageEntry> {
public:
    void addToList(ImageEntry &ie);
};

} // End of namespace Access

#endif /* ACCESS_ASURFACE_H */