#include <InputChannelDeltaWithSharedPosition2D.h>

Inherits AzFramework::InputChannelDelta.

Public Member Functions
	AZ_CLASS_ALLOCATOR (InputChannelDeltaWithSharedPosition2D, AZ::SystemAllocator)

	AZ_RTTI (InputChannelDeltaWithSharedPosition2D, "{F7EC8D6F-DC27-4CDF-80F4-EFA7DCC33837}", InputChannel)

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

	AZ_DISABLE_COPY_MOVE (InputChannelDeltaWithSharedPosition2D)

	~InputChannelDeltaWithSharedPosition2D () override=default
	Default destructor.

const AzFramework::InputChannel::CustomData *	GetCustomData () const override

Public Member Functions inherited from AzFramework::InputChannelDelta
	AZ_CLASS_ALLOCATOR (InputChannelDelta, AZ::SystemAllocator)

	AZ_RTTI (InputChannelDelta, "{3AE8E55C-08E2-4258-B42E-3C3B6304B5D2}", InputChannel)

	InputChannelDelta (const InputChannelId &inputChannelId, const InputDevice &inputDevice)

	AZ_DISABLE_COPY_MOVE (InputChannelDelta)

	~InputChannelDelta () 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 delta input values and share a position. Examples: mouse movement

Constructor & Destructor Documentation

◆ InputChannelDeltaWithSharedPosition2D()

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

explicit

Constructor

Parameters

[in]	inputChannelId	Id of the input channel being constructed
[in]	inputDevice	Input device that owns the input channel
[in]	sharedPositionData	Shared ptr to the common position data

Member Function Documentation

◆ GetCustomData()

const AzFramework::InputChannel::CustomData * AzFramework::InputChannelDeltaWithSharedPosition2D::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:

Code/Framework/AzFramework/AzFramework/Input/Channels/InputChannelDeltaWithSharedPosition2D.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InputChannelDeltaWithSharedPosition2D()

Member Function Documentation

◆ GetCustomData()