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.
Classes | Public Member Functions | Static Public Member Functions | List of all members
Gestures::RecognizerHold Class Reference

Inherits Gestures::RecognizerContinuous.

Inherited by Gestures::InputChannelGestureHold.

Classes

struct  Config
 

Public Member Functions

 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
 

Static Public Member Functions

static float GetDefaultMinSecondsHeld ()
 
static float GetDefaultMaxPixelsMoved ()
 
static uint32_t GetDefaultPointerIndex ()
 
static int32_t GetDefaultPriority ()
 
static const Config & GetDefaultConfig ()
 

Additional Inherited Members

- Protected Member Functions inherited from Gestures::RecognizerContinuous
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)
 
- Protected Attributes inherited from Gestures::IRecognizer
const uint32_t INVALID_GESTURE_POINTER_INDEX = static_cast<uint32_t>(-1)
 

Member Function Documentation

◆ OnDownEvent()

bool Gestures::RecognizerHold::OnDownEvent ( const AZ::Vector2 &  screenPositionPixels,
uint32_t  pointerIndex 
)
inlineoverridevirtual

Override to be notified each frame a mouse button or finger on a touch screen remains pressed, unless the input event was consumed by a higher priority gesture recognizer.

Parameters
[in]screenPositionPixelsThe screen position (in pixels) of the input event.
[in]pointerIndexThe pointer index of the input event.
Returns
True to consume the underlying input event (preventing it from being sent on to other lower-priority gesture recognizers or input listeners), or false otherwise.

Implements Gestures::IRecognizer.

◆ OnPressedEvent()

bool Gestures::RecognizerHold::OnPressedEvent ( const AZ::Vector2 &  screenPositionPixels,
uint32_t  pointerIndex 
)
inlineoverridevirtual

Override to be notified when a mouse button or finger on a touch screen is initially pressed, unless the input event was consumed by a higher priority gesture recognizer.

Parameters
[in]screenPositionPixelsThe screen position (in pixels) of the input event.
[in]pointerIndexThe pointer index of the input event.
Returns
True to consume the underlying input event (preventing it from being sent on to other lower-priority gesture recognizers or input listeners), or false otherwise.

Implements Gestures::IRecognizer.

◆ OnReleasedEvent()

bool Gestures::RecognizerHold::OnReleasedEvent ( const AZ::Vector2 &  screenPositionPixels,
uint32_t  pointerIndex 
)
inlineoverridevirtual

Override to be notified when a pressed mouse button or finger on a touch screen becomes released, unless the input event was consumed by a higher priority gesture recognizer.

Parameters
[in]screenPositionPixelsThe screen position (in pixels) of the input event.
[in]pointerIndexThe pointer index of the input event.
Returns
True to consume the underlying input event (preventing it from being sent on to other lower-priority gesture recognizers or input listeners), or false otherwise.

Implements Gestures::IRecognizer.

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