ezXRInputDevice Class Reference

Inheritance diagram for ezXRInputDevice:

Public Member Functions
Devices
virtual void	GetDeviceList (ezHybridArray< ezXRDeviceID, 64 > &out_devices) const =0
	Fills out a list of valid (connected) device IDs.
virtual ezXRDeviceID	GetDeviceIDByType (ezXRDeviceType::Enum type) const =0
	Returns the deviceID for a specific type of device. If the device is not connected, -1 is returned instead.
virtual const ezXRDeviceState &	GetDeviceState (ezXRDeviceID deviceID) const =0
	Returns the current device state for a valid device ID.
virtual ezString	GetDeviceName (ezXRDeviceID deviceID) const =0
	Returns the device name for a valid device ID.
virtual ezBitflags< ezXRDeviceFeatures >	GetDeviceFeatures (ezXRDeviceID deviceID) const =0
	Returns the device features for a valid device ID.
const ezXRDeviceEvent &	GetInputEvent ()
	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.
Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () 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.

Protected Attributes
ezXRDeviceEvent	m_InputEvents
Protected Attributes inherited from ezInputDevice
bool	m_bOverridesAbsoluteInput = false
	Whether this device is authoritative for absolute-value slots (a position, not a delta) it writes, such as the mouse position - see ezInputManager::GatherDeviceInputSlotValues().
ezMap< ezString, float >	m_InputSlotValues
	Stores all the values for all input slots that this device handles.
ezStringBuilder	m_sLastCharacters
	If this input device type handles character input, append every typed character (Unicode codepoint) it receives to this, one Append() call per character event. Append rather than overwrite, so several characters typed within one frame - which happens whenever the OS delivers input faster than the game updates - are all preserved instead of all but the last being silently dropped. The ezInputManager calls RetrieveLastCharacters() to query what the user typed since the last update.
Protected Attributes inherited from ezEnumerable< ezInputDevice, ezReflectedClass >
ezEnumerable *	m_pNextInstance

Additional Inherited Members
Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()
Protected Member Functions inherited from ezInputDevice
virtual void	InitializeDevice ()=0
	Override this if you need to do device specific initialization before the first use.
virtual void	UpdateInputSlotValues ()=0
	Override this, if you need to query the state of the hardware to update the input slots.
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	RegisterInputSlots ()=0
	Override this to register all the input slots that this device exposes.
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.

Member Function Documentation

GetDeviceFeatures()

virtual ezBitflags< ezXRDeviceFeatures > ezXRInputDevice::GetDeviceFeatures ( ezXRDeviceID  deviceID ) const

pure virtual

Returns the device features for a valid device ID.

Implemented in ezDummyXRInput, and ezOpenXRInputDevice.

GetDeviceIDByType()

virtual ezXRDeviceID ezXRInputDevice::GetDeviceIDByType ( ezXRDeviceType::Enum  type ) const

pure virtual

Returns the deviceID for a specific type of device. If the device is not connected, -1 is returned instead.

Implemented in ezDummyXRInput, and ezOpenXRInputDevice.

GetDeviceList()

virtual void ezXRInputDevice::GetDeviceList ( ezHybridArray< ezXRDeviceID, 64 > &  out_devices ) const

pure virtual

Fills out a list of valid (connected) device IDs.

Implemented in ezDummyXRInput, and ezOpenXRInputDevice.

GetDeviceName()

virtual ezString ezXRInputDevice::GetDeviceName ( ezXRDeviceID  deviceID ) const

pure virtual

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.

Implemented in ezDummyXRInput, and ezOpenXRInputDevice.

GetDeviceState()

virtual const ezXRDeviceState & ezXRInputDevice::GetDeviceState ( ezXRDeviceID  deviceID ) const

pure virtual

Returns the current device state for a valid device ID.

Implemented in ezDummyXRInput, and ezOpenXRInputDevice.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/GameEngine/XR/XRInputDevice.h