AzFramework::InputChannelEventSink Class Reference

Class that consumes all input event that pass the specified filter. More...

#include <InputChannelEventSink.h>

Inherits InputChannelNotificationBus::Handler.

Public Member Functions
	InputChannelEventSink ()
	Constructor.
	InputChannelEventSink (AZStd::shared_ptr< InputChannelEventFilter > filter)
	AZ_DEFAULT_COPY (InputChannelEventSink)
	~InputChannelEventSink () override
	Destructor.
AZ::s32	GetPriority () const override
	AzFramework::InputChannelNotifications::GetPriority
void	SetFilter (AZStd::shared_ptr< InputChannelEventFilter > filter)

Protected Member Functions
void	OnInputChannelEvent (const InputChannel &inputChannel, bool &o_hasBeenConsumed) final
	AzFramework::InputChannelNotifications::OnInputChannelEvent

Detailed Description

Class that consumes all input event that pass the specified filter.

Constructor & Destructor Documentation

InputChannelEventSink()

AzFramework::InputChannelEventSink::InputChannelEventSink ( AZStd::shared_ptr< InputChannelEventFilter >  filter )

explicit

Constructor

Parameters

[in]

filter

The filter used to determine whether an inut event should be consumed

Member Function Documentation

SetFilter()

void AzFramework::InputChannelEventSink::SetFilter

(

AZStd::shared_ptr< InputChannelEventFilter >

filter

)

Allow the filter to be set as necessary even if already connected to the input event bus

Parameters

[in]

filter

The filter used to determine whether an inut event should be consumed

---

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

• Code/Framework/AzFramework/AzFramework/Input/Events/InputChannelEventSink.h