Murl Engine Lua Addon API  Version 1.0 beta
Murl.Input.IDeviceHandler

The IDeviceHandler interface.

The device handler creates and registers all input device instances. Devices are used by the platform which post's the current device states. The states are processed by the registered devices each logic tick before executing the logic processors Logic::IEngineProcessor::ProcessTick().


Table members

Methods


Init(appConfig)

Initialize the device handler.

Boolean Init(Murl.IAppConfiguration appConfig)

Parameters
appConfigThe application configuration object.
Returns
Boolean true if successful.

DeInit()

Deinitialize the device handler.

Boolean DeInit()

Returns
Boolean true if successful.

UpdateDevices()

Update all registered devices. The update is executed in the logic thread context each logic tick before executing the logic processors Logic::IEngineProcessor::ProcessTick().

Boolean UpdateDevices()

Returns
Boolean true if successful.

ConfigChanged(appConfig)

Notification of changed configuration. The notification is executed in the engine thread context if any configuration item has changed.

ConfigChanged(Murl.IAppConfiguration appConfig)

Parameters
appConfigThe application configuration object.

BeginLogicUpdate(touchableHandler)

Begin updating the touchable handler. The update is executed in the logic thread context each logic tick after executing the logic processors Logic::IEngineProcessor::ProcessTick() and before the graph's logic-traversal.

Boolean BeginLogicUpdate(Murl.Input.ITouchableHandler touchableHandler)

Parameters
touchableHandlerThe touchable handler object.
Returns
Boolean true if successful.

EndLogicUpdate(touchableHandler)

End updating the touchable handler. The update is executed in the logic thread context each logic tick after executing UpdateDevices() and before executing the logic processors Logic::IEngineProcessor::ProcessTick().

Boolean EndLogicUpdate(Murl.Input.ITouchableHandler touchableHandler)

Parameters
touchableHandlerThe touchable handler object.
Returns
Boolean true if successful.

GetAccelerometerDevice(index)

Get a registered accelerometer device object.

Murl.Input.IAccelerometerDevice GetAccelerometerDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IAccelerometerDevice The accelerometer device object or null if the index is out of range.

GetGyroscopeDevice(index)

Get a registered gyroscope device object.

Murl.Input.IGyroscopeDevice GetGyroscopeDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IGyroscopeDevice The gyroscope device object or null if index the is out of range.

GetHeadingDevice(index)

Get a registered heading device object.

Murl.Input.IHeadingDevice GetHeadingDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IHeadingDevice The heading device object or null if index the is out of range.

GetLocationDevice(index)

Get a registered location device object.

Murl.Input.ILocationDevice GetLocationDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.ILocationDevice The location device object or null if index the is out of range.

GetNumberOfGameControllerDevices()

Get the number of registered game controller devices.

Integer GetNumberOfGameControllerDevices()

Returns
Integer The number of registered game controller devices.

GetGameControllerDevice(index)

Get a registered mutable game controller device object. A valid device index is [0 .. GetNumberOfGameControllerDevices() - 1].

Murl.Input.IGameControllerDevice GetGameControllerDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IGameControllerDevice The mutable game controller device object or null if index the is out of range.

GetKeyboardDevice(index)

Get a registered keyboard device object.

Murl.Input.IKeyboardDevice GetKeyboardDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IKeyboardDevice The keyboard device object or null if index the is out of range.

GetMotionDevice(index)

Get a registered motion device object.

Murl.Input.IMotionDevice GetMotionDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IMotionDevice The motion device object or null if index the is out of range.

GetMouseDevice(index)

Get a registered mouse device object.

Murl.Input.IMouseDevice GetMouseDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IMouseDevice The mouse device object or null if index the is out of range.

GetOrientationDevice(index)

Get a registered orientation device object.

Murl.Input.IOrientationDevice GetOrientationDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IOrientationDevice The orientation device object or null if index the is out of range.

GetRawButtonDevice(index)

Get a registered raw-button device object.

Murl.Input.IRawButtonDevice GetRawButtonDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IRawButtonDevice The raw-button device object or null if index the is out of range.

GetRawKeyboardDevice(index)

Get a registered raw-keyboard device object.

Murl.Input.IRawKeyboardDevice GetRawKeyboardDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IRawKeyboardDevice The raw-keyboard device object or null if index the is out of range.

GetRawMouseDevice(index)

Get a registered raw-mouse device object.

Murl.Input.IRawMouseDevice GetRawMouseDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.IRawMouseDevice The raw-mouse device object or null if index the is out of range.

GetNumberOfTouchScreenDevices()

Get the number of registered touch-screen devices.

Integer GetNumberOfTouchScreenDevices()

Returns
Integer The number of registered touch-screen devices.

GetTouchScreenDevice(index)

Get a registered touch-screen device object. A valid device index is [0 .. GetNumberOfTouchScreenDevices() - 1].

Murl.Input.ITouchScreenDevice GetTouchScreenDevice(Integer index)

Parameters
indexThe zero-based index of the device.
Returns
Murl.Input.ITouchScreenDevice The touch-screen device object or null if index the is out of range.

GetVirtualMouse()

Get the virtual-mouse device object.

Murl.IVirtualMouse GetVirtualMouse()

Returns
Murl.IVirtualMouse The virtual-mouse device object.