i6e::api::InputFacade Class Reference

#include <D:/Projekte/i6engine/libs/i6engine-modules/include/i6engine/api/facades/InputFacade.h>

Public Member Functions
	InputFacade ()
	~InputFacade ()
void	setKeyMapping (const KeyCode id, const std::string &strAction)
	Sets a key mapping. More...
void	removeKeyMapping (const KeyCode id)
	Removes a key mapping. More...
std::string	getKeyMapping (const KeyCode id) const
	Retrieves a key mapping. More...
void	subscribeKeyEvent (const KeyCode name, const KeyState type, const boost::function< void(void)> &f) const
	Subscribes for a keyboard event. (m) More...
void	unsubscribeKeyEvent (const KeyCode name, const KeyState type) const
	Unsubscribes for a keyboard event. (m) More...
void	resetSubSystem ()
	resets the subsystem to it's defaults More...

Detailed Description

Definition at line 49 of file InputFacade.h.

Constructor & Destructor Documentation

i6e::api::InputFacade::InputFacade

(

)

i6e::api::InputFacade::~InputFacade

(

)

Member Function Documentation

std::string i6e::api::InputFacade::getKeyMapping

(

const KeyCode

id

)

const

Retrieves a key mapping.

Parameters

[in]

id

key code to retrieve action for

Returns

action bound to the key

void i6e::api::InputFacade::removeKeyMapping

(

const KeyCode

id

)

Removes a key mapping.

Parameters

[in]

id

key code to bind action to

void i6e::api::InputFacade::resetSubSystem

(

)

resets the subsystem to it's defaults

void i6e::api::InputFacade::setKeyMapping	(	const KeyCode	id,
		const std::string &	strAction
	)

Sets a key mapping.

Parameters

[in]	id	key code to bind action to
[in]	strAction	action to be bound

void i6e::api::InputFacade::subscribeKeyEvent	(	const KeyCode	name,
		const KeyState	type,
		const boost::function< void(void)> &	f
	)		const

Subscribes for a keyboard event. (m)

Parameters

name	The OIS::KeyCode for the specified Key, equivalent to an int
type	Type of the keyboard event.
ptrEventMethod	Everytime the Event occurs on this window, the Method leading to this pointer will be called

void i6e::api::InputFacade::unsubscribeKeyEvent	(	const KeyCode	name,
		const KeyState	type
	)		const

Unsubscribes for a keyboard event. (m)

Parameters

name	The OIS::KeyCode for the specified Key, equivalent to an int
type	Type of the keyboard event.

---

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

• InputFacade.h