Open 3D Engine AzFramework 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 | List of all members
AzFramework::InputChannelAxis1D Class Reference

#include <InputChannelAxis1D.h>

Inherits AzFramework::InputChannelAnalog.

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputChannelAxis1D, AZ::SystemAllocator)
 
 AZ_RTTI (InputChannelAxis1D, "{D869AE1C-0409-4811-A9AD-27CD11C7075A}", InputChannel)
 
 InputChannelAxis1D (const InputChannelId &inputChannelId, const InputDevice &inputDevice)
 
 AZ_DISABLE_COPY_MOVE (InputChannelAxis1D)
 
 ~InputChannelAxis1D () override=default
 Default destructor.
 
- Public Member Functions inherited from AzFramework::InputChannelAnalog
 AZ_CLASS_ALLOCATOR (InputChannelAnalog, AZ::SystemAllocator)
 
 AZ_RTTI (InputChannelAnalog, "{C3E76C92-0D00-45F1-AF03-EFF3F1910A0D}", InputChannel)
 
 InputChannelAnalog (const InputChannelId &inputChannelId, const InputDevice &inputDevice)
 
 AZ_DISABLE_COPY_MOVE (InputChannelAnalog)
 
 ~InputChannelAnalog () override=default
 Default destructor.
 
float GetValue () const override
 
float GetDelta () const override
 
void ResetState () override
 AzFramework::InputChannelRequests::ResetState
 
void SimulateRawInput (float rawValue) override
 AzFramework::InputChannelRequests::SimulateRawInput
 
void ProcessRawInputEvent (float rawValue)
 
- Public Member Functions inherited from AzFramework::InputChannel
 AZ_CLASS_ALLOCATOR (InputChannel, AZ::SystemAllocator)
 
 AZ_RTTI (InputChannel, "{1C88625D-D297-4A1C-AE07-E17F88D138F3}")
 
 InputChannel (const InputChannelId &inputChannelId, const InputDevice &inputDevice)
 
 AZ_DISABLE_COPY_MOVE (InputChannel)
 
 ~InputChannel () override
 Destructor.
 
const InputChannel * GetInputChannel () const final
 AzFramework::InputChannelRequests::GetInputChannel
 
const InputChannelId & GetInputChannelId () const
 
const InputDevice & GetInputDevice () const
 
State GetState () const
 
bool IsActive () const
 
virtual float GetValue () const
 
virtual float GetDelta () const
 
virtual const CustomData * GetCustomData () const
 
template<class CustomDataType >
const CustomDataType * GetCustomData () const
 
bool UpdateState (bool isChannelActive)
 
void ResetState () override
 AzFramework::InputChannelRequests::ResetState
 
bool IsStateIdle () const
 
bool IsStateBegan () const
 
bool IsStateUpdated () const
 
bool IsStateEnded () const
 

Additional Inherited Members

- Public Types inherited from AzFramework::InputChannel
enum class  State { Idle , Began , Updated , Ended }
 State of the input channel (not all channels will go through all states) More...
 
using SharedPositionData2D = AZStd::shared_ptr< InputChannel::PositionData2D >
 Alias for verbose shared_ptr class.
 
- Static Public Member Functions inherited from AzFramework::InputChannel
static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

Class for input channels that emit one dimensional axis input values. Example: game-pad thumb-stick x or y

Constructor & Destructor Documentation

◆ InputChannelAxis1D()

AzFramework::InputChannelAxis1D::InputChannelAxis1D ( const InputChannelId &  inputChannelId,
const InputDevice &  inputDevice 
)
explicit

Constructor

Parameters
[in]inputChannelIdId of the input channel being constructed
[in]inputDeviceInput device that owns the input channel
The documentation for this class was generated from the following file: