SingleKeyEventManager Class Reference

Manager for single key events. More...

#include <SingleKeyEventManager.h>

Collaboration diagram for SingleKeyEventManager:

Public Types
typedef StorageList::iterator	StorageListReference

Public Member Functions
	SingleKeyEventManager (const SingleKeyEventManager &)=delete
SingleKeyEventManager &	operator= (const SingleKeyEventManager &)=delete
	SingleKeyEventManager (SingleKeyEventManager &&)=delete
SingleKeyEventManager &	operator= (SingleKeyEventManager &&)=delete
	SingleKeyEventManager (AZUL_KEY key)
	Constructor. More...
void	registerEntity (Inputable *pInputable, InputEvent eventType)
	Registers the entity. More...
void	deregisterEntity (Inputable *pInputable, InputEvent eventType)
	Deregisters the entity. More...
void	processEntities ()
	Process the entities. More...

Private Types
enum class	KeyState { KEY_DOWN , KEY_UP }
	Values that represent key states. More...
typedef std::list< Inputable * >	StorageList

Private Member Functions
KeyState	getKeyState () const
	Gets key state. More...
bool	isKeyPressed (KeyState keyState) const
	Query if 'keyState' is key pressed. More...
bool	isKeyReleased (KeyState keyState) const
	Query if 'keyState' is key released. More...
void	processKeyPressedEntities ()
	Process the key pressed entities. More...
void	processKeyReleasedEntities ()
	Process the key released entities. More...

Private Attributes
AZUL_KEY	_key
StorageList	_registeredKeyPressEntites
StorageList	_registeredKeyReleaseEntites
KeyState	_previousKeyState

Detailed Description

Manager for single key events.

Member Enumeration Documentation

KeyState

enum SingleKeyEventManager::KeyState

strongprivate

Values that represent key states.

Used internally by the SingleKeyEventManager.

Constructor & Destructor Documentation

SingleKeyEventManager()

SingleKeyEventManager::SingleKeyEventManager

(

AZUL_KEY

key

)

Constructor.

Parameters

key

The key.

Member Function Documentation

deregisterEntity()

void SingleKeyEventManager::deregisterEntity	(	Inputable *	pInputable,
		InputEvent	eventType
	)

Deregisters the entity.

Parameters

pInputable	the inputable.
eventType	Type of the event.

getKeyState()

SingleKeyEventManager::KeyState SingleKeyEventManager::getKeyState ( ) const

private

Gets key state.

Returns

The key state.

isKeyPressed()

bool SingleKeyEventManager::isKeyPressed ( KeyState  keyState ) const

private

Query if 'keyState' is key pressed.

Parameters

keyState

State of the key.

Returns

True if key pressed, false if not.

isKeyReleased()

bool SingleKeyEventManager::isKeyReleased ( KeyState  keyState ) const

private

Query if 'keyState' is key released.

Parameters

keyState

State of the key.

Returns

True if key released, false if not.

processEntities()

void SingleKeyEventManager::processEntities

(

)

Process the entities.

processKeyPressedEntities()

void SingleKeyEventManager::processKeyPressedEntities ( )

private

Process the key pressed entities.

processKeyReleasedEntities()

void SingleKeyEventManager::processKeyReleasedEntities ( )

private

Process the key released entities.

registerEntity()

void SingleKeyEventManager::registerEntity	(	Inputable *	pInputable,
		InputEvent	eventType
	)

Registers the entity.

Parameters

pInputable	the inputable.
eventType	Type of the event.

---

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

• SingleKeyEventManager.h
• SingleKeyEventManager.cpp