New in 2021.2

This page lists changes in version 2021.2 affecting user-facing APIs.

Event Observers

We have added various functions to the Lua and C APIs for observing events.

Lua API

Function

Description

vrAddEventObserver

Adds an observer and callback function to execute for events

vrAddGlobalEventObserver

Adds an observer and callback function to execute for global events

C API

Function

Description

VRAddCallbackActivate

Add callback for Activate event of a node and the other node deactivated

VRRemoveCallbackActivate

Remove callback for Activate event of a node and the other node deactivated

VRAddCallbackTouch

Add Touch callback (assembly has collided)

VRRemoveCallbackTouch

Remove Touch callback (assembly has collided)

VRAddCallbackBreak

Add Break callback (assembly has ceased colliding)

VRRemoveCallbackBreak

Remove Break callback (assembly has ceased colliding)

VRAddCallbackKeyPress

Add Key press callback (key was pressed)

VRRemoveCallbackKeyPress

Remove Key press callback (key was pressed)

VRAddCallbackKeyRelease

Add Key release callback (key was released)

VRRemoveCallbackKeyRelease

Remove Key release callback (key was released)

VRAddCallbackPoseEntered

Add Pose entered callback (a hand switched to a pose)

VRRemoveCallbackPoseEntered

Remove Pose entered callback (a hand switched to a pose)

VRAddCallbackPoseLeft

Add Pose left callback (a hand left a pose)

VRRemoveCallbackPoseLeft

Remove Pose left callback (a hand left a pose)

VRAddCallbackGesture

Add Gesture callback (a hand activated a gesture)

VRRemoveCallbackGesture

Remove Gesture callback (a hand activated a gesture)

VRAddCallbackClick

Add Click callback (button or similar node clicked)

VRRemoveCallbackClick

Remove Click callback (button or similar node clicked)

VRAddCallbackDoubleClick

Add Double click callback (button or similar node double-clicked)

VRRemoveCallbackDoubleClick

Remove Double click callback (button or similar node double-clicked)

VRAddCallbackEnter

Add Enter callback (a generic state was entered)

VRRemoveCallbackEnter

Remove Enter callback (a generic state was entered)

VRAddCallbackLeave

Add Leave callback (a generic state was left)

VRRemoveCallbackLeave

Remove Leave callback (a generic state was left)

VRAddCallbackMove

Add Move callback. The Move event applies to sliders, scrollbars and markers in the GUI system in addition to assemblies.

VRRemoveCallbackMove

Remove Move callback (the transform property has changed)

VRAddCallbackPress

Add Press callback (button or similar node pressed)

VRRemoveCallbackPress

Remove Press callback (button or similar node pressed)

VRAddCallbackRelease

Add Release callback (button or similar node released)

VRRemoveCallbackRelease

Remove Release callback (button or similar node released)

VRAddCallbackToggle

Add Toggle callback (button or similar node toggled)

VRRemoveCallbackToggle

Remove Toggle callback (button or similar node toggled)

Create User Settings (Lua API)

We have added various functions for creating and editing user settings in the Lua API (this is to complement the C API functions that were added in 2021.1).

Function

Description

vrSettingCreateArrayDouble

Creates a new double array user setting

vrSettingCreateArrayFloat

Creates a new float array user setting

vrSettingCreateArrayInt

Creates a new integer array user setting

vrSettingCreateBool

Creates a new boolean user setting

vrSettingCreateDouble

Creates a new double user setting

vrSettingCreateFloat

Creates a new float user setting

vrSettingCreateInt

Creates a new integer user setting

vrSettingCreateLink

Creates a new link user setting

vrSettingCreateString

Creates a new string user setting

vrSettingGetRoot

Gets the node associated with the root of the settings hierarchy

vrSettingSetCaption

Assigns a custom caption to a setting, allowing the text displayed in user interface to be different from the setting name

vrSettingSetFilter

Assigns a filter to a setting. The meaning of the filter depends on the setting type

vrSettingSetStep

Assigns a step size to a numerical setting

vrSettingSetType

Assigns a type to a setting, which determines how the setting is presented in the user interface

Other Changes


No Results.

Getting StartedArchitectureBest PracticesHow ToAdvanced TopicsChangelogvrtree_cppCoreForeign Function InterfaceMetanodesMigrationsObserversPropertiesSettingsTreeUtilitiesAPI DefinitionsVR ExchangePluginsLua API