Open 3D Engine Gestures Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Member Functions | List of all members
Gestures::RecognizerContinuous Class Referenceabstract

Base class for all continuous gesture recognizers. More...

#include <IGestureRecognizer.h>

Inherits Gestures::IRecognizer.

Inherited by Gestures::RecognizerDrag, Gestures::RecognizerHold, Gestures::RecognizerPinch, and Gestures::RecognizerRotate.

Public Member Functions

 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

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

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

Detailed Description

Base class for all continuous gesture recognizers.

Member Function Documentation

◆ OnContinuousGestureEnded()

virtual void Gestures::RecognizerContinuous::OnContinuousGestureEnded ( )
protectedpure virtual

Override to be notified when the continuous gesture is ended.

Implemented in Gestures::InputChannelGestureDrag, Gestures::InputChannelGestureHold, Gestures::InputChannelGesturePinch, and Gestures::InputChannelGestureRotate.

◆ OnContinuousGestureInitiated()

virtual void Gestures::RecognizerContinuous::OnContinuousGestureInitiated ( )
protectedpure virtual

Override to be notified when the continuous gesture is initiated.

Implemented in Gestures::InputChannelGestureDrag, Gestures::InputChannelGestureHold, Gestures::InputChannelGesturePinch, and Gestures::InputChannelGestureRotate.

◆ OnContinuousGestureUpdated()

virtual void Gestures::RecognizerContinuous::OnContinuousGestureUpdated ( )
protectedpure virtual

Override to be notified when the continuous gesture is updated.

Implemented in Gestures::InputChannelGestureDrag, Gestures::InputChannelGestureHold, Gestures::InputChannelGesturePinch, and Gestures::InputChannelGestureRotate.

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