events.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 ACCESS_EVENTS_H
#define ACCESS_EVENTS_H

#include "common/scummsys.h"
#include "common/events.h"
#include "common/stack.h"

namespace Access {

enum CursorType {
    // These names are for Amazon - Noctropolis uses a different order.
    CURSOR_NONE = -1,
    CURSOR_ARROW = 0,
    CURSOR_CROSSHAIRS = 1,
    CURSOR_2 = 2,
    CURSOR_3 = 3,
    CURSOR_LOOK = 4,
    CURSOR_USE = 5,
    CURSOR_TAKE = 6,
    CURSOR_CLIMB = 7,
    CURSOR_TALK = 8,
    CURSOR_HELP = 9,
    CURSOR_NOCT_EXIT = 9,
    CURSOR_DARK_ANKH = 10,
    CURSOR_INVENTORY = 99
};

#define GAME_FRAME_RATE 100
#define GAME_FRAME_TIME (1000 / GAME_FRAME_RATE)
#define GAME_TIMER_TIME 15

class AccessEngine;

class EventsManager {
private:
    AccessEngine *_vm;
    uint32 _frameCounter;
    uint32 _priorFrameTime;
    uint32 _priorTimerTime;
    Common::KeyCode _keyCode;
    Common::CustomEventType _action;

    Graphics::Surface _invCursor;
    bool checkForNextFrameCounter();
    bool checkForNextTimerUpdate();
    void nextFrame();
    void nextTimer();
    void keyControl(Common::KeyCode keycode, bool isKeyDown);
    void actionControl(Common::CustomEventType action, bool isKeyDown);

public:
    CursorType _cursorId;
    CursorType _normalMouse;
    bool _leftButton, _rightButton;
    bool _middleButton;
    bool _wheelUp, _wheelDown;
    Common::Point _mousePos;
    int _mouseCol, _mouseRow;
    bool _cursorExitFlag;
    int _vbCount;
    bool _interfaceOff;
public:
    EventsManager(AccessEngine *vm);

    ~EventsManager();

    uint32 getFrameCounter() const { return _frameCounter; }

    void forceSetCursor(CursorType cursorId);

    void setNormalCursor(CursorType cursorId);

    void setCursor(CursorType cursorId);

    void setCursorData(Graphics::ManagedSurface *src, const Common::Rect &r);

    CursorType getCursor() const { return _cursorId; }

    void showCursor();

    void hideCursor();

    bool isCursorVisible();

    void pollEvents(bool skipTimers = false);

    void pollEventsAndWait();

    void zeroKeysActions();

    bool getAction(Common::CustomEventType &action);

    Common::CustomEventType peekAction() const { return _action; }

    Common::KeyCode peekKeyCode() const { return _keyCode; }

    bool isKeyActionPending() const;

    void delay(int time = 5);

    void delayUntilNextFrame();

    void debounceLeft();

    void debounceRight();

    void clearEvents();

    void waitKeyActionMouse();

    const Common::Point &getMousePos() const { return _mousePos; }

    Common::Point calcRawMouse();

    int checkMouseBox1(const Common::Array<Common::Rect> &rects);

    bool isKeyActionMousePressed();

    void centerMousePos();
    void restrictMouse();

    static int16 clipMouseCenter(int16 mousePos, int16 length, int16 maxLength, int16 &warpMousePos);

    /* get ms delay before considering something a double-click */
    uint32 getDoubleClickTime() const;

    uint32 getPriorFrameTime() const { return _priorFrameTime; }
};

} // End of namespace Access

#endif /* ACCESS_EVENTS_H */