Open 3D Engine StartingPointInput 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 | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
StartingPointInput::ThumbstickInputEventMap Class Reference

#include <InputEventMap.h>

Inherits StartingPointInput::InputEventMap.

Public Member Functions

 AZ_RTTI (ThumbstickInputEventMap, "{4881FA7C-0667-476C-8C77-4DBB6C69F646}", InputEventMap)
 
- Public Member Functions inherited from StartingPointInput::InputEventMap
 AZ_RTTI (InputEventMap, "{A14EA0A3-F053-469D-840E-A70002F51384}", InputSubComponent)
 
void Activate (const InputEventNotificationId &eventNotificationId) override
 
void Deactivate (const InputEventNotificationId &eventNotificationId) override
 
- Public Member Functions inherited from StartingPointInput::InputSubComponent
 AZ_RTTI (InputSubComponent, "{3D0F14F8-AE29-4ECC-BC88-26B8F8168398}")
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *reflection)
 
- Static Public Member Functions inherited from StartingPointInput::InputEventMap
static void Reflect (AZ::ReflectContext *reflection)
 

Protected Types

enum class  OutputAxis { X , Y }
 
- Protected Types inherited from StartingPointInput::InputEventMap
using InputEventType = void(InputEventNotificationBus::Events::*)(float)
 

Protected Member Functions

AZStd::string GetEditorText () const
 
const AZStd::vector< AZStd::string > GetInputDeviceTypes () const override
 
const AZStd::vector< AZStd::string > GetInputNamesBySelectedDevice () const override
 
bool OnInputChannelEventFiltered (const AzFramework::InputChannel &inputChannel) override
 
float CalculateEventValue (const AzFramework::InputChannel &inputChannel) const override
 
- Protected Member Functions inherited from StartingPointInput::InputEventMap
AZStd::string GetEditorText () const
 
AZ::Crc32 OnDeviceSelected ()
 
bool OnInputChannelEventFiltered (const AzFramework::InputChannel &inputChannel) override
 

Static Protected Member Functions

static AZ::Vector2 ApplyDeadZonesAndSensitivity (const AZ::Vector2 &inputValues, float innerDeadZone, float outerDeadZone, float axisDeadZone, float sensitivityExponent)
 

Protected Attributes

const AzFramework::InputDeviceId * m_wasLastPressedByInputDeviceId = nullptr
 
float m_innerDeadZoneRadius = 0.0f
 
float m_outerDeadZoneRadius = 1.0f
 
float m_axisDeadZoneValue = 0.0f
 
float m_sensitivityExponent = 1.0f
 
OutputAxis m_outputAxis = OutputAxis::X
 
- Protected Attributes inherited from StartingPointInput::InputEventMap
InputEventNotificationId m_outgoingBusId
 
bool m_wasPressed = false
 
float m_eventValueMultiplier = 1.f
 
AZStd::string m_inputName = ""
 
AZStd::string m_inputDeviceType = ""
 
float m_deadZone = 0.0f
 

Detailed Description

ThumbstickInput handles raw input from thumbstick sources, applies any custom dead-zone or sensitivity curve calculations, and then outputs Pressed, Held, and Released input events for the specified axis

Member Function Documentation

◆ CalculateEventValue()

float StartingPointInput::ThumbstickInputEventMap::CalculateEventValue ( const AzFramework::InputChannel &  inputChannel) const
overrideprotectedvirtual

Reimplemented from StartingPointInput::InputEventMap.

◆ GetInputDeviceTypes()

const AZStd::vector< AZStd::string > StartingPointInput::ThumbstickInputEventMap::GetInputDeviceTypes ( ) const
overrideprotectedvirtual

Reimplemented from StartingPointInput::InputEventMap.

◆ GetInputNamesBySelectedDevice()

const AZStd::vector< AZStd::string > StartingPointInput::ThumbstickInputEventMap::GetInputNamesBySelectedDevice ( ) const
overrideprotectedvirtual

Reimplemented from StartingPointInput::InputEventMap.

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