AzFramework::InputDeviceMotion::Implementation Class Reference

Base class for platform specific implementations of motion input devices. More...

#include <InputDeviceMotion.h>

Public Member Functions
	AZ_CLASS_ALLOCATOR (Implementation, AZ::SystemAllocator)
	Implementation (InputDeviceMotion &inputDevice)
	AZ_DISABLE_COPY_MOVE (Implementation)
virtual	~Implementation ()
	Destructor.
virtual bool	IsConnected () const =0
virtual void	TickInputDevice ()=0
	Tick/update the input device to broadcast all input events since the last frame.
virtual void	RefreshMotionSensors (const InputChannelIdSet &enabledChannelIds)=0

Static Public Member Functions
static Implementation *	Create (InputDeviceMotion &inputDevice)

Protected Member Functions
void	ProcessAccelerationData (const InputChannelId &channelId, const AZ::Vector3 &data)
void	ProcessRotationRateData (const InputChannelId &channelId, const AZ::Vector3 &data)
void	ProcessMagneticFieldData (const InputChannelId &channelId, const AZ::Vector3 &data)
void	ProcessOrientationData (const InputChannelId &channelId, const AZ::Quaternion &data)
void	ResetInputChannelStates ()
	Reset the state of all this input device's associated input channels.

Detailed Description

Base class for platform specific implementations of motion input devices.

Constructor & Destructor Documentation

Implementation()

AzFramework::InputDeviceMotion::Implementation::Implementation

(

InputDeviceMotion &

inputDevice

)

Constructor

Parameters

[in]

inputDevice

Reference to the input device being implemented

Member Function Documentation

Create()

static Implementation * AzFramework::InputDeviceMotion::Implementation::Create ( InputDeviceMotion &  inputDevice )

static

Default factory create function

Parameters

[in]

inputDevice

Reference to the input device being implemented

IsConnected()

virtual bool AzFramework::InputDeviceMotion::Implementation::IsConnected ( ) const

pure virtual

Query the connected state of the input device

Returns

True if the input device is currently connected, false otherwise

ProcessAccelerationData()

void AzFramework::InputDeviceMotion::Implementation::ProcessAccelerationData ( const InputChannelId &  channelId, const AZ::Vector3 &  data  )

protected

Process raw motion sensor data that has been obtained during since the last frame This function is not thread safe, and so should only be called from the main thread.

Parameters

[in]	channelId	The input channel id
[in]	data	The raw motion sensor data

ProcessMagneticFieldData()

void AzFramework::InputDeviceMotion::Implementation::ProcessMagneticFieldData ( const InputChannelId &  channelId, const AZ::Vector3 &  data  )

protected

Process raw motion sensor data that has been obtained during since the last frame This function is not thread safe, and so should only be called from the main thread.

Parameters

[in]	channelId	The input channel id
[in]	data	The raw motion sensor data

ProcessOrientationData()

void AzFramework::InputDeviceMotion::Implementation::ProcessOrientationData ( const InputChannelId &  channelId, const AZ::Quaternion &  data  )

protected

Process raw motion sensor data that has been obtained during since the last frame This function is not thread safe, and so should only be called from the main thread.

Parameters

[in]	channelId	The input channel id
[in]	data	The raw motion sensor data

ProcessRotationRateData()

void AzFramework::InputDeviceMotion::Implementation::ProcessRotationRateData ( const InputChannelId &  channelId, const AZ::Vector3 &  data  )

protected

Process raw motion sensor data that has been obtained during since the last frame This function is not thread safe, and so should only be called from the main thread.

Parameters

[in]	channelId	The input channel id
[in]	data	The raw motion sensor data

RefreshMotionSensors()

virtual void AzFramework::InputDeviceMotion::Implementation::RefreshMotionSensors ( const InputChannelIdSet &  enabledChannelIds )

pure virtual

Refresh the currently enabled motion sensors based on the channels that are enabled

Parameters

[in]

enabledChannelIds

Set of motion input channel ids that should be enabled

---

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

• Code/Framework/AzFramework/AzFramework/Input/Devices/Motion/InputDeviceMotion.h