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::InputChannelEventFilterInclusionList Class Reference

Class that filters input channel events based on included input channels and devices. More...

#include <InputChannelEventFilter.h>

Inherits AzFramework::InputChannelEventFilter.

Public Member Functions

 InputChannelEventFilterInclusionList (const AZ::Crc32 &channelNameCrc32=AnyChannelNameCrc32, const AZ::Crc32 &deviceNameCrc32=AnyDeviceNameCrc32, const LocalUserId &localUserId=LocalUserIdAny)
 
 AZ_DEFAULT_COPY (InputChannelEventFilterInclusionList)
 
 ~InputChannelEventFilterInclusionList () override=default
 Default destructor.
 
bool DoesPassFilter (const InputChannel &inputChannel) const override
 AzFramework::InputChannelEventFilter::DoesPassFilter
 
void IncludeChannelName (const AZ::Crc32 &channelNameCrc32)
 
void IncludeDeviceName (const AZ::Crc32 &deviceNameCrc32)
 
void IncludeLocalUserId (LocalUserId localUserId)
 
- Public Member Functions inherited from AzFramework::InputChannelEventFilter
 InputChannelEventFilter ()=default
 Default constructor.
 
 AZ_DEFAULT_COPY (InputChannelEventFilter)
 
virtual ~InputChannelEventFilter ()=default
 Default destructor.
 
virtual bool DoesPassFilter (const InputChannel &inputChannel) const =0
 

Additional Inherited Members

- Static Public Attributes inherited from AzFramework::InputChannelEventFilter
static const AZ::Crc32 AnyChannelNameCrc32
 Wildcard representing any input channel name.
 
static const AZ::Crc32 AnyDeviceNameCrc32
 Wildcard representing any input device name.
 

Detailed Description

Class that filters input channel events based on included input channels and devices.

Constructor & Destructor Documentation

◆ InputChannelEventFilterInclusionList()

AzFramework::InputChannelEventFilterInclusionList::InputChannelEventFilterInclusionList ( const AZ::Crc32 &  channelNameCrc32 = AnyChannelNameCrc32,
const AZ::Crc32 &  deviceNameCrc32 = AnyDeviceNameCrc32,
const LocalUserId &  localUserId = LocalUserIdAny 
)
explicit

Constructor. By default the filter will be constructed to include all input events.

Parameters
[in]channelNameCrc32The input channel name (Crc32) to include (default any)
[in]deviceNameCrc32The input device name (Crc32) to include (default any)
[in]localUserIdThe local user id to include (default any)

Member Function Documentation

◆ DoesPassFilter()

bool AzFramework::InputChannelEventFilterInclusionList::DoesPassFilter ( const InputChannel &  inputChannel) const
overridevirtual

AzFramework::InputChannelEventFilter::DoesPassFilter

Implements AzFramework::InputChannelEventFilter.

◆ IncludeChannelName()

void AzFramework::InputChannelEventFilterInclusionList::IncludeChannelName ( const AZ::Crc32 &  channelNameCrc32)

Add an input channel name to the inclusion list

Parameters
[in]channelNameCrc32The input channel name (Crc32) to add to the inclusion list

◆ IncludeDeviceName()

void AzFramework::InputChannelEventFilterInclusionList::IncludeDeviceName ( const AZ::Crc32 &  deviceNameCrc32)

Add an input device name to the inclusion list

Parameters
[in]channelNameCrc32The input device name (Crc32) to add to the inclusion list

◆ IncludeLocalUserId()

void AzFramework::InputChannelEventFilterInclusionList::IncludeLocalUserId ( LocalUserId  localUserId)

Add a local user id to the inclusion list

Parameters
[in]localUserIdThe local user id to add to the inclusion list
The documentation for this class was generated from the following file: