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

#include <InputChannelDigitalWithSharedPosition2D.h>

Inherits AzFramework::InputChannelDigital.

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputChannelDigitalWithSharedPosition2D, AZ::SystemAllocator)
 
 AZ_RTTI (InputChannelDigitalWithSharedPosition2D, "{EFCEC2F4-A81F-4218-A878-1D7676FB1FC6}", InputChannel)
 
 InputChannelDigitalWithSharedPosition2D (const AzFramework::InputChannelId &inputChannelId, const InputDevice &inputDevice, const SharedPositionData2D &sharedPositionData)
 
 AZ_DISABLE_COPY_MOVE (InputChannelDigitalWithSharedPosition2D)
 
 ~InputChannelDigitalWithSharedPosition2D () override=default
 Default destructor.
 
const AzFramework::InputChannel::CustomData * GetCustomData () const override
 
- Public Member Functions inherited from AzFramework::InputChannelDigital
 AZ_CLASS_ALLOCATOR (InputChannelDigital, AZ::SystemAllocator)
 
 AZ_RTTI (InputChannelDigital, "{07BD463B-0E1C-47B5-849D-3C09F9D1B468}", InputChannel)
 
 InputChannelDigital (const InputChannelId &inputChannelId, const InputDevice &inputDevice)
 
 AZ_DISABLE_COPY_MOVE (InputChannelDigital)
 
 ~InputChannelDigital () override=default
 Default destructor.
 
float GetValue () const override
 
float GetDelta () const override
 
void SimulateRawInput (float rawValue) override
 AzFramework::InputChannelRequests::SimulateRawInput
 
void ProcessRawInputEvent (bool 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
 
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 digital input value and share a position. Examples: mouse button

Constructor & Destructor Documentation

◆ InputChannelDigitalWithSharedPosition2D()

AzFramework::InputChannelDigitalWithSharedPosition2D::InputChannelDigitalWithSharedPosition2D ( const AzFramework::InputChannelId &  inputChannelId,
const InputDevice &  inputDevice,
const SharedPositionData2D &  sharedPositionData 
)
explicit

Constructor

Parameters
[in]inputChannelIdId of the input channel being constructed
[in]inputDeviceInput device that owns the input channel
[in]sharedPositionDataShared ptr to the common position data

Member Function Documentation

◆ GetCustomData()

const AzFramework::InputChannel::CustomData * AzFramework::InputChannelDigitalWithSharedPosition2D::GetCustomData ( ) const
overridevirtual

Access to the shared position data

Returns
Pointer to the shared position data

Reimplemented from AzFramework::InputChannel.

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