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.
AzFramework::InputMapping::InputChannelNameFilteredByDeviceType Struct Reference

Convenience class that allows for selection of an input channel name filtered by device. More...

#include <InputMapping.h>

Public Member Functions

 AZ_CLASS_ALLOCATOR (InputChannelNameFilteredByDeviceType, AZ::SystemAllocator)
 
 AZ_RTTI (InputChannelNameFilteredByDeviceType, "{68CC4865-1C0E-4E2E-BDAE-AF42EA30DBE8}")
 
 InputChannelNameFilteredByDeviceType ()
 Constructor.
 
virtual ~InputChannelNameFilteredByDeviceType ()=default
 Destructor.
 
const AZStd::string & GetInputDeviceType () const
 
const AZStd::string & GetInputChannelName () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

virtual AZ::Crc32 OnInputDeviceTypeSelected ()
 
virtual AZStd::string GetNameLabelOverride () const
 
virtual AZStd::vector< AZStd::string > GetValidInputDeviceTypes () const
 
virtual AZStd::vector< AZStd::string > GetValidInputChannelNamesBySelectedDevice () const
 

Detailed Description

Convenience class that allows for selection of an input channel name filtered by device.

Member Function Documentation

◆ GetInputChannelName()

const AZStd::string & AzFramework::InputMapping::InputChannelNameFilteredByDeviceType::GetInputChannelName ( ) const
inline

Get the currently selected input channel name.

Returns
Currently selected input channel name.

◆ GetInputDeviceType()

const AZStd::string & AzFramework::InputMapping::InputChannelNameFilteredByDeviceType::GetInputDeviceType ( ) const
inline

Get the currently selected input device type.

Returns
Currently selected input device type.

◆ GetNameLabelOverride()

virtual AZStd::string AzFramework::InputMapping::InputChannelNameFilteredByDeviceType::GetNameLabelOverride ( ) const
protectedvirtual

Get the name label override to display.

Returns
Name label override to display.

◆ GetValidInputChannelNamesBySelectedDevice()

virtual AZStd::vector< AZStd::string > AzFramework::InputMapping::InputChannelNameFilteredByDeviceType::GetValidInputChannelNamesBySelectedDevice ( ) const
protectedvirtual

Get the valid input channel names for this input mapping given the selected device type.

Returns
Valid input channel names for this input mapping given the selected device type.

◆ GetValidInputDeviceTypes()

virtual AZStd::vector< AZStd::string > AzFramework::InputMapping::InputChannelNameFilteredByDeviceType::GetValidInputDeviceTypes ( ) const
protectedvirtual

Get the valid input device types for this input mapping.

Returns
Valid input device types for this input mapping.

◆ OnInputDeviceTypeSelected()

virtual AZ::Crc32 AzFramework::InputMapping::InputChannelNameFilteredByDeviceType::OnInputDeviceTypeSelected ( )
protectedvirtual

Called when an input device type is selected.

Returns
The AZ::Edit::PropertyRefreshLevels to apply to the property tree view.

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