LWJGL 3.3.3 · org.lwjgl.openxr.HTCXViveTrackerInteraction

The XR_HTCX_vive_tracker_interaction extension.

This extension defines a new interaction profile for HTC VIVE Tracker. HTC VIVE Tracker is a generic tracked device which can be attached to anything to make them trackable. For example, it can be attached to user’s hands or feet to track the motion of human body. It can also be attached to any other devices the user wants to track and interact with.

In order to enable the functionality of this extension, you must pass the name of the extension into CreateInstance via the XrInstanceCreateInfo enabledExtensionNames parameter as indicated in the extensions section.

This extension allows:

An application to enumerate the subpaths of all current connected VIVE trackers.
An application to receive notification of the top level paths of a VIVE tracker when it is connected.

The paths of a VIVE tracker contains two paths below:

VIVE tracker persistent path indicate a specific tracker whose lifetime lasts longer than an instance, which means it must not change during its hardware lifetime. The format of this path string is unspecified and should be treated as an opaque string.
VIVE tracker role path may be constructed as "/user/vive_tracker_htcx/role/ROLE_VALUE", where ROLE_VALUE takes one of the following values. The role path may be assigned from the tool provided by the runtime and is NULL_PATH if it has not been assigned. If this role path refers to more than one tracker, the runtime should choose one of them to be currently active. The role path may be changed during the lifetime of instance. Whenever it is changed, the runtime must send event TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX to provide the new role path of that tracker.
ROLE_VALUE
- XR_NULL_PATH
- handheld_object
- left_foot
- right_foot
- left_shoulder
- right_shoulder
- left_elbow
- right_elbow
- left_knee
- right_knee
- left_wrist (rev: 3)
- right_wrist (rev: 3)
- left_ankle (rev: 3)
- right_ankle (rev: 3)
- waist
- chest
- camera
- keyboard
Either the persistent path or the role path can be be passed as a subaction path to indicate a specific tracker. For example, XrActionCreateInfo::subactionPath into function CreateAction or XrActionSpaceCreateInfo::subactionPath into function CreateActionSpace. Please see Example 1 below.

As with other controllers, if a VIVE tracker is connected and bound to a top-level user path, or disconnected while bound to top-level user path, the runtime must send event TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED, and the application may call GetCurrentInteractionProfile to check if the tracker is active or not.

The device that a tracker is attached to probably has a different motion model than what the tracker assumes. The motion tracking might not be as expected in this case.

Modifier and Type	Field and Description
public static final String	XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME The extension name.
public static final int	XR_HTCX_vive_tracker_interaction_SPEC_VERSION The extension specification version.
public static final int	XR_TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX Extends `XrStructureType`.
public static final int	XR_TYPE_VIVE_TRACKER_PATHS_HTCX Extends `XrStructureType`.

Access	Constructor and Description
protected	HTCXViveTrackerInteraction()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public static int	nxrEnumerateViveTrackerPathsHTCX(XrInstance instance, int the capacity of the `viveTrackerPaths`, or 0 to retrieve the required capacity. pathsCapacityInput, long pathsCountOutput, long viveTrackerPaths) Unsafe version of: `EnumerateViveTrackerPathsHTCX`
public static int	xrEnumerateViveTrackerPathsHTCX(XrInstance an instance previously created. instance, IntBuffer a pointer to the count of `XrViveTrackerPathsHTCX` `viveTrackerPaths` written, or a pointer to the required capacity in the case that `pathsCapacityInput` is insufficient. pathsCountOutput, XrViveTrackerPathsHTCX.Buffer a pointer to an array of `XrViveTrackerPathsHTCX` VIVE tracker paths, but can be `NULL` if `pathsCapacityInput` is 0. viveTrackerPaths) Enumerates all connected VIVE trackers.

public static int

nxrEnumerateViveTrackerPathsHTCX(XrInstance instance, int

the capacity of the viveTrackerPaths, or 0 to retrieve the required capacity.

pathsCapacityInput, long pathsCountOutput, long viveTrackerPaths)

Unsafe version of: EnumerateViveTrackerPathsHTCX

public static int

xrEnumerateViveTrackerPathsHTCX(XrInstance

an instance previously created.

instance, IntBuffer

a pointer to the count of XrViveTrackerPathsHTCX viveTrackerPaths written, or a pointer to the required capacity in the case that pathsCapacityInput is insufficient.

pathsCountOutput, XrViveTrackerPathsHTCX.Buffer

a pointer to an array of XrViveTrackerPathsHTCX VIVE tracker paths, but can be NULL if pathsCapacityInput is 0.

viveTrackerPaths)

Enumerates all connected VIVE trackers.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME	back to summary
public static final String XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME The extension name.

XR_HTCX_vive_tracker_interaction_SPEC_VERSION	back to summary
public static final int XR_HTCX_vive_tracker_interaction_SPEC_VERSION The extension specification version.

XR_TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX back to summary

XR_TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX	back to summary
public static final int XR_TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX Extends `XrStructureType`. Enum values: `TYPE_VIVE_TRACKER_PATHS_HTCX` `TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX`

public static final int XR_TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX

Extends XrStructureType.

Enum values:

XR_TYPE_VIVE_TRACKER_PATHS_HTCX back to summary

XR_TYPE_VIVE_TRACKER_PATHS_HTCX	back to summary
public static final int XR_TYPE_VIVE_TRACKER_PATHS_HTCX Extends `XrStructureType`. Enum values: `TYPE_VIVE_TRACKER_PATHS_HTCX` `TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX`

public static final int XR_TYPE_VIVE_TRACKER_PATHS_HTCX

Extends XrStructureType.

Enum values:

HTCXViveTrackerInteraction	back to summary
protected HTCXViveTrackerInteraction()

Method Detail

nxrEnumerateViveTrackerPathsHTCX back to summary

nxrEnumerateViveTrackerPathsHTCX	back to summary
public static int nxrEnumerateViveTrackerPathsHTCX(XrInstance instance, int pathsCapacityInput, long pathsCountOutput, long viveTrackerPaths) Unsafe version of: `EnumerateViveTrackerPathsHTCX` Parameters pathsCapacityInput:int the capacity of the `viveTrackerPaths`, or 0 to retrieve the required capacity.

public static int nxrEnumerateViveTrackerPathsHTCX(XrInstance instance, int pathsCapacityInput, long pathsCountOutput, long viveTrackerPaths)

Unsafe version of: EnumerateViveTrackerPathsHTCX

Parameters

pathsCapacityInput:int: the capacity of the viveTrackerPaths, or 0 to retrieve the required capacity.

xrEnumerateViveTrackerPathsHTCX back to summary

xrEnumerateViveTrackerPathsHTCX	back to summary
public static int xrEnumerateViveTrackerPathsHTCX(XrInstance instance, IntBuffer pathsCountOutput, XrViveTrackerPathsHTCX.Buffer viveTrackerPaths) Enumerates all connected VIVE trackers. C Specification The `EnumerateViveTrackerPathsHTCX` function is defined as: `XrResult xrEnumerateViveTrackerPathsHTCX( XrInstance instance, uint32_t pathsCapacityInput, uint32_t* pathsCountOutput, XrViveTrackerPathsHTCX* viveTrackerPaths);` Description `EnumerateViveTrackerPathsHTCX` enumerates all connected VIVE trackers to retrieve their paths under current instance. Valid Usage (Implicit) The `XR_HTCX_vive_tracker_interaction` extension must be enabled prior to calling `EnumerateViveTrackerPathsHTCX` `instance` must be a valid `XrInstance` handle `pathsCountOutput` must be a pointer to a `uint32_t` value If `pathsCapacityInput` is not 0, `viveTrackerPaths` must be a pointer to an array of `pathsCapacityInput` `XrViveTrackerPathsHTCX` structures Return Codes On success, this command returns `SUCCESS` On failure, this command returns `ERROR_FUNCTION_UNSUPPORTED` `ERROR_VALIDATION_FAILURE` `ERROR_RUNTIME_FAILURE` `ERROR_HANDLE_INVALID` `ERROR_INSTANCE_LOST` `ERROR_SIZE_INSUFFICIENT` See Also `XrViveTrackerPathsHTCX` Parameters instance:XrInstance an instance previously created. pathsCountOutput:IntBuffer a pointer to the count of `XrViveTrackerPathsHTCX` `viveTrackerPaths` written, or a pointer to the required capacity in the case that `pathsCapacityInput` is insufficient. viveTrackerPaths:XrViveTrackerPathsHTCX.Buffer a pointer to an array of `XrViveTrackerPathsHTCX` VIVE tracker paths, but can be `NULL` if `pathsCapacityInput` is 0. Annotations @NativeType:XrResult

public static int xrEnumerateViveTrackerPathsHTCX(XrInstance instance, IntBuffer pathsCountOutput, XrViveTrackerPathsHTCX.Buffer viveTrackerPaths)

Enumerates all connected VIVE trackers.

C Specification

The EnumerateViveTrackerPathsHTCX function is defined as:


XrResult xrEnumerateViveTrackerPathsHTCX(
    XrInstance                                  instance,
    uint32_t                                    pathsCapacityInput,
    uint32_t*                                   pathsCountOutput,
    XrViveTrackerPathsHTCX*                     viveTrackerPaths);

Description

EnumerateViveTrackerPathsHTCX enumerates all connected VIVE trackers to retrieve their paths under current instance.

Valid Usage (Implicit)

The XR_HTCX_vive_tracker_interaction extension must be enabled prior to calling EnumerateViveTrackerPathsHTCX
instance must be a valid XrInstance handle
pathsCountOutput must be a pointer to a uint32_t value
If pathsCapacityInput is not 0, viveTrackerPaths must be a pointer to an array of pathsCapacityInput XrViveTrackerPathsHTCX structures

Return Codes

On success, this command returns

SUCCESS

On failure, this command returns

public Class HTCXViveTrackerInteraction

Field Summary

Constructor Summary

Method Summary

Field Detail

Enum values:

Enum values:

Constructor Detail

Method Detail

C Specification

Description

Valid Usage (Implicit)

Return Codes

See Also