Open 3D Engine Gestures Gem API Reference 25.10.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::RecognizerDiscrete Class Referenceabstract

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

#include <IGestureRecognizer.h>

Inherits Gestures::IRecognizer.

Inherited by Gestures::RecognizerClickOrTap, and Gestures::RecognizerSwipe.

Public Member Functions

 AZ_CLASS_ALLOCATOR (RecognizerDiscrete, AZ::SystemAllocator)
 
 AZ_RTTI (RecognizerDiscrete, "{51258910-62B3-4830-AF7B-9DA3AD3585CC}", 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 OnDiscreteGestureRecognized ()=0
 Override to be notified when the discrete gesture is recognized.
 
- 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 discrete gesture recognizers.

Member Function Documentation

◆ OnDiscreteGestureRecognized()

virtual void Gestures::RecognizerDiscrete::OnDiscreteGestureRecognized ( )
protectedpure virtual

Override to be notified when the discrete gesture is recognized.

Implemented in Gestures::InputChannelGestureClickOrTap, and Gestures::InputChannelGestureSwipe.

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