ezEngine  Release 25.03
ezOpenXRInputDevice Class Reference
Inheritance diagram for ezOpenXRInputDevice:

Public Member Functions

void GetDeviceList (ezHybridArray< ezXRDeviceID, 64 > &out_devices) const override
 Fills out a list of valid (connected) device IDs.
 
ezXRDeviceID GetDeviceIDByType (ezXRDeviceType::Enum type) const override
 Returns the deviceID for a specific type of device. If the device is not connected, -1 is returned instead.
 
const ezXRDeviceStateGetDeviceState (ezXRDeviceID deviceID) const override
 Returns the current device state for a valid device ID.
 
ezString GetDeviceName (ezXRDeviceID deviceID) const override
 Returns the device name for a valid device ID. More...
 
ezBitflags< ezXRDeviceFeaturesGetDeviceFeatures (ezXRDeviceID deviceID) const override
 Returns the device features for a valid device ID.
 
- Public Member Functions inherited from ezXRInputDevice
const ezXRDeviceEventGetInputEvent ()
 Returns the input event. Allows tracking device addition and removal.
 
- Public Member Functions inherited from ezInputDevice
 ezInputDevice ()
 Default Constructor.
 
float GetInputSlotState (ezStringView sSlot) const
 Allows to query current input values for the given slot.
 
bool HasDeviceBeenUsedLastFrame () const
 Returns true, if the device was 'used' during the last frame, ie. when it generated input due to some user interaction. More...
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Friends

class ezOpenXR
 

Additional Inherited Members

- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 
- Protected Member Functions inherited from ezInputDevice
virtual void ResetInputSlotValues ()
 Override this, if you need to reset certain input slot values to zero, after the ezInputManager is finished with the current frame update.
 
virtual void UpdateHardwareState (ezTime tTimeDifference)
 This function is called once after ezInputManager::Update with the same time delta value. It allows to update hardware state, such as the vibration of gamepad motors.
 
- Static Protected Member Functions inherited from ezInputDevice
static void RegisterInputSlot (ezStringView sName, ezStringView sDefaultDisplayName, ezBitflags< ezInputSlotFlags > SlotFlags)
 Calls RegisterInputSlot() on the ezInputManager and passes the parameters through.
 
- Protected Attributes inherited from ezXRInputDevice
ezXRDeviceEvent m_InputEvents
 
- Protected Attributes inherited from ezInputDevice
ezMap< ezString, float > m_InputSlotValues
 Stores all the values for all input slots that this device handles. More...
 
ezUInt32 m_uiLastCharacter
 If this input device type handles character input, it should write the last typed character into this variable. The ezInputManager calls RetrieveLastCharacter() to query what the user typed last.
 
- Protected Attributes inherited from ezEnumerable< ezInputDevice, ezReflectedClass >
ezEnumerablem_pNextInstance
 

Member Function Documentation

◆ GetDeviceName()

ezString ezOpenXRInputDevice::GetDeviceName ( ezXRDeviceID  deviceID) const
overridevirtual

Returns the device name for a valid device ID.

This returns a human readable name to identify the device. For ezXRDeviceType::HMD the name is always 'HMD'. This can be used for e.g. controllers to create custom game input logic or mappings if a certain type of controller is used. Values could be for example: 'Simple Controller', 'Mixed Reality Motion Controller', 'Hand Interaction' etc.

Implements ezXRInputDevice.


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