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

#include "common/scummsys.h"
#include "xeen/dialogs/dialogs.h"
#include "xeen/interface_minimap.h"
#include "xeen/interface_scene.h"
#include "xeen/party.h"
#include "xeen/window.h"

namespace Xeen {

class XeenEngine;

enum Obscurity {
    OBSCURITY_BLACK = 0,
    OBSCURITY_3 = 1,
    OBSCURITY_2 = 2,
    OBSCURITY_1 = 3,
    OBSCURITY_NONE = 4
};

enum IconsMode {
    ICONS_STANDARD = 0,
    ICONS_COMBAT = 1
};

enum FallState {
    FALL_NONE = 0,
    FALL_IN_PROGRESS = 1,
    FALL_START = 2
};

#define HILIGHT_CHAR_DISABLED -2
#define HILIGHT_CHAR_NONE -1

class PartyDrawer {
private:
    XeenEngine *_vm;
    SpriteResource _dseFace;
    SpriteResource _hpSprites;
    SpriteResource _restoreSprites;
    int _hiliteChar;
public:
    PartyDrawer(XeenEngine *vm);

    void drawParty(bool updateFlag);

    void highlightChar(int charId);

    void highlightChar(const Character *c);

    void unhighlightChar();

    void resetHighlight();
};

class Interface: public ButtonContainer, public InterfaceScene,
        public InterfaceMinimap, public PartyDrawer {
private:
    XeenEngine *_vm;
    SpriteResource _uiSprites;
    SpriteResource _borderSprites;
    SpriteResource _spellFxSprites;
    SpriteResource _fecpSprites;
    SpriteResource _blessSprites;
    SpriteResource _stdIcons;
    SpriteResource _combatIcons;
    Graphics::ManagedSurface _fallSurface;
    bool _buttonsLoaded;
    int _steppingFX;
    int _blessedUIFrame;
    int _powerShieldUIFrame;
    int _holyBonusUIFrame;
    int _heroismUIFrame;
    int _flipUIFrame;

    void loadSprites();

    void setupBackground();

    void setMainButtons(IconsMode mode = ICONS_STANDARD);

    void chargeStep();

    void stepTime();

    void doStepCode();

    bool checkMoveDirection(int key);

    void handleFalling();

    void setupFallSurface(bool isTop);

    void fall(int yp);

    void shake(int count);

    void nextChar();
public:
    Obscurity _obscurity;
    FallState _falling;
    int _face1State, _face2State;
    int _face1UIFrame, _face2UIFrame;
    int _spotDoorsUIFrame;
    int _dangerSenseUIFrame;
    int _levitateUIFrame;
    bool _upDoorText;
    Common::String _screenText;
    byte _tillMove;
    int _charFX[6];
    IconsMode _iconsMode;
public:
    Interface(XeenEngine *vm);

    ~Interface() override {}

    void setup();

    void manageCharacters(bool soundPlayed);

    void startup();

    void mainIconsPrint();

    void startFalling(bool v);

    void perform();

    void rest();

    void bash(const Common::Point &pt, Direction direction);

    void draw3d(bool updateFlag, bool pauseFlag = true);

    void assembleBorder();

    void doCombat();

    void spellFX(Character *c);

    void obscureScene(Obscurity obscurity);
};

} // End of namespace Xeen

#endif /* XEEN_INTERFACE_H */