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

#include <InputDeviceGestures.h>

Inherits AzFramework::InputDevice.

Classes

struct  Gesture
 All the input channel ids that identify standard gesture input. More...
 

Public Types

using ConfigsByNameMap = AZStd::unordered_map< AZStd::string, InputChannelGesture::Type * >
 Alias for verbose container class.
 

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputDeviceGestures, AZ::SystemAllocator)
 
 AZ_RTTI (InputDeviceGestures, "{4E6EB405-9C01-418E-96F2-0E99A2B61C45}", InputDevice)
 
 InputDeviceGestures (const ConfigsByNameMap &gestureConfigsByName)
 
 InputDeviceGestures (const InputDeviceGestures &)=delete
 
 ~InputDeviceGestures () override
 Destructor.
 
const InputChannelByIdMap & GetInputChannelsById () const override
 AzFramework::InputDevice::GetInputChannelsById
 
bool IsSupported () const override
 AzFramework::InputDevice::IsSupported
 
bool IsConnected () const override
 AzFramework::InputDevice::IsConnected
 
void TickInputDevice () override
 AzFramework::InputDeviceRequests::TickInputDevice
 

Static Public Member Functions

static bool IsGesturesDevice (const AzFramework::InputDeviceId &inputDeviceId)
 
static void Reflect (AZ::ReflectContext *context)
 

Static Public Attributes

static const AzFramework::InputDeviceId Id
 The id used to identify the primary gestures input device.
 

Detailed Description

Implementation for an input device listens for mouse and touch input, then interprets it as common gestures such as multi-click/tap, drag, hold, pinch, rotate, and swipe.

Constructor & Destructor Documentation

◆ InputDeviceGestures()

Gestures::InputDeviceGestures::InputDeviceGestures ( const ConfigsByNameMap &  gestureConfigsByName)
explicit

Constructor

Parameters
[in]gestureConfigsByNameMap of gesture name/config pairs used to create channels

Member Function Documentation

◆ IsGesturesDevice()

static bool Gestures::InputDeviceGestures::IsGesturesDevice ( const AzFramework::InputDeviceId &  inputDeviceId)
static

Check whether an input device id identifies the gestures device (regardless of index)

Parameters
[in]inputDeviceIdThe input device id to check
Returns
True if the input device id identifies the gestures device, false otherwise
The documentation for this class was generated from the following file: