paint16.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_PAINT16_H
#define SCI_GRAPHICS_PAINT16_H

namespace Sci {

class GfxPorts;
class GfxScreen;
class GfxPalette;
class Font;
class GfxView;
struct HiresDrawData;

class GfxPaint16 {
public:
    GfxPaint16(ResourceManager *resMan, SegManager *segMan, GfxCache *cache, GfxPorts *ports, GfxCoordAdjuster16 *coordAdjuster, GfxScreen *screen, GfxPalette *palette, GfxTransitions *transitions, AudioPlayer *audio);
    ~GfxPaint16();

    void init(GfxAnimate *animate, GfxText16 *text16);

    void debugSetEGAdrawingVisualize(bool state);

    void drawPicture(GuiResourceId pictureId, bool mirroredFlag, bool addToFlag, GuiResourceId paletteId);
    void drawCelAndShow(GuiResourceId viewId, int16 loopNo, int16 celNo, uint16 leftPos, uint16 topPos, byte priority, uint16 paletteNo, uint16 scaleX = 128, uint16 scaleY = 128, uint16 scaleSignal = 0);
    void drawCel(GuiResourceId viewId, int16 loopNo, int16 celNo, const Common::Rect &celRect, byte priority, uint16 paletteNo, uint16 scaleX = 128, uint16 scaleY = 128, uint16 scaleSignal = 0);
    void drawCel(GfxView *view, int16 loopNo, int16 celNo, const Common::Rect &celRect, byte priority, uint16 paletteNo, uint16 scaleX = 128, uint16 scaleY = 128, uint16 scaleSignal = 0);
    void drawHiresCelAndShow(GuiResourceId viewId, int16 loopNo, int16 celNo, uint16 leftPos, uint16 topPos, byte priority, uint16 paletteNo, reg_t hiresHandle, bool storeDrawingInfo);
    void redrawHiresCels();

    void clearScreen(byte color = 255);
    void invertRect(const Common::Rect &rect);
    void invertRectViaXOR(const Common::Rect &rect);
    void eraseRect(const Common::Rect &rect);
    void paintRect(const Common::Rect &rect);
    void fillRect(const Common::Rect &rect, int16 drawFlags, byte color, byte priority = 0, byte control = 0);
    void frameRect(const Common::Rect &rect);

    void bitsShow(const Common::Rect &r);
    reg_t bitsSave(const Common::Rect &rect, byte screenFlags, bool hiresFlag = false);
    void bitsGetRect(reg_t memoryHandle, Common::Rect *destRect);
    void bitsRestore(reg_t memoryHandle);
    void bitsFree(reg_t memoryHandle);

    void kernelDrawPicture(GuiResourceId pictureId, int16 animationNr, bool animationBlackoutFlag, bool mirroredFlag, bool addToFlag, int16 EGApaletteNo);
    void kernelDrawCel(GuiResourceId viewId, int16 loopNo, int16 celNo, uint16 leftPos, uint16 topPos, int16 priority, uint16 paletteNo, uint16 scaleX, uint16 scaleY, bool hiresMode, reg_t hiresHandle);

    void kernelGraphFillBoxForeground(const Common::Rect &rect);
    void kernelGraphFillBoxBackground(const Common::Rect &rect);
    void kernelGraphFillBox(const Common::Rect &rect, uint16 colorMask, int16 color, int16 priority, int16 control);
    void kernelGraphFrameBox(const Common::Rect &rect, int16 color);
    void kernelGraphDrawLine(Common::Point startPoint, Common::Point endPoint, int16 color, int16 priority, int16 control);
    reg_t kernelGraphSaveBox(const Common::Rect &rect, uint16 flags, bool hiresFlag);
    void kernelGraphRestoreBox(reg_t handle);
    void kernelGraphUpdateBox(const Common::Rect &rect);
    void kernelGraphRedrawBox(Common::Rect rect);

    reg_t kernelDisplay(const char *text, uint16 languageSplitter, int argc, reg_t *argv);

    reg_t kernelPortraitLoad(const Common::String &resourceName);
    void kernelPortraitShow(const Common::String &resourceName, Common::Point position, uint16 resourceNum, uint16 noun, uint16 verb, uint16 cond, uint16 seq);
    void kernelPortraitUnload(uint16 portraitId);

private:
    ResourceManager *_resMan;
    SegManager *_segMan;
    AudioPlayer *_audio;
    GfxAnimate *_animate;
    GfxCache *_cache;
    GfxPorts *_ports;
    GfxCoordAdjuster16 *_coordAdjuster;
    GfxScreen *_screen;
    GfxPalette *_palette;
    GfxText16 *_text16;
    GfxTransitions *_transitions;

    // true means make EGA picture drawing visible
    bool _EGAdrawingVisualize;

    // The original KQ6WinCD interpreter saves the hires drawing information in a linked list. There are two use cases: one is redrawing the
    // window background when receiving WM_PAINT messages (which is irrelevant for us, since that happens in the backend) and the other is
    // redrawing the inventory after displaying a text window over it. This only happens in mixed speech+text mode, which does not even exist
    // in the original. We do have that mode as a ScummVM feature, though. That's why we have that code, to be able to refresh the inventory.
    void removeHiresDrawObject(reg_t handle);
    Common::Rect makeHiresRect(Common::Rect &rect) const;

    HiresDrawData *_hiresDrawObjs;
    bool _hiresPortraitWorkaroundFlag;
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_PAINT16_H