Class OpenXRArticulatedHandDevice

Represents an Articulated Hand device in OpenXR.

Inheritance
object
DisposableObject
XRTrackedDevice
OpenXRTrackedDevice
OpenXRArticulatedHandDevice
Inherited Members
Namespace: Evergine.OpenXR.InputTracking
Assembly: Evergine.OpenXR.dll
Syntax
public class OpenXRArticulatedHandDevice : OpenXRTrackedDevice

Constructors

OpenXRArticulatedHandDevice(OpenXRInputTracking, string, uint, XRHandedness)

Initializes a new instance of the OpenXRArticulatedHandDevice class.

Declaration
public OpenXRArticulatedHandDevice(OpenXRInputTracking inputTracking, string userPathName, uint id, XRHandedness handedness = XRHandedness.Undefined)
Parameters
Type Name Description
OpenXRInputTracking inputTracking

The input tracking instance.
string userPathName

The user path string.
uint id

The ID of this device.
XRHandedness handedness

The hand preference.

Properties

DeviceType

Gets the type of the device.

Declaration
public override XRTrackedDeviceType DeviceType { get; }
Property Value
Type Description
XRTrackedDeviceType
Overrides

SupportedHandJointKind

Gets the joints supported by this controller.

Declaration
public override XRHandJointKind[] SupportedHandJointKind { get; }
Property Value
Type Description
XRHandJointKind[]
Overrides

Methods

Destroy()

Destroys all resources of this instance.

Declaration
protected override void Destroy()
Overrides

GetControllerState(out XRControllerGenericState)

Gets the controller state if this device is a controller.

Declaration
public override bool GetControllerState(out XRControllerGenericState controllerState)
Parameters
Type Name Description
XRControllerGenericState controllerState

The controller state.
Returns
Type Description
bool

False if the device is not a controller.
Overrides

GetTrackingState(out XRTrackedDeviceState)

Gets the tracking state of this device.

Declaration
public override bool GetTrackingState(out XRTrackedDeviceState trackingState)
Parameters
Type Name Description
XRTrackedDeviceState trackingState

The tracking state.
Returns
Type Description
bool

False if the device is not connected.
Overrides

TryGetArticulatedHandJoint(XRHandJointKind, out XRHandJoint)

Tries to get the hand joint by the specified joint kind.

Declaration
public override bool TryGetArticulatedHandJoint(XRHandJointKind jointKind, out XRHandJoint joint)
Parameters
Type Name Description
XRHandJointKind jointKind

The joint kind.
XRHandJoint joint

The pose of the hand joint.
Returns
Type Description
bool

True if the specified joint kind is available.
Overrides

TryGetRenderableModelAsync()

Gets a renderable model for this tracked device.

Declaration
public override Task<XRRenderableModelInfo> TryGetRenderableModelAsync()
Returns
Type Description
Task<XRRenderableModelInfo>

An awaitable task that returns the entity containing the renderable model.
Overrides

Update(long)

Updates this controller.

Declaration
public override void Update(long predictedDisplayTime)
Parameters
Type Name Description
long predictedDisplayTime

The predicted display time.
Overrides

UpdateProfiles()

Updates the device profile.

Declaration
public override void UpdateProfiles()
Overrides

Extension Methods