dispman.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 Labyrinth of Time code with assistance of
 *
 * Copyright (c) 1993 Terra Nova Development
 * Copyright (c) 2004 The Wyrmkeep Entertainment Co.
 *
 */

#ifndef LAB_DISPMAN_H
#define LAB_DISPMAN_H

namespace Lab {

class LabEngine;
class Image;

struct TextFont {
    uint32 _dataLength;
    uint16 _height;
    byte _widths[256];
    uint16 _offsets[256];
    byte *_data;
};

enum TransitionType {
    kTransitionNone,
    kTransitionWipe,
    kTransitionScrollWipe,
    kTransitionScrollBlack,
    kTransitionScrollBounce,
    kTransitionTransporter,
    kTransitionReadFirstFrame,
    kTransitionReadNextFrame
};

class DisplayMan {
private:
    LabEngine *_vm;

    uint16 fadeNumIn(uint16 num, uint16 res, uint16 counter);
    uint16 fadeNumOut(uint16 num, uint16 res, uint16 counter);

    Common::String getWord(const char *mainBuffer);

    void createBox(uint16 y2);

    void createScreen(bool hiRes);

    void doScrollBlack();
    void copyPage(uint16 width, uint16 height, uint16 nheight, uint16 startline, byte *mem);

    void doScrollWipe(const Common::String filename);

    void doScrollBounce();

    void doTransWipe(const Common::String filename);

    void drawHLine(uint16 x, uint16 y1, uint16 y2, byte color);

    void drawVLine(uint16 x1, uint16 y, uint16 x2, byte color);

    void drawText(TextFont *tf, uint16 x, uint16 y, uint16 color, const Common::String text);

    Common::String getLine(TextFont *tf, const char **mainBuffer, uint16 lineWidth);

    uint16 textLength(TextFont *font, const Common::String text);

    bool _actionMessageShown;
    Common::File *_curBitmap;
    byte _curVgaPal[256 * 3];
    byte *_currentDisplayBuffer;

public:
    DisplayMan(LabEngine *lab);
    virtual ~DisplayMan();

    void loadPict(const Common::String filename);
    void loadBackPict(const Common::String fileName, uint16 *highPal);

    void readPict(const Common::String filename, bool playOnce = true, bool onlyDiffData = false, byte *memoryBuffer = nullptr);
    void freePict();

    void doTransition(TransitionType transitionType, const Common::String filename);

    void blackScreen();

    void whiteScreen();

    void blackAllScreen();

    void drawPanel();

    void setUpScreens();

    int longDrawMessage(Common::String str, bool isActionMessage);

    void drawMessage(Common::String str, bool isActionMessage);

    void setActionMessage(bool val) { _actionMessageShown = val; }

    void rectFill(uint16 x1, uint16 y1, uint16 x2, uint16 y2, byte color);
    void rectFill(Common::Rect fillRect, byte color);
    void rectFillScaled(uint16 x1, uint16 y1, uint16 x2, uint16 y2, byte color);
    int flowText(TextFont *font, int16 spacing, byte penColor, byte backPen, bool fillBack,
                bool centerh, bool centerv, bool output, Common::Rect textRect, const char *text, Image *targetImage = nullptr);

    void screenUpdate();

    void setAmigaPal(uint16 *pal);

    void writeColorRegs(byte *buf, uint16 first, uint16 numReg);
    void setPalette(void *newPal, uint16 numColors);

    void checkerBoardEffect(uint16 penColor, uint16 x1, uint16 y1, uint16 x2, uint16 y2);

    byte *getCurrentDrawingBuffer();

    void scrollDisplayX(int16 dx, uint16 x1, uint16 y1, uint16 x2, uint16 y2, byte *buffer);

    void scrollDisplayY(int16 dy, uint16 x1, uint16 y1, uint16 x2, uint16 y2, byte *buffer);
    void fade(bool fadein);

    void freeFont(TextFont **font);

    uint16 textHeight(TextFont *tf);

    bool _longWinInFront;
    bool _lastMessageLong;
    uint32 _screenBytesPerPage;
    int _screenWidth;
    int _screenHeight;
    byte *_displayBuffer;
    uint16 *_fadePalette;
};

} // End of namespace Lab

#endif // LAB_DISPMAN_H