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 | Static Public Member Functions | Protected Attributes | List of all members
AzFramework::InputMapping::ConfigBase Class Referenceabstract

Base class for input mapping configuration values that are exposed to the editor. More...

#include <InputMapping.h>

Inherited by AzFramework::InputMappingAnd::Config, and AzFramework::InputMappingOr::Config.

Public Member Functions

 AZ_CLASS_ALLOCATOR (ConfigBase, AZ::SystemAllocator)
 
 AZ_RTTI (ConfigBase, "{72EBBBCC-D57E-4085-AFD9-4910506010B6}")
 
virtual ~ConfigBase ()=default
 Destructor.
 
AZStd::shared_ptr< InputMapping > CreateInputMappingAndAddToContext (InputContext &inputContext) const
 
virtual AZStd::shared_ptr< InputMapping > CreateInputMapping (const InputContext &inputContext) const =0
 
virtual AZStd::string GetNameLabelOverride () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Protected Attributes

AZStd::string m_outputInputChannelName
 The unique input channel name (event) output by the input mapping.
 

Detailed Description

Base class for input mapping configuration values that are exposed to the editor.

Member Function Documentation

◆ CreateInputMapping()

virtual AZStd::shared_ptr< InputMapping > AzFramework::InputMapping::ConfigBase::CreateInputMapping ( const InputContext &  inputContext) const
pure virtual

Override to create the relevant input mapping.

Parameters
[in]inputContextInput context that owns the input mapping.

Implemented in AzFramework::InputMappingAnd::Config, and AzFramework::InputMappingOr::Config.

◆ CreateInputMappingAndAddToContext()

AZStd::shared_ptr< InputMapping > AzFramework::InputMapping::ConfigBase::CreateInputMappingAndAddToContext ( InputContext &  inputContext) const

Create an input mapping and add it to the input context.

Parameters
[in]inputContextInput context that the input mapping will be added to.

◆ GetNameLabelOverride()

virtual AZStd::string AzFramework::InputMapping::ConfigBase::GetNameLabelOverride ( ) const
virtual

Get the name label override to display.

Returns
Name label override to display.
The documentation for this class was generated from the following file: