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

Maps raw input from any raw input source and outputs Pressed, Held, and Released input events. More...

#include <InputEventMap.h>

Inherits StartingPointInput::InputSubComponent, and AzFramework::InputChannelEventListener.

Inherited by StartingPointInput::ThumbstickInputEventMap.

Public Member Functions

 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}")
 
virtual void Activate (const InputEventNotificationId &channel)=0
 
virtual void Deactivate (const InputEventNotificationId &channel)=0
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *reflection)
 

Protected Types

using InputEventType = void(InputEventNotificationBus::Events::*)(float)
 

Protected Member Functions

AZStd::string GetEditorText () const
 
virtual const AZStd::vector< AZStd::string > GetInputDeviceTypes () const
 
virtual const AZStd::vector< AZStd::string > GetInputNamesBySelectedDevice () const
 
AZ::Crc32 OnDeviceSelected ()
 
bool OnInputChannelEventFiltered (const AzFramework::InputChannel &inputChannel) override
 
virtual float CalculateEventValue (const AzFramework::InputChannel &inputChannel) const
 

Protected Attributes

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

Maps raw input from any raw input source and outputs Pressed, Held, and Released input events.

Member Function Documentation

◆ Activate()

void StartingPointInput::InputEventMap::Activate ( const InputEventNotificationId &  channel)
overridevirtual

InputSubComponents will share the life-cycle API's of components. Any Component that contains an InputSubComponent is expected to call these methods in their Activate/Deactivate methods

Implements StartingPointInput::InputSubComponent.

◆ Deactivate()

void StartingPointInput::InputEventMap::Deactivate ( const InputEventNotificationId &  eventNotificationId)
overridevirtual

Implements StartingPointInput::InputSubComponent.

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