VRHandTracking Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Hand tracking is natively supported only when using the OpenXR backend. This includes any VR device that supports OpenXR hand tracking (e.g., Meta Quest, Varjo, Vive with appropriate runtimes). For varjo and openvr backends, hand tracking requires additional plugins such as LeapMotion Plugin or Ultraleap Plugin.

Refer to this article to properly configure hand tracking in your project and choose the right backend.

VRHandTracking Class

Members

int isAvailable() const#

Returns the current value indicating if hand tracking is available on the active VR device and is supported at runtime.

Return value

Current hand tracking is available

VRHand getHandLeft() const#

Returns the current left hand.

Return value

Current left hand.

VRHand getHandRight() const#

Returns the current right hand.

Return value

Current right hand.

void setVisualizerEnabled ( int enabled = 0 ) #

Console: vr_hand_tracking_visualizer_enabled

Sets a new value indicating if the visualizer for hands is enabled. When set to 1, the engine will draw a simple debug skeleton of the hands, showing bones only. This option requires the Visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Arguments

int enabled - The the visualizer for hands The default value is false.

int isVisualizerEnabled() const#

Console: vr_hand_tracking_visualizer_enabled

Returns the current value indicating if the visualizer for hands is enabled. When set to 1, the engine will draw a simple debug skeleton of the hands, showing bones only. This option requires the Visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Return value

Current the visualizer for hands The default value is false.

void setShowBasis ( int basis = 0 ) #

Console: vr_hand_tracking_show_basis

Sets a new value indicating if the visualizer for the coordinate axes (basis) of each hand bone is enabled. This option requires the Hand visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Arguments

int basis - The the visualizer for the basis of each hand bone The default value is false.

int isShowBasis() const#

Console: vr_hand_tracking_show_basis

Returns the current value indicating if the visualizer for the coordinate axes (basis) of each hand bone is enabled. This option requires the Hand visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Return value

Current the visualizer for the basis of each hand bone The default value is false.

void setShowVelocity ( int velocity = 0 ) #

Console: vr_hand_tracking_show_velocity

Sets a new value indicating if the visualizer for the velocity vectors of each hand bone is enabled. Useful for debugging motion-based interactions like swipes or throws. This option requires the Hand visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Arguments

int velocity - The the visualizer for the velocity vectors of each hand bone The default value is false.

int isShowVelocity() const#

Console: vr_hand_tracking_show_velocity

Returns the current value indicating if the visualizer for the velocity vectors of each hand bone is enabled. Useful for debugging motion-based interactions like swipes or throws. This option requires the Hand visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Return value

Current the visualizer for the velocity vectors of each hand bone The default value is false.

void setShowBoneSizes ( int sizes = 0 ) #

Console: vr_hand_tracking_show_bone_sizes

Sets a new value indicating if the visualizer for the size of each hand bone is enabled. Displays red spheres representing the size (radius) of each bone, providing a visual reference for the physical dimensions of the tracked hand. This option requires the Hand visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Arguments

int sizes - The the visualizer for the size of each hand bone The default value is false.

int isShowBoneSizes() const#

Console: vr_hand_tracking_show_bone_sizes

Returns the current value indicating if the visualizer for the size of each hand bone is enabled. Displays red spheres representing the size (radius) of each bone, providing a visual reference for the physical dimensions of the tracked hand. This option requires the Hand visualizer to be enabled.

This parameter is stored in the following configuration file: *.boot.

Return value

Current the visualizer for the size of each hand bone The default value is false.

_{The information on this page is valid for UNIGINE 2.20 SDK.}

Last update: 2025-06-20

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

VRHandTracking Class

In This Article:

VRHandTracking Class

Members

int isAvailable() const#

Return value

VRHand getHandLeft() const#

Return value

VRHand getHandRight() const#

Return value

void setVisualizerEnabled ( int enabled = 0 ) #

Arguments

int isVisualizerEnabled() const#

Return value

void setShowBasis ( int basis = 0 ) #

Arguments

int isShowBasis() const#

Return value

void setShowVelocity ( int velocity = 0 ) #

Arguments

int isShowVelocity() const#

Return value

void setShowBoneSizes ( int sizes = 0 ) #

Arguments

int isShowBoneSizes() const#

Return value