Input channel that recognizes continuous hold gestures. More...

#include <InputChannelGestureHold.h>

Inherits Gestures::InputChannelGesture, and Gestures::RecognizerHold.

Classes
struct	TypeAndConfig
	The gesture configuration values that are exposed to the editor. More...

Public Member Functions
	AZ_CLASS_ALLOCATOR (InputChannelGestureHold, AZ::SystemAllocator)

	AZ_RTTI (InputChannelGestureHold, "{FF1803B2-EF52-453E-B097-23B104D4AAA6}", InputChannel)

	InputChannelGestureHold (const AzFramework::InputChannelId &inputChannelId, const AzFramework::InputDevice &inputDevice, const Config &config)

	AZ_DISABLE_COPY_MOVE (InputChannelGestureHold)

	~InputChannelGestureHold () override
	Destructor.

Public Member Functions inherited from Gestures::InputChannelGesture
	AZ_CLASS_ALLOCATOR (InputChannelGesture, AZ::SystemAllocator)

	AZ_RTTI (InputChannelGesture, "{A26F1958-7AF7-48AB-87AA-12AD76088BCA}", InputChannel)

	InputChannelGesture (const AzFramework::InputChannelId &inputChannelId, const AzFramework::InputDevice &inputDevice)

	AZ_DISABLE_COPY_MOVE (InputChannelGesture)

	~InputChannelGesture () override=default
	Default destructor.

Public Member Functions inherited from Gestures::RecognizerHold
	AZ_CLASS_ALLOCATOR (RecognizerHold, AZ::SystemAllocator)

	AZ_RTTI (RecognizerHold, "{7FC9AB8D-0A94-40A6-8FE0-84C752D786DC}", RecognizerContinuous)

	RecognizerHold (const Config &config=GetDefaultConfig())

int32_t	GetPriority () const override

bool	OnPressedEvent (const AZ::Vector2 &screenPosition, uint32_t pointerIndex) override

bool	OnDownEvent (const AZ::Vector2 &screenPosition, uint32_t pointerIndex) override

bool	OnReleasedEvent (const AZ::Vector2 &screenPosition, uint32_t pointerIndex) override

Config &	GetConfig ()

const Config &	GetConfig () const

void	SetConfig (const Config &config)

AZ::Vector2	GetStartPosition () const

AZ::Vector2	GetCurrentPosition () const

float	GetDuration () const

Public Member Functions inherited from Gestures::RecognizerContinuous
	AZ_CLASS_ALLOCATOR (RecognizerContinuous, AZ::SystemAllocator)

	AZ_RTTI (RecognizerContinuous, "{A8B16552-E1F3-4469-BEB8-5D209554924E}", IRecognizer)

Public Member Functions inherited from Gestures::IRecognizer
	AZ_CLASS_ALLOCATOR (IRecognizer, AZ::SystemAllocator)

	AZ_RTTI (IRecognizer, "{C3E00298-1953-465F-A360-EBC10B62BFE8}", CustomData)

void	Enable ()
	Enable this gesture recognizer.

void	Disable ()
	Disable this gesture recognizer.

AZ::s32	GetPriority () const override
	AzFramework::InputChannelNotifications::GetPriority

void	OnInputChannelEvent (const AzFramework::InputChannel &inputChannel, bool &o_hasBeenConsumed) override
	AzFramework::InputChannelNotifications::OnInputChannelEvent

virtual bool	OnPressedEvent (const AZ::Vector2 &screenPositionPixels, uint32_t pointerIndex)=0

virtual bool	OnDownEvent (const AZ::Vector2 &screenPositionPixels, uint32_t pointerIndex)=0

virtual bool	OnReleasedEvent (const AZ::Vector2 &screenPositionPixels, uint32_t pointerIndex)=0

Protected Member Functions
float	GetValue () const override
	AzFramework::InputChannel::GetValue

const InputChannel::CustomData *	GetCustomData () const override
	AzFramework::InputChannel::GetCustomData

void	OnContinuousGestureInitiated () override
	Gestures::RecognizerContinuous::OnContinuousGestureInitiated

void	OnContinuousGestureUpdated () override
	Gestures::RecognizerContinuous::OnContinuousGestureUpdated

void	OnContinuousGestureEnded () override
	Gestures::RecognizerContinuous::OnContinuousGestureEnded

virtual void	OnContinuousGestureInitiated ()=0
	Override to be notified when the continuous gesture is initiated.

virtual void	OnContinuousGestureUpdated ()=0
	Override to be notified when the continuous gesture is updated.

virtual void	OnContinuousGestureEnded ()=0
	Override to be notified when the continuous gesture is ended.

Protected Member Functions inherited from Gestures::IRecognizer
uint32_t	GetGesturePointerIndex (const AzFramework::InputChannel &inputChannel)

void	UpdateNormalizedPositionAndDeltaFromScreenPosition (const AZ::Vector2 &screenPositionPixels)

Additional Inherited Members
Static Public Member Functions inherited from Gestures::RecognizerHold
static float	GetDefaultMinSecondsHeld ()

static float	GetDefaultMaxPixelsMoved ()

static uint32_t	GetDefaultPointerIndex ()

static int32_t	GetDefaultPriority ()

static const Config &	GetDefaultConfig ()

Protected Attributes inherited from Gestures::IRecognizer
const uint32_t	INVALID_GESTURE_POINTER_INDEX = static_cast<uint32_t>(-1)

Detailed Description

Input channel that recognizes continuous hold gestures.

Constructor & Destructor Documentation

◆ InputChannelGestureHold()

Gestures::InputChannelGestureHold::InputChannelGestureHold	(	const AzFramework::InputChannelId &	inputChannelId,
		const AzFramework::InputDevice &	inputDevice,
		const Config &	config
	)

explicit

Constructor

Parameters

[in]	inputChannelId	Id of the input channel being constructed
[in]	inputDevice	Input device that owns the input channel
[in]	config	The configuration used to setup the gesture recognizer base class