AzFramework::InputDeviceTouch::Implementation Class Reference

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

#include <InputDeviceTouch.h>

Classes
struct	RawTouchEvent
	Platform agnostic representation of a raw touch event. More...

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

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

Protected Types
using	RawTouchEventQueueByIdMap = AZStd::unordered_map< InputChannelId, AZStd::vector< RawTouchEvent > >
	Alias for verbose container class.

Protected Member Functions
void	QueueRawTouchEvent (const RawTouchEvent &rawTouchEvent)
void	ProcessRawEventQueues ()
void	ResetInputChannelStates ()
	Reset the state of all this input device's associated input channels.

Detailed Description

Base class for platform specific implementations of touch input devices.

Constructor & Destructor Documentation

Implementation()

AzFramework::InputDeviceTouch::Implementation::Implementation

(

InputDeviceTouch &

inputDevice

)

Constructor

Parameters

[in]

inputDevice

Reference to the input device being implemented

Member Function Documentation

Create()

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

static

Default factory create function

Parameters

[in]

inputDevice

Reference to the input device being implemented

GetAssignedLocalUserId()

virtual LocalUserId AzFramework::InputDeviceTouch::Implementation::GetAssignedLocalUserId ( ) const

virtual

Access to the input device's currently assigned local user id

Returns

Id of the local user currently assigned to the input device

IsConnected()

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

pure virtual

Query the connected state of the input device

Returns

True if the input device is currently connected, false otherwise

ProcessRawEventQueues()

void AzFramework::InputDeviceTouch::Implementation::ProcessRawEventQueues ( )

protected

Process raw input events that have been queued since the last call to this function. This function is not thread safe, and so should only be called from the main thread.

QueueRawTouchEvent()

void AzFramework::InputDeviceTouch::Implementation::QueueRawTouchEvent ( const RawTouchEvent &  rawTouchEvent )

protected

Queue raw touch events to be processed in the next call to ProcessRawEventQueues. This function is not thread safe and so should only be called from the main thread.

Parameters

[in]

rawTouchEvent

The raw touch event

---

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

• Code/Framework/AzFramework/AzFramework/Input/Devices/Touch/InputDeviceTouch.h