cursor32.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 SCI_GRAPHICS_CURSOR32_H
#define SCI_GRAPHICS_CURSOR32_H

#include "common/array.h"           // for Array
#include "common/rect.h"            // for Point, Rect
#include "common/scummsys.h"        // for int16, byte, uint8
#include "common/serializer.h"      // for Serializable, Serializer (ptr only)
#include "sci/graphics/celobj32.h"  // for CelInfo32
#include "sci/graphics/helpers.h"   // for GuiResourceId

namespace Sci {

class GfxCursor32 : public Common::Serializable {
public:
    GfxCursor32();
    ~GfxCursor32() override;

    void init(const Buffer &outputBuffer);

    bool deviceMoved(Common::Point &position);

    virtual void gonnaPaint(Common::Rect paintRect);

    virtual void paintStarting();

    virtual void donePainting();

    virtual void hide();

    virtual void unhide();

    virtual void show();

    virtual void setView(const GuiResourceId viewId, const int16 loopNo, const int16 celNo);

    void setPosition(const Common::Point &position);

    void setRestrictedArea(const Common::Rect &rect);

    void clearRestrictedArea();

    void saveLoadWithSerializer(Common::Serializer &ser) override;

protected:
    CelInfo32 _cursorInfo;

    int _hideCount;

private:
    struct DrawRegion {
        Common::Rect rect;
        byte *data;

        DrawRegion() : data(nullptr) {}
    };

    DrawRegion _cursorBack;

    DrawRegion _scratch1;

    DrawRegion _scratch2;

    DrawRegion _screenRegion;

    DrawRegion _savedScreenRegion;

    DrawRegion _cursor;

    int16 _width, _height;

    Buffer _screen;

    Common::Point _position;

    Common::Point _hotSpot;

    Common::Rect _restrictedArea;

    bool _needsPaint;

    void copyFromScreen(DrawRegion &target);

    template <bool SKIP>
    void copy(DrawRegion &target, const DrawRegion &source);

    void revealCursor();

    void drawToScreen(const DrawRegion &source);

    virtual void move();

public:
    virtual void setMacCursorRemapList(int cursorCount, reg_t *cursors) {}
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_CURSOR32_H