PLInput::InputManager Class Reference

Input manager. More...

#include <InputManager.h>

List of all members.

Public Member Functions
PLINPUT_API void	Update ()
	Update input manager once per frame.
PLINPUT_API void	DetectDevices (bool bReset=false)
	Detect devices.
PLINPUT_API const PLCore::List < Provider * > &	GetProviders () const
	Get list of input providers.
PLINPUT_API PLCore::List < Provider * > &	GetProviders ()
	Get list of detected input providers.
PLINPUT_API Provider *	GetProvider (const PLCore::String &sProvider)
	Get a specific input provider.
PLINPUT_API PLCore::List < Device * > &	GetDevices ()
	Get list of devices.
PLINPUT_API Device *	GetDevice (const PLCore::String &sDevice) const
	Get a specific device.
PLINPUT_API Keyboard *	GetKeyboard () const
	Get default keyboard device.
PLINPUT_API Mouse *	GetMouse () const
	Get default mouse device.
Static Public Member Functions
static PLINPUT_API InputManager *	GetInstance ()
static PLINPUT_API bool	HasInstance ()
Public Attributes
PLCore::Event< bool >	EventOnDetectDevices
PLCore::Event< Controller *, PLCore::String >	EventInputControllerFound

---

Detailed Description

Input manager.

Remarks:

The input manager stores all available devices that are present on the computer and controls the update of input messages.

---

Member Function Documentation

static PLINPUT_API InputManager* PLInput::InputManager::GetInstance

(

)

[static]

static PLINPUT_API bool PLInput::InputManager::HasInstance

(

)

[static]

PLINPUT_API void PLInput::InputManager::Update

(

)

Update input manager once per frame.

Remarks:

This function must be called once per frame to allow devices to update their status and to process input messages read from these devices. This is also done to make sure that input messages are processed synchronously in the main thread, rather than sending messages from other threads asynchronously.

PLINPUT_API void PLInput::InputManager::DetectDevices

(

bool

bReset = false

)

Detect devices.

Parameters:

[in]

bReset

If 'true', delete all input devices and re-detect them all. Otherwise, only new and removed input devices will be detected.

Remarks:

bReset = true should only be used if really necessary, because existing input handlers will most certainly lose their connection to the device.

PLINPUT_API const PLCore::List<Provider*>& PLInput::InputManager::GetProviders

(

)

const

Get list of input providers.

Returns:

Provider list, do not destroy the returned instances!

PLINPUT_API PLCore::List<Provider*>& PLInput::InputManager::GetProviders

(

)

Get list of detected input providers.

Returns:

Provider list, do not destroy the returned instances!

PLINPUT_API Provider* PLInput::InputManager::GetProvider

(

const PLCore::String &

sProvider

)

Get a specific input provider.

Parameters:

[in]

sProvider

Name of provider

Returns:

Provider, or a null pointer if it doesn't exist, do not destroy the returned instance!

PLINPUT_API PLCore::List<Device*>& PLInput::InputManager::GetDevices

(

)

Get list of devices.

Returns:

Device list, do not destroy the returned instances!

PLINPUT_API Device* PLInput::InputManager::GetDevice

(

const PLCore::String &

sDevice

)

const

Get a specific device.

Parameters:

[in]

sDevice

Name of device

Returns:

Device, or a null pointer if it doesn't exist, do not destroy the returned instance!

PLINPUT_API Keyboard* PLInput::InputManager::GetKeyboard

(

)

const

Get default keyboard device.

Returns:

Default keyboard, can be a null pointer, do not destroy the returned instance!

PLINPUT_API Mouse* PLInput::InputManager::GetMouse

(

)

const

Get default mouse device.

Returns:

Default mouse, can be a null pointer, do not destroy the returned instance!

---

Member Data Documentation

PLCore::Event<bool> PLInput::InputManager::EventOnDetectDevices

Called when device detection has started or stopped

PLCore::Event<Controller*, PLCore::String> PLInput::InputManager::EventInputControllerFound

An input controller has been found. Use this event to for instance connect the input controller to real input devices. Found input controller as first parameter, input semantic as second parameter.

---

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

• InputManager.h