Skip to main content

Settings

Functions for accessing settings.

Functions​

TypeName
voidvrSettingAddToScene(string path, Any defaultVal, Any slot =nil, Any complete =nil, string typestr =0)
Creates a scene setting as an override to an existing setting or a scene-only setting.
voidvrSettingCreateArrayDouble(string path, number length, vrnode user =nil, number ... )
Creates a new double array user setting.
voidvrSettingCreateArrayFloat(string path, number length, vrnode user =nil, number ... )
Creates a new float array user setting.
voidvrSettingCreateArrayInt(string path, number length, vrnode user =nil, number ... )
Creates a new integer array user setting.
voidvrSettingCreateBool(string path, boolean defaultVal =false, vrnode user =nil)
Creates a new boolean user setting.
voidvrSettingCreateDouble(string path, number defaultVal =0.0, vrnode user =nil, number minVal =VR_DOUBLE_MIN, number maxVal =VR_DOUBLE_MAX)
Creates a new double user setting.
voidvrSettingCreateFloat(string path, number defaultVal =0.0, vrnode user =nil, number minVal =VR_FLOAT_MIN, number maxVal =VR_FLOAT_MAX)
Creates a new float user setting.
voidvrSettingCreateInt(string path, number defaultVal =0, vrnode user =nil, number minVal =VR_INT_MIN, number maxVal =VR_INT_MAX)
Creates a new integer user setting.
voidvrSettingCreateLink(string path, string filter =0, vrnode user =nil)
Creates a new link user setting.
voidvrSettingCreateString(string path, string defaultVal =0, vrnode user =nil)
Creates a new string user setting.
vrsettingvrSettingGet(string path, vrnode user =nil)
Gets an application setting from the user registry, or a scene override if it exists.
vrsettingvrSettingGetNode(string path, vrnode user =nil)
Gets an application setting node from the user registry, or a scene override if it exists.
vrnodevrSettingGetRoot()
Gets the node associated with the root of the settings hierarchy.
vrnodevrSettingGetSceneRoot()
Gets the root of the settings overrides in the scenes tree if it exists.
AnyvrSettingRead(string path, vrnode user =nil)
Reads the value of a setting.
booleanvrSettingRemoveFromScene(string path)
Removes a scene setting.
voidvrSettingSetCaption(string path, string caption)
Assigns a custom caption to a setting, allowing the text displayed in user interface to be different from the setting name.
voidvrSettingSetFilter(string path, string filter)
Assigns a filter to a setting. The meaning of the filter depends on the setting type.
voidvrSettingSetStep(string path, number step)
Assigns a step size to a numerical setting.
voidvrSettingSetType(string path, string type)
Assigns a type to a setting, which determines how the setting is presented in the user interface.
voidvrSettingWrite(string path, Any value, vrnode user =nil)
Writes the value of a setting.

Functions Documentation​

vrSettingAddToScene​

void vrSettingAddToScene(
    string path,
    Any defaultVal,
    Any slot =nil,
    Any complete =nil,
    string typestr =0
)

Creates a scene setting as an override to an existing setting or a scene-only setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • defaultVal Default value if the scene setting is not an override
  • slot Function to call when the setting value changes
  • complete Function to call when the node has been created, which may not be immediately
  • typestr Hint at which number type should be used instead of a double to create a scene-only setting (int, float, world)

vrSettingCreateArrayDouble​

void vrSettingCreateArrayDouble(
    string path,
    number length,
    vrnode user =nil,
    number ... 
)

Creates a new double array user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • length The length of the array (2, 3, 4, 9 or 16)
  • user The user that this setting belongs to (defaults to the current user)
  • ... The default value(s) to apply to the array elements

vrSettingCreateArrayFloat​

void vrSettingCreateArrayFloat(
    string path,
    number length,
    vrnode user =nil,
    number ... 
)

Creates a new float array user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • length The length of the array (2, 3, 4, 9 or 16)
  • user The user that this setting belongs to (defaults to the current user)
  • ... The default value(s) to apply to the array elements

vrSettingCreateArrayInt​

void vrSettingCreateArrayInt(
    string path,
    number length,
    vrnode user =nil,
    number ... 
)

Creates a new integer array user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • length The length of the array (2, 3 or 4)
  • user The user that this setting belongs to (defaults to the current user)
  • ... The default value(s) to apply to the array elements

vrSettingCreateBool​

void vrSettingCreateBool(
    string path,
    boolean defaultVal =false,
    vrnode user =nil
)

Creates a new boolean user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • defaultVal The default value to apply to the setting
  • user The user that this setting belongs to (defaults to the current user)

vrSettingCreateDouble​

void vrSettingCreateDouble(
    string path,
    number defaultVal =0.0,
    vrnode user =nil,
    number minVal =VR_DOUBLE_MIN,
    number maxVal =VR_DOUBLE_MAX
)

Creates a new double user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • defaultVal The default value to apply to the setting
  • user The user that this setting belongs to (defaults to the current user)
  • minVal The minimum value that can be assigned to the setting
  • maxVal The maximum value that can be assigned to the setting

vrSettingCreateFloat​

void vrSettingCreateFloat(
    string path,
    number defaultVal =0.0,
    vrnode user =nil,
    number minVal =VR_FLOAT_MIN,
    number maxVal =VR_FLOAT_MAX
)

Creates a new float user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • defaultVal The default value to apply to the setting
  • user The user that this setting belongs to (defaults to the current user)
  • minVal The minimum value that can be assigned to the setting
  • maxVal The maximum value that can be assigned to the setting

vrSettingCreateInt​

void vrSettingCreateInt(
    string path,
    number defaultVal =0,
    vrnode user =nil,
    number minVal =VR_INT_MIN,
    number maxVal =VR_INT_MAX
)

Creates a new integer user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • defaultVal The default value to apply to the setting
  • user The user that this setting belongs to (defaults to the current user)
  • minVal The minimum value that can be assigned to the setting
  • maxVal The maximum value that can be assigned to the setting
void vrSettingCreateLink(
    string path,
    string filter =0,
    vrnode user =nil
)

Creates a new link user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • filter A comma-separated list of metanode types that can be linked to (e.g. "Assembly" or "Visual,Sequence")
  • user The user that this setting belongs to (defaults to the current user)

vrSettingCreateString​

void vrSettingCreateString(
    string path,
    string defaultVal =0,
    vrnode user =nil
)

Creates a new string user setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • defaultVal The default value to apply to the setting
  • user The user that this setting belongs to (defaults to the current user)

vrSettingGet​

vrsetting vrSettingGet(
    string path,
    vrnode user =nil
)

Gets an application setting from the user registry, or a scene override if it exists.

Parameters:

  • path Path to the setting (relative to the registry root)
  • user The user that this setting belongs to (defaults to the current user)

vrSettingGetNode​

vrsetting vrSettingGetNode(
    string path,
    vrnode user =nil
)

Gets an application setting node from the user registry, or a scene override if it exists.

Parameters:

  • path Path to the setting (relative to the registry root)
  • user The user that this setting belongs to (defaults to the current user)

vrSettingGetRoot​

vrnode vrSettingGetRoot()

Gets the node associated with the root of the settings hierarchy.

Return: The user settings root node, or nil

vrSettingGetSceneRoot​

vrnode vrSettingGetSceneRoot()

Gets the root of the settings overrides in the scenes tree if it exists.

Return: The scene overrides root node, or nil

vrSettingRead​

Any vrSettingRead(
    string path,
    vrnode user =nil
)

Reads the value of a setting.

Parameters:

  • path Path to the setting (relative to the registry root
  • user The user that this setting belongs to (defaults to the current user)

vrSettingRemoveFromScene​

boolean vrSettingRemoveFromScene(
    string path
)

Removes a scene setting.

Parameters:

  • path Path to the setting (relative to the registry root)

Return: True if the setting was removed

vrSettingSetCaption​

void vrSettingSetCaption(
    string path,
    string caption
)

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

Parameters:

  • path Path to the setting (relative to the registry root)
  • caption The caption to be displayed in the user interface

vrSettingSetFilter​

void vrSettingSetFilter(
    string path,
    string filter
)

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

Parameters:

  • path Path to the setting (relative to the registry root)
  • filter List of allowable file extensions for a file property or node types for a link property

vrSettingSetStep​

void vrSettingSetStep(
    string path,
    number step
)

Assigns a step size to a numerical setting.

Parameters:

  • path Path to the setting (relative to the registry root)
  • step The step size

vrSettingSetType​

void vrSettingSetType(
    string path,
    string type
)

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

Parameters:

  • path Path to the setting (relative to the registry root)
  • type The type name (e.g. 'image', 'file', 'slider', 'colour', 'rect', 'sphere', 'matrix', etc.)

vrSettingWrite​

void vrSettingWrite(
    string path,
    Any value,
    vrnode user =nil
)

Writes the value of a setting.

Parameters:

  • path Path to the setting (relative to the registry root
  • value The value to set
  • user The user that this setting belongs to (defaults to the current user)