Open 3D Engine Gestures Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Gestures::InputChannelGestureDrag Class Reference

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

#include <InputChannelGestureDrag.h>

Inherits Gestures::InputChannelGesture, and Gestures::RecognizerDrag.

Classes

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

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputChannelGestureDrag, AZ::SystemAllocator)
 
 AZ_RTTI (InputChannelGestureDrag, "{A860D040-5931-4232-915E-7B41E747853F}", InputChannel)
 
 InputChannelGestureDrag (const AzFramework::InputChannelId &inputChannelId, const AzFramework::InputDevice &inputDevice, const Config &config)
 
 AZ_DISABLE_COPY_MOVE (InputChannelGestureDrag)
 
 ~InputChannelGestureDrag () 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::RecognizerDrag
 AZ_CLASS_ALLOCATOR (RecognizerDrag, AZ::SystemAllocator)
 
 AZ_RTTI (RecognizerDrag, "{B244C54C-1F5C-420E-8F47-025AFEB7A499}", RecognizerContinuous)
 
 RecognizerDrag (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
 
ConfigGetConfig ()
 
const ConfigGetConfig () const
 
void SetConfig (const Config &config)
 
AZ::Vector2 GetStartPosition () const
 
AZ::Vector2 GetCurrentPosition () const
 
AZ::Vector2 GetDelta () const
 
float GetDistance () 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::RecognizerDrag
static float GetDefaultMinSecondsHeld ()
 
static float GetDefaultMinPixelsMoved ()
 
static uint32_t GetDefaultPointerIndex ()
 
static int32_t GetDefaultPriority ()
 
static const ConfigGetDefaultConfig ()
 
- 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 drag gestures.

Constructor & Destructor Documentation

◆ InputChannelGestureDrag()

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

Constructor

Parameters
[in]inputChannelIdId of the input channel being constructed
[in]inputDeviceInput device that owns the input channel
[in]configThe configuration used to setup the gesture recognizer base class

Member Function Documentation

◆ OnContinuousGestureEnded()

void Gestures::InputChannelGestureDrag::OnContinuousGestureEnded ( )
overrideprotectedvirtual

◆ OnContinuousGestureInitiated()

void Gestures::InputChannelGestureDrag::OnContinuousGestureInitiated ( )
overrideprotectedvirtual

◆ OnContinuousGestureUpdated()

void Gestures::InputChannelGestureDrag::OnContinuousGestureUpdated ( )
overrideprotectedvirtual

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