Input subsystem. Converts operating system window messages to input state and events.
More...
Public Member Functions |
| Input (Context *context) |
| Construct.
|
virtual | ~Input () |
| Destruct.
|
void | Update () |
| Poll for window messages. Called by HandleBeginFrame().
|
void | SetToggleFullscreen (bool enable) |
| Set whether ALT-ENTER fullscreen toggle is enabled.
|
void | SetMouseVisible (bool enable) |
| Set whether the operating system mouse cursor is visible. When not visible (default), is kept centered to prevent leaving the window.
|
bool | OpenJoystick (unsigned index) |
| Open a joystick. Return true if successful.
|
void | CloseJoystick (unsigned index) |
| Close a joystick.
|
bool | DetectJoysticks () |
| Redetect joysticks. Return true if successful.
|
bool | GetKeyDown (int key) const |
| Check if a key is held down.
|
bool | GetKeyPress (int key) const |
| Check if a key has been pressed on this frame.
|
bool | GetMouseButtonDown (int button) const |
| Check if a mouse button is held down.
|
bool | GetMouseButtonPress (int button) const |
| Check if a mouse button has been pressed on this frame.
|
bool | GetQualifierDown (int qualifier) const |
| Check if a qualifier key is held down.
|
bool | GetQualifierPress (int qualifier) const |
| Check if a qualifier key has been pressed on this frame.
|
int | GetQualifiers () const |
| Return the currently held down qualifiers.
|
IntVector2 | GetMousePosition () const |
| Return mouse position within window. Should only be used with a visible mouse cursor.
|
const IntVector2 & | GetMouseMove () const |
| Return mouse movement since last frame.
|
int | GetMouseMoveX () const |
| Return horizontal mouse movement since last frame.
|
int | GetMouseMoveY () const |
| Return vertical mouse movement since last frame.
|
int | GetMouseMoveWheel () const |
| Return mouse wheel movement since last frame.
|
unsigned | GetNumTouches () const |
| Return number of active finger touches.
|
TouchState * | GetTouch (unsigned index) const |
| Return active finger touch by index.
|
unsigned | GetNumJoysticks () const |
| Return number of connected joysticks.
|
const String & | GetJoystickName (unsigned index) const |
| Return joystick name by index.
|
JoystickState * | GetJoystick (unsigned index) |
| Return joystick state by index. Automatically open if not opened yet.
|
bool | GetToggleFullscreen () const |
| Return whether fullscreen toggle is enabled.
|
bool | IsMouseVisible () const |
| Return whether the operating system mouse cursor is visible.
|
bool | IsActive () |
| Return whether application window is active.
|
bool | IsMinimized () const |
| Return whether application window is minimized.
|
| Object (Context *context) |
| Construct.
|
virtual | ~Object () |
| Destruct. Clean up self from event sender & receiver structures.
|
virtual ShortStringHash | GetType () const =0 |
| Return type hash.
|
virtual const String & | GetTypeName () const =0 |
| Return type name.
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender.
|
void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event.
|
void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event.
|
void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event.
|
void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events.
|
void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events.
|
void | UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
|
void | SendEvent (StringHash eventType) |
| Send event to all subscribers.
|
void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
Context * | GetContext () const |
| Return execution context.
|
Object * | GetSubsystem (ShortStringHash type) const |
| Return subsystem by type.
|
Object * | GetEventSender () const |
| Return active event sender. Null outside event handling.
|
EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling.
|
bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender.
|
bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event.
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
| RefCounted () |
| Construct. Allocate the reference count structure and set an initial self weak reference.
|
virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
|
void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
|
void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
|
int | Refs () const |
| Return reference count.
|
int | WeakRefs () const |
| Return weak reference count.
|
RefCount * | RefCountPtr () |
| Return pointer to the reference count structure.
|
Input subsystem. Converts operating system window messages to input state and events.