tattoo_user_interface.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 SHERLOCK_TATTOO_UI_H
#define SHERLOCK_TATTOO_UI_H

#include "common/scummsys.h"
#include "common/list.h"
#include "sherlock/saveload.h"
#include "sherlock/screen.h"
#include "sherlock/user_interface.h"
#include "sherlock/tattoo/widget_credits.h"
#include "sherlock/tattoo/widget_files.h"
#include "sherlock/tattoo/widget_inventory.h"
#include "sherlock/tattoo/widget_options.h"
#include "sherlock/tattoo/widget_quit.h"
#include "sherlock/tattoo/widget_text.h"
#include "sherlock/tattoo/widget_tooltip.h"
#include "sherlock/tattoo/widget_verbs.h"

namespace Sherlock {

namespace Tattoo {

// Button width/height
#define BUTTON_SIZE 15
// How long to play the intro before it can be skipped
#define STARTUP_KEYS_DISABLED_DELAY 200

class WidgetBase;

enum ScrollHighlight { SH_NONE = 0, SH_SCROLL_UP = 1, SH_PAGE_UP = 2, SH_THUMBNAIL = 3, SH_PAGE_DOWN = 4, SH_SCROLL_DOWN = 5 };

class WidgetList : public Common::List <WidgetBase *> {
public:
    bool contains(const WidgetBase *item) const;
};

class TattooUserInterface : public UserInterface {
    friend class WidgetBase;
private:
    int _scriptZone;
    int _cAnimFramePause;
    WidgetInventory _inventoryWidget;
    WidgetMessage _messageWidget;
    WidgetQuit _quitWidget;
    WidgetList _fixedWidgets;
    WidgetList _widgets;
    byte _lookupTable[Graphics::PALETTE_COUNT];
    byte _lookupTable1[Graphics::PALETTE_COUNT];
private:
    void doStandardControl();

    void doLookControl();

    void doFileControl();

    void doVerbControl();

    void freeMenu();
public:
    Common::Point _targetScroll;
    int _scrollSize, _scrollSpeed;
    bool _drawMenu;
    int _arrowZone, _oldArrowZone;
    Object *_bgShape;
    bool _personFound;
    int _activeObj;
    Common::KeyState _keyState;
    Common::CustomEventType _action;
    Common::Point _lookPos;
    ScrollHighlight _scrollHighlight;
    Common::SeekableReadStream *_mask, *_mask1;
    Common::Point _maskOffset;
    int _maskCounter;
    int _lockoutTimer;
    ImageFile *_interfaceImages;
    WidgetCredits _creditsWidget;
    WidgetOptions _optionsWidget;
    WidgetText _textWidget;
    WidgetSceneTooltip _tooltipWidget;
    WidgetVerbs _verbsWidget;
    WidgetList _postRenderWidgets;
public:
    TattooUserInterface(SherlockEngine *vm);
    ~TattooUserInterface() override;

    void doBgAnimRestoreUI();

    void doScroll();

    void initScrollVars();

    void lookAtObject();

    void printObjectDesc(const Common::String &str, bool firstTime);

    void doJournal();

    void doInventory(int mode);

    void doControls();

    void doQuitMenu();

    void pickUpObject(int objNum);

    void putMessage(MSVC_PRINTF const char *formatStr, ...) GCC_PRINTF(2, 3);

    void setupBGArea(const byte cMap[Graphics::PALETTE_SIZE]);

    void doBgAnimEraseBackground();

    void drawMaskArea(bool mode);

    void maskArea(Common::SeekableReadStream &mask, const Common::Point &pt);

    void makeBGArea(const Common::Rect &r);

    void drawDialogRect(Surface &s, const Common::Rect &r, bool raised);

    void displayObjectNames();

    void loadGame();

    void saveGame();

    void addFixedWidget(WidgetBase *widget);
public:
    void reset() override;

    void handleInput() override;

    void drawInterface(int bufferNum = 3) override;

    void clearWindow() override;

    void banishWindow(bool slideUp = true) override;
};

} // End of namespace Tattoo

} // End of namespace Sherlock

#endif