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 MADS_USER_INTERFACE_H
#define MADS_USER_INTERFACE_H

#include "common/scummsys.h"
#include "common/rect.h"
#include "common/str.h"
#include "mads/msurface.h"
#include "mads/screen.h"

namespace MADS {

enum { IMG_SPINNING_OBJECT = 200, IMG_TEXT_UPDATE = 201 };

enum ScrollbarActive {
    SCROLLBAR_NONE = 0,     // No state
    SCROLLBAR_UP = 1,       // Up butotn
    SCROLLBAR_DOWN = 2,     // Down button
    SCROLLBAR_ELEVATOR = 3, // Elevator bar
    SCROLLBAR_THUMB = 4     // Scrollbar thumb
};

class AnimFrameEntry;
class MADSEngine;

class UISlot {
public:
    int _flags;
    int _segmentId;
    int _spritesIndex;
    int _frameNumber;
    Common::Point _position;

    // Only used for IMG_OVERPRINT
    int _width;
    int _height;

    UISlot();
};

class UISlots : public Common::Array<UISlot> {
private:
    MADSEngine *_vm;
public:
    UISlots(MADSEngine *vm) : _vm(vm) {}

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

    void add(const AnimFrameEntry &frameEntry);

    void fullRefresh();

    void draw(bool updateFlag, bool delFlag);
};

class Conversation {
private:
    static MADSEngine *_vm;
public:
    static void init(MADSEngine *vm);
public:
    int _globalId;
    Common::Array<int> _quotes;

    void setup(int globalId, ...);

    void set(int quoteId, ...);

    int read(int quoteId);

    void write(int quoteId, bool flag);

    void start();
};

class UserInterface : public MSurface {
    friend class UISlots;
private:
    MADSEngine *_vm;
    int _invSpritesIndex;
    int _invFrameNumber;
    uint32 _scrollMilli;
    bool _scrollFlag;
    int _noSegmentsActive;
    int _someSegmentsActive;

    void loadElements();

    bool getBounds(ScrCategory category, int invIndex, Common::Rect &bounds);

    void moveRect(Common::Rect &bounds);

    void drawConversationList();

    void drawActions();

    void drawInventoryList();

    void drawItemVocabList();

    void drawScroller();

    void scrollbarChanged();

    void writeVocab(ScrCategory category, int id);
public:
    MSurface _surface;
    UISlots _uiSlots;
    DirtyAreas _dirtyAreas;
    ScrCategory _category;
    Common::Rect *_rectP;
    int _inventoryTopIndex;
    int _selectedInvIndex;
    int _selectedActionIndex;
    int _selectedItemVocabIdx;
    ScrollbarActive _scrollbarActive, _scrollbarOldActive;
    int _highlightedCommandIndex;
    int _highlightedInvIndex;
    int _highlightedItemVocabIndex;
    bool _inventoryChanged;
    int _categoryIndexes[8];
    Common::StringArray _talkStrings;
    Common::Array<int> _talkIds;
    bool _scrollbarQuickly;
    uint32 _scrollbarMilliTime;
    int _scrollbarElevator, _scrollbarOldElevator;
    ScrollbarActive _scrollbarStrokeType;
public:
    UserInterface(MADSEngine *vm);

    void load(const Common::Path &resName) override;

    void setup(InputMode inputMode);

    void drawTextElements();

    void mergeFrom(BaseSurface *src, const Common::Rect &srcBounds, const Common::Point &destPos,
        int transparencyIndex = -1);

    void loadInventoryAnim(int objectId);

    void noInventoryAnim();

    void doBackgroundAnimation();

    void inventoryAnim();

    void categoryChanged();

    void selectObject(int invIndex);

    void updateSelection(ScrCategory category, int newIndex, int *idx);

    void changeScrollBar();

    void scrollerChanged();

    void scrollInventory();

    void updateInventoryScroller();

    void emptyConversationList();

    void addConversationMessage(int vocabId, const Common::String &msg);

    void synchronize(Common::Serializer &s);

    void refresh();
};

} // End of namespace MADS

#endif /* MADS_USER_INTERFACE_H */