2007-05-30 21:56:52 +00:00
|
|
|
/* 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.
|
2007-03-17 00:07:34 +00:00
|
|
|
*
|
|
|
|
* 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 2
|
|
|
|
* 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, write to the Free Software
|
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
*
|
|
|
|
* $URL$
|
|
|
|
* $Id$
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef COMMON_EVENTS_H
|
|
|
|
#define COMMON_EVENTS_H
|
|
|
|
|
2007-06-22 23:20:50 +00:00
|
|
|
#include "common/keyboard.h"
|
2007-03-17 00:07:34 +00:00
|
|
|
#include "common/rect.h"
|
|
|
|
#include "common/system.h"
|
2007-03-17 10:36:14 +00:00
|
|
|
#include "common/noncopyable.h"
|
2007-03-17 00:07:34 +00:00
|
|
|
|
|
|
|
namespace Common {
|
|
|
|
|
2007-03-17 19:02:05 +00:00
|
|
|
/**
|
|
|
|
* The types of events backends may generate.
|
|
|
|
* @see Event
|
|
|
|
*
|
|
|
|
* @todo Merge EVENT_LBUTTONDOWN, EVENT_RBUTTONDOWN and EVENT_WHEELDOWN;
|
2007-05-29 20:07:19 +00:00
|
|
|
* likewise EVENT_LBUTTONUP, EVENT_RBUTTONUP, EVENT_WHEELUP.
|
2007-03-17 19:02:05 +00:00
|
|
|
* To do that, we just have to add a field to the Event which
|
|
|
|
* indicates which button was pressed.
|
|
|
|
*/
|
|
|
|
enum EventType {
|
|
|
|
/** A key was pressed, details in Event::kbd. */
|
|
|
|
EVENT_KEYDOWN = 1,
|
|
|
|
/** A key was released, details in Event::kbd. */
|
|
|
|
EVENT_KEYUP = 2,
|
|
|
|
/** The mouse moved, details in Event::mouse. */
|
|
|
|
EVENT_MOUSEMOVE = 3,
|
|
|
|
EVENT_LBUTTONDOWN = 4,
|
|
|
|
EVENT_LBUTTONUP = 5,
|
|
|
|
EVENT_RBUTTONDOWN = 6,
|
|
|
|
EVENT_RBUTTONUP = 7,
|
|
|
|
EVENT_WHEELUP = 8,
|
|
|
|
EVENT_WHEELDOWN = 9,
|
2007-12-29 09:48:49 +00:00
|
|
|
EVENT_MBUTTONDOWN = 13,
|
|
|
|
EVENT_MBUTTONUP = 14,
|
2007-03-17 19:02:05 +00:00
|
|
|
|
|
|
|
EVENT_QUIT = 10,
|
2007-05-29 20:07:19 +00:00
|
|
|
EVENT_SCREEN_CHANGED = 11,
|
2007-06-21 18:35:15 +00:00
|
|
|
/**
|
|
|
|
* The backend requests the agi engine's predictive dialog to be shown.
|
2007-06-03 18:44:03 +00:00
|
|
|
* TODO: Fingolfin suggests that it would be of better value to expand
|
|
|
|
* on this notion by generalizing its use. For example the backend could
|
|
|
|
* use events to ask for the save game dialog or to pause the engine.
|
|
|
|
* An associated enumerated type can accomplish this.
|
|
|
|
**/
|
2007-05-29 20:07:19 +00:00
|
|
|
EVENT_PREDICTIVE_DIALOG = 12
|
2007-03-17 19:02:05 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Data structure for an event. A pointer to an instance of Event
|
|
|
|
* can be passed to pollEvent.
|
|
|
|
* @todo Rework/document this structure. It should be made 100% clear which
|
|
|
|
* field is valid for which event type.
|
|
|
|
* Implementation wise, we might want to use the classic
|
|
|
|
* union-of-structs trick. It goes roughly like this:
|
|
|
|
* struct BasicEvent {
|
2008-01-28 00:14:17 +00:00
|
|
|
* EventType type;
|
2007-03-17 19:02:05 +00:00
|
|
|
* };
|
|
|
|
* struct MouseMovedEvent : BasicEvent {
|
2008-01-28 00:14:17 +00:00
|
|
|
* Common::Point pos;
|
2007-03-17 19:02:05 +00:00
|
|
|
* };
|
|
|
|
* struct MouseButtonEvent : MouseMovedEvent {
|
2008-01-28 00:14:17 +00:00
|
|
|
* int button;
|
2007-03-17 19:02:05 +00:00
|
|
|
* };
|
|
|
|
* struct KeyEvent : BasicEvent {
|
2008-01-28 00:14:17 +00:00
|
|
|
* ...
|
2007-03-17 19:02:05 +00:00
|
|
|
* };
|
|
|
|
* ...
|
|
|
|
* union Event {
|
|
|
|
* EventType type;
|
2008-01-28 00:14:17 +00:00
|
|
|
* MouseMovedEvent mouse;
|
|
|
|
* MouseButtonEvent button;
|
|
|
|
* KeyEvent key;
|
|
|
|
* ...
|
2007-03-17 19:02:05 +00:00
|
|
|
* };
|
|
|
|
*/
|
|
|
|
struct Event {
|
|
|
|
/** The type of the event. */
|
|
|
|
EventType type;
|
|
|
|
/** Flag to indicate if the event is real or synthetic. E.g. keyboard
|
|
|
|
* repeat events are synthetic.
|
|
|
|
*/
|
|
|
|
bool synthetic;
|
|
|
|
/**
|
|
|
|
* Keyboard data; only valid for keyboard events (EVENT_KEYDOWN and
|
|
|
|
* EVENT_KEYUP). For all other event types, content is undefined.
|
|
|
|
*/
|
2007-06-22 21:32:49 +00:00
|
|
|
KeyState kbd;
|
2007-03-17 19:02:05 +00:00
|
|
|
/**
|
|
|
|
* The mouse coordinates, in virtual screen coordinates. Only valid
|
|
|
|
* for mouse events.
|
|
|
|
* Virtual screen coordinates means: the coordinate system of the
|
|
|
|
* screen area as defined by the most recent call to initSize().
|
|
|
|
*/
|
|
|
|
Common::Point mouse;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2007-03-17 00:07:34 +00:00
|
|
|
/**
|
|
|
|
* The EventManager provides user input events to the client code.
|
|
|
|
* In addition, it keeps track of the state of various input devices,
|
|
|
|
* like keys, mouse position and buttons.
|
|
|
|
*/
|
2007-03-17 10:36:14 +00:00
|
|
|
class EventManager : NonCopyable {
|
2007-03-17 00:07:34 +00:00
|
|
|
public:
|
|
|
|
EventManager() {}
|
|
|
|
virtual ~EventManager() {}
|
2008-01-27 19:47:41 +00:00
|
|
|
|
2007-03-17 00:07:34 +00:00
|
|
|
enum {
|
|
|
|
LBUTTON = 1 << 0,
|
|
|
|
RBUTTON = 1 << 1
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the next event in the event queue.
|
|
|
|
* @param event point to an Event struct, which will be filled with the event data.
|
|
|
|
* @return true if an event was retrieved.
|
|
|
|
*/
|
2007-03-17 19:02:05 +00:00
|
|
|
virtual bool pollEvent(Common::Event &event) = 0;
|
2007-03-17 00:07:34 +00:00
|
|
|
|
2007-09-19 13:55:05 +00:00
|
|
|
/** Register random source so it can be serialized in game test purposes **/
|
|
|
|
virtual void registerRandomSource(Common::RandomSource &rnd, const char *name) = 0;
|
2008-01-27 19:47:41 +00:00
|
|
|
|
2007-09-19 13:55:05 +00:00
|
|
|
virtual void processMillis(uint32 &millis) = 0;
|
2008-01-27 19:47:41 +00:00
|
|
|
|
2008-04-11 19:05:44 +00:00
|
|
|
/** Return the current mouse position */
|
2007-03-17 00:07:34 +00:00
|
|
|
virtual Common::Point getMousePos() const = 0;
|
2008-01-27 19:47:41 +00:00
|
|
|
|
2007-03-17 00:07:34 +00:00
|
|
|
/**
|
|
|
|
* Return a bitmask with the button states:
|
|
|
|
* - bit 0: left button up=1, down=0
|
|
|
|
* - bit 1: right button up=1, down=0
|
|
|
|
*/
|
|
|
|
virtual int getButtonState() const = 0;
|
2008-01-27 19:47:41 +00:00
|
|
|
|
2007-03-17 00:07:34 +00:00
|
|
|
/** Get a bitmask with the current modifier state */
|
|
|
|
virtual int getModifierState() const = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Should the application terminate? Set to true if we
|
|
|
|
* received an EVENT_QUIT.
|
|
|
|
*/
|
|
|
|
virtual int shouldQuit() const = 0;
|
2008-01-27 19:47:41 +00:00
|
|
|
|
2007-03-17 00:07:34 +00:00
|
|
|
// Optional: check whether a given key is currently pressed ????
|
|
|
|
//virtual bool isKeyPressed(int keycode) = 0;
|
|
|
|
|
|
|
|
// TODO: Keyboard repeat support?
|
2008-01-27 19:47:41 +00:00
|
|
|
|
2007-03-17 00:07:34 +00:00
|
|
|
// TODO: Consider removing OSystem::getScreenChangeID and
|
|
|
|
// replacing it by a generic getScreenChangeID method here
|
|
|
|
};
|
|
|
|
|
2007-03-17 10:36:14 +00:00
|
|
|
} // End of namespace Common
|
2007-03-17 00:07:34 +00:00
|
|
|
|
|
|
|
#endif
|