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

#include "common/scummsys.h"
#include "common/events.h"
#include "common/queue.h"
#include "sherlock/image_file.h"

namespace Sherlock {

#define GAME_FRAME_RATE 30
#define GAME_FRAME_TIME (1000 / GAME_FRAME_RATE)

enum CursorId { ARROW = 0, MAGNIFY = 1, WAIT = 2, EXIT_ZONES_START = 5, INVALID_CURSOR = -1 };

class SherlockEngine;

class Events {
private:
    SherlockEngine *_vm;
    uint32 _frameCounter;
    uint32 _priorFrameTime;
    ImageFile *_cursorImages;
    int _mouseButtons;
    Common::Point _mousePos;
    int _waitCounter;
    uint _frameRate;

    bool checkForNextFrameCounter();
public:
    CursorId _cursorId;
    bool _pressed;
    bool _released;
    bool _rightPressed;
    bool _rightReleased;
    bool _oldButtons;
    bool _oldRightButton;
    bool _firstPress;
    Common::Queue<Common::KeyState> _pendingKeys;
    Common::Queue<Common::CustomEventType> _pendingActions;
    Common::Point _hotspotPos;
public:
    Events(SherlockEngine *vm);
    ~Events();

    void loadCursors(const Common::Path &filename);

    void setCursor(CursorId cursorId);

    void setCursor(const Graphics::Surface &src, int hotspotX = 0, int hotspotY = 0);

    void setCursor(CursorId cursorId, const Common::Point &cursorPos, const Graphics::Surface &surface);

    void animateCursorIfNeeded();

    void showCursor();

    void hideCursor();

    CursorId getCursor() const;

    bool isCursorVisible() const;

    void pollEvents();

    void pollEventsAndWait();

    void warpMouse(const Common::Point &pt);

    void warpMouse();

    Common::Point screenMousePos() const { return _mousePos; }

    Common::Point mousePos() const;

    void setFrameRate(int newRate);

    void toggleSpeed();

    uint32 getFrameCounter() const { return _frameCounter; }

    bool kbHit() const { return !_pendingKeys.empty(); }

    bool actionHit() const { return !_pendingActions.empty(); }

    Common::KeyState getKey();

    Common::CustomEventType getAction();

    void clearEvents();

    void clearKeyboard();

    void clearActions();

    void wait(int numFrames);

    bool delay(uint32 time, bool interruptable = false);

    void setButtonState();

    bool checkInput();

    void incWaitCounter();

    void decWaitCounter();
};

} // End of namespace Sherlock

#endif /* SHERLOCK_EVENTS_H */