KeyboardController Class Reference

#include <KeyboardController.h>

Inheritance diagram for KeyboardController:

Public Member Functions
	KeyboardController ()
bool	isKeyPressedThisFrame (PlatformKey key) const
bool	isKeyDownThisFrame (PlatformKey key) const
void	reset ()
Public Member Functions inherited from PlatformEventFilter
	PlatformEventFilter (std::initializer_list< PlatformEventType > eventTypes)
	PlatformEventFilter (PlatformEventWildcard eventTypes)
virtual bool	event (const PlatformEvent *event)
const std::vector< PlatformEventType >	eventTypes () const
Public Member Functions inherited from ProxyEventLoop
	ProxyEventLoop (PlatformEventLoop *base=nullptr)
virtual	~ProxyEventLoop ()=default
virtual void	exec (PlatformEventHandler *eventHandler) override
virtual void	quit () override
virtual void	processMessages (PlatformEventHandler *eventHandler) override
virtual void	waitForMessages () override
Public Member Functions inherited from ProxyBase< PlatformEventLoop >
	ProxyBase (PlatformEventLoop *base)
PlatformEventLoop *	base () const
void	setBase (PlatformEventLoop *base)
Public Member Functions inherited from PlatformEventLoop
virtual	~PlatformEventLoop ()=default
virtual void	exec (PlatformEventHandler *eventHandler)=0
virtual void	quit ()=0
virtual void	processMessages (PlatformEventHandler *eventHandler)=0
virtual void	waitForMessages ()=0

Private Member Functions
virtual bool	keyPressEvent (const PlatformKeyEvent *event) override
virtual bool	keyReleaseEvent (const PlatformKeyEvent *event) override
virtual void	processMessages (PlatformEventHandler *eventHandler) override

Private Attributes
IndexedArray< bool, PlatformKey::KEY_FIRST, PlatformKey::KEY_LAST >	_isKeyDown = {{}}
IndexedArray< bool, PlatformKey::KEY_FIRST, PlatformKey::KEY_LAST >	_isKeyPressedThisFrame = {{}}

Additional Inherited Members
Protected Member Functions inherited from PlatformEventFilter
virtual bool	keyPressEvent (const PlatformKeyEvent *event)
virtual bool	keyReleaseEvent (const PlatformKeyEvent *event)
virtual bool	mouseMoveEvent (const PlatformMouseEvent *event)
virtual bool	mousePressEvent (const PlatformMouseEvent *event)
virtual bool	mouseReleaseEvent (const PlatformMouseEvent *event)
virtual bool	wheelEvent (const PlatformWheelEvent *event)
virtual bool	moveEvent (const PlatformMoveEvent *event)
virtual bool	resizeEvent (const PlatformResizeEvent *event)
virtual bool	activationEvent (const PlatformWindowEvent *event)
virtual bool	closeEvent (const PlatformWindowEvent *event)
virtual bool	gamepadConnectionEvent (const PlatformGamepadEvent *event)
virtual bool	gamepadKeyPressEvent (const PlatformGamepadKeyEvent *event)
virtual bool	gamepadKeyReleaseEvent (const PlatformGamepadKeyEvent *event)
virtual bool	gamepadAxisEvent (const PlatformGamepadAxisEvent *event)
virtual bool	nativeEvent (const PlatformNativeEvent *event)
virtual bool	textInputEvent (const PlatformTextInputEvent *event)
Protected Member Functions inherited from ProxyBase< PlatformEventLoop >
PlatformEventLoop *	nonNullBase () const

Constructor & Destructor Documentation

KeyboardController()

KeyboardController::KeyboardController

(

)

Member Function Documentation

isKeyDownThisFrame()

bool KeyboardController::isKeyDownThisFrame

(

PlatformKey

key

)

const

Parameters

key	Key to check.

Returns

Whether the key is held down this frame. Key is considered held down for the frame if it was pressed (and potentially released) this frame, or if it was pressed in one of the previous frames and is still not released.

isKeyPressedThisFrame()

bool KeyboardController::isKeyPressedThisFrame

(

PlatformKey

key

)

const

Parameters

key	Key to check.

Returns

Whether the key was pressed at least once this frame.

keyPressEvent()

bool KeyboardController::keyPressEvent ( const PlatformKeyEvent *  event )

overrideprivatevirtual

Reimplemented from PlatformEventFilter.

keyReleaseEvent()

bool KeyboardController::keyReleaseEvent ( const PlatformKeyEvent *  event )

overrideprivatevirtual

Reimplemented from PlatformEventFilter.

processMessages()

void KeyboardController::processMessages ( PlatformEventHandler *  eventHandler )

overrideprivatevirtual

Processes the messages that are currently in the message queue, and returns. Returns immediately if there are no messages in the message queue.

Parameters

eventHandler

Callback for event processing.

Reimplemented from ProxyEventLoop.

reset()

void KeyboardController::reset

(

)

Member Data Documentation

_isKeyDown

IndexedArray<bool, PlatformKey::KEY_FIRST, PlatformKey::KEY_LAST> KeyboardController::_isKeyDown = {{}}

private

Whether the key is currently held down.

_isKeyPressedThisFrame

IndexedArray<bool, PlatformKey::KEY_FIRST, PlatformKey::KEY_LAST> KeyboardController::_isKeyPressedThisFrame = {{}}

private

Whether the key was pressed this frame.

---

The documentation for this class was generated from the following files:

• src/Io/KeyboardController.h
• src/Io/KeyboardController.cpp