EBus interface used to send motion sensor requests to connected input devices. More...

#include <InputMotionSensorRequestBus.h>

Inherits AZ::EBusTraits.

Public Types
using	BusIdType = InputDeviceId
	EBus Trait: requests can be addressed to a specific InputDeviceId.

Public Member Functions
virtual bool	GetInputChannelEnabled (const InputChannelId &)=0

virtual void	SetInputChannelEnabled (const InputChannelId &, bool)=0

virtual	~InputMotionSensorRequests ()=default
	Default destructor.

Static Public Attributes
static const AZ::EBusAddressPolicy	AddressPolicy = AZ::EBusAddressPolicy::ById

static const AZ::EBusHandlerPolicy	HandlerPolicy = AZ::EBusHandlerPolicy::Single
	EBus Trait: requests should be handled by only one input device connected to each id.

Detailed Description

EBus interface used to send motion sensor requests to connected input devices.

Member Function Documentation

◆ GetInputChannelEnabled()

virtual bool AzFramework::InputMotionSensorRequests::GetInputChannelEnabled ( const InputChannelId & )

pure virtual

Get the enabled state of a specific input channel. The majority of input channels cannot be disabled and are enabled by default, but motion sensor input can be explicitly turned on/off in order to preserve battery and so as to not generate a flood of unneeded events.

Called using either:

EBus<>::Broadcast (any input device can respond to the request)
EBus<>::Event(id) (the given device can respond to the request)

Parameters

[in] channelId Id of the input channel to check whether it is enabled or diabled

Returns: True if the input channel is currently enabled, false otherwise

◆ SetInputChannelEnabled()

virtual void AzFramework::InputMotionSensorRequests::SetInputChannelEnabled	(	const InputChannelId &	,
		bool
	)

pure virtual

Set the enabled state of a specific input channel. The majority of input channels cannot be disabled and are enabled by default, but motion sensor input can be explicitly turned on/off in order to preserve battery and so as to not generate a flood of unneeded events.

Called using either:

EBus<>::Broadcast (any input device can respond to the request)
EBus<>::Event(id) (the given device can respond to the request)

Parameters

[in]	channelId	Id of the input channel to be enabled or diabled
[in]	enabled	Should the input channel be enabled (true) or disabled (false)?

Member Data Documentation

◆ AddressPolicy

const AZ::EBusAddressPolicy AzFramework::InputMotionSensorRequests::AddressPolicy = AZ::EBusAddressPolicy::ById

static

EBus Trait: requests can be addressed to a specific InputDeviceId using EBus<>::Event, which should be handled by only one device that has connected to the bus using that id. Input requests can also be sent using EBus<>::Broadcast, in which case they'll be sent to all input devices that have connected to the input event bus regardless of their id.

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

Code/Framework/AzFramework/AzFramework/Input/Buses/Requests/InputMotionSensorRequestBus.h

Public Types