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 Attributes | List of all members
AzFramework::InputDeviceNotifications Class Reference

#include <InputDeviceNotificationBus.h>

Inherits AZ::EBusTraits.

Public Member Functions

virtual ~InputDeviceNotifications ()=default
 Default destructor.
 
virtual void OnInputDeviceConnectedEvent (const InputDevice &)
 
virtual void OnInputDeviceDisconnectedEvent (const InputDevice &)
 
virtual AZ::s32 GetPriority () const
 
bool Compare (const InputDeviceNotifications *other) const
 

Static Public Attributes

static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 EBus Trait: input notifications are addressed to a single address.
 
static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::MultipleAndOrdered
 EBus Trait: input notifications can be handled by multiple (ordered) listeners.
 

Detailed Description

EBus interface used to listen for input events as they're broadcast from input devices when they connect or disconnect from the system. Some common input devices are assumed to always be connected, and will never generate these notifications. This interface could be extended to include notifications for other events related to input devices, for example low battery.

Member Function Documentation

◆ Compare()

bool AzFramework::InputDeviceNotifications::Compare ( const InputDeviceNotifications *  other) const
inline

Compare function required by BusHandlerOrderCompare = BusHandlerCompareDefault

Parameters
[in]otherAnother instance of the class to compare
Returns
True if the priority of this handler is greater than the other, false otherwise

◆ GetPriority()

virtual AZ::s32 AzFramework::InputDeviceNotifications::GetPriority ( ) const
inlinevirtual

Access to the priority of the input notification handler (sorted from highest to lowest)

Returns
Priority of the input notification handler

◆ OnInputDeviceConnectedEvent()

virtual void AzFramework::InputDeviceNotifications::OnInputDeviceConnectedEvent ( const InputDevice &  )
inlinevirtual

Override to be notified when input devices connect to the system

Parameters
[in]inputChannelThe input device that connected

◆ OnInputDeviceDisconnectedEvent()

virtual void AzFramework::InputDeviceNotifications::OnInputDeviceDisconnectedEvent ( const InputDevice &  )
inlinevirtual

Override to be notified when input devices disconnect from the system

Parameters
[in]inputChannelThe input device that disconnected
The documentation for this class was generated from the following file: