Skip to main content

Metanodes

Functions for interacting with metanodes.

Functions​

TypeName
voidvrAddPropertyArrayBool(string metaName, string propName, number length, boolean ... )
Adds a new boolean array property to an unfinished metanode.
voidvrAddPropertyArrayChar(string metaName, string propName, number length, number ... )
Adds a new character array property to an unfinished metanode.
voidvrAddPropertyArrayDouble(string metaName, string propName, number length, number ... )
Adds a new double array property to an unfinished metanode.
voidvrAddPropertyArrayFloat(string metaName, string propName, number length, number ... )
Adds a new float array property to an unfinished metanode.
voidvrAddPropertyArrayInt(string metaName, string propName, number length, number ... )
Adds a new integer array property to an unfinished metanode.
voidvrAddPropertyArrayWorldFloat(string metaName, string propName, number length, number ... )
Adds a new world float array property to an unfinished metanode.
voidvrAddPropertyBool(string metaName, string propName, boolean defaultVal =false)
Adds a new boolean property to an unfinished metanode.
voidvrAddPropertyChar(string metaName, string propName, number defaultVal =0, number minVal =VR_CHAR_MIN, number maxVal =VR_CHAR_MAX)
Adds a new character property to an unfinished metanode.
voidvrAddPropertyDouble(string metaName, string propName, number defaultVal =0.0, number minVal =VR_DOUBLE_MIN, number maxVal =VR_DOUBLE_MAX)
Adds a new double property to an unfinished metanode.
voidvrAddPropertyFloat(string metaName, string propName, number defaultVal =0.0, number minVal =VR_FLOAT_MIN, number maxVal =VR_FLOAT_MAX)
Adds a new float property to an unfinished metanode.
voidvrAddPropertyInt(string metaName, string propName, number defaultVal =0, number minVal =VR_INT_MIN, number maxVal =VR_INT_MAX)
Adds a new integer property to an unfinished metanode.
voidvrAddPropertyLink(string metaName, string propName, string filter =0)
Adds a new link property to an unfinished metanode.
voidvrAddPropertyMat3d(string metaName, string propName)
Adds a new mat3d property to an unfinished metanode.
voidvrAddPropertyMat3f(string metaName, string propName)
Adds a new mat3f property to an unfinished metanode.
voidvrAddPropertyMat3w(string metaName, string propName)
Adds a new mat3w property to an unfinished metanode.
voidvrAddPropertyMat4d(string metaName, string propName)
Adds a new mat4d property to an unfinished metanode.
voidvrAddPropertyMat4f(string metaName, string propName)
Adds a new mat4f property to an unfinished metanode.
voidvrAddPropertyMat4w(string metaName, string propName)
Adds a new mat4w property to an unfinished metanode.
voidvrAddPropertyObserver(string key, Any valueChangedCallback, string metaName, string propNames, vrnode user =nil)
Adds an observer of one or more properties of a metanode. The callback function will be executed once per update whenever the value of a specified property is changed.
voidvrAddPropertyString(string metaName, string propName, string defaultVal =0)
Adds a new string property to an unfinished metanode.
voidvrAddPropertyVec2d(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number minX =VR_DOUBLE_MIN, number minY =VR_DOUBLE_MIN, number maxX =VR_DOUBLE_MAX, number maxY =VR_DOUBLE_MAX)
Adds a new vec2d property to an unfinished metanode.
voidvrAddPropertyVec2f(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number minX =VR_FLOAT_MIN, number minY =VR_FLOAT_MIN, number maxX =VR_FLOAT_MAX, number maxY =VR_FLOAT_MAX)
Adds a new vec2f property to an unfinished metanode.
voidvrAddPropertyVec2i(string metaName, string propName, number defaultX =0, number defaultY =0, number minX =VR_INT_MIN, number minY =VR_INT_MIN, number maxX =VR_INT_MAX, number maxY =VR_INT_MAX)
Adds a new vec2i property to an unfinished metanode.
voidvrAddPropertyVec2w(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number minX =VR_WORLD_FLOAT_MIN, number minY =VR_WORLD_FLOAT_MIN, number maxX =VR_WORLD_FLOAT_MAX, number maxY =VR_WORLD_FLOAT_MAX)
Adds a new vec2w property to an unfinished metanode.
voidvrAddPropertyVec3d(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number defaultZ =0.0, number minX =VR_DOUBLE_MIN, number minY =VR_DOUBLE_MIN, number minZ =VR_DOUBLE_MIN, number maxX =VR_DOUBLE_MAX, number maxY =VR_DOUBLE_MAX, number maxZ =VR_DOUBLE_MAX)
Adds a new vec3d property to an unfinished metanode.
voidvrAddPropertyVec3f(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number defaultZ =0.0, number minX =VR_FLOAT_MIN, number minY =VR_FLOAT_MIN, number minZ =VR_FLOAT_MIN, number maxX =VR_FLOAT_MAX, number maxY =VR_FLOAT_MAX, number maxZ =VR_FLOAT_MAX)
Adds a new vec3f property to an unfinished metanode.
voidvrAddPropertyVec3i(string metaName, string propName, number defaultX =0, number defaultY =0, number defaultZ =0, number minX =VR_INT_MIN, number minY =VR_INT_MIN, number minZ =VR_INT_MIN, number maxX =VR_INT_MAX, number maxY =VR_INT_MAX, number maxZ =VR_INT_MAX)
Adds a new vec3i property to an unfinished metanode.
voidvrAddPropertyVec3w(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number defaultZ =0.0, number minX =VR_WORLD_FLOAT_MIN, number minY =VR_WORLD_FLOAT_MIN, number minZ =VR_WORLD_FLOAT_MIN, number maxX =VR_WORLD_FLOAT_MAX, number maxY =VR_WORLD_FLOAT_MAX, number maxZ =VR_WORLD_FLOAT_MAX)
Adds a new vec3w property to an unfinished metanode.
voidvrAddPropertyVec4d(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number defaultZ =0.0, number defaultW =0.0, number minX =VR_DOUBLE_MIN, number minY =VR_DOUBLE_MIN, number minZ =VR_DOUBLE_MIN, number minW =VR_DOUBLE_MIN, number maxX =VR_DOUBLE_MAX, number maxY =VR_DOUBLE_MAX, number maxZ =VR_DOUBLE_MAX, number maxW =VR_DOUBLE_MAX)
Adds a new vec4d property to an unfinished metanode.
voidvrAddPropertyVec4f(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number defaultZ =0.0, number defaultW =0.0, number minX =VR_FLOAT_MIN, number minY =VR_FLOAT_MIN, number minZ =VR_FLOAT_MIN, number minW =VR_FLOAT_MIN, number maxX =VR_FLOAT_MAX, number maxY =VR_FLOAT_MAX, number maxZ =VR_FLOAT_MAX, number maxW =VR_FLOAT_MAX)
Adds a new vec4f property to an unfinished metanode.
voidvrAddPropertyVec4i(string metaName, string propName, number defaultX =0, number defaultY =0, number defaultZ =0, number defaultW =0, number minX =VR_INT_MIN, number minY =VR_INT_MIN, number minZ =VR_INT_MIN, number minW =VR_INT_MIN, number maxX =VR_INT_MAX, number maxY =VR_INT_MAX, number maxZ =VR_INT_MAX, number maxW =VR_INT_MAX)
Adds a new vec4i property to an unfinished metanode.
voidvrAddPropertyVec4w(string metaName, string propName, number defaultX =0.0, number defaultY =0.0, number defaultZ =0.0, number defaultW =0.0, number minX =VR_WORLD_FLOAT_MIN, number minY =VR_WORLD_FLOAT_MIN, number minZ =VR_WORLD_FLOAT_MIN, number minW =VR_WORLD_FLOAT_MIN, number maxX =VR_WORLD_FLOAT_MAX, number maxY =VR_WORLD_FLOAT_MAX, number maxZ =VR_WORLD_FLOAT_MAX, number maxW =VR_WORLD_FLOAT_MAX)
Adds a new vec4w property to an unfinished metanode.
voidvrAddPropertyVectorBool(string metaName, string propName)
Adds a new boolean vector property to an unfinished metanode.
voidvrAddPropertyVectorChar(string metaName, string propName)
Adds a new character vector property to an unfinished metanode.
voidvrAddPropertyVectorDouble(string metaName, string propName)
Adds a new double vector property to an unfinished metanode.
voidvrAddPropertyVectorFloat(string metaName, string propName)
Adds a new float vector property to an unfinished metanode.
voidvrAddPropertyVectorInt(string metaName, string propName)
Adds a new integer vector property to an unfinished metanode.
voidvrAddPropertyVectorString(string metaName, string propName)
Adds a new string vector property to an unfinished metanode.
voidvrAddPropertyVectorWorldFloat(string metaName, string propName)
Adds a new world float vector property to an unfinished metanode.
voidvrAddPropertyWorldFloat(string metaName, string propName, number defaultVal =0.0, number minVal =VR_WORLD_FLOAT_MIN, number maxVal =VR_WORLD_FLOAT_MAX)
Adds a new world float property to an unfinished metanode.
voidvrCreateMetaNode(string metaName, number flags =0)
Creates a new metanode.
voidvrFinishMetaNode(string metaName)
Finishes a metanode (call this after creating it and adding properties, etc.)
tablevrGatherMetaNode(string metaName, vrnode node =nil)
Returns a list of all nodes of given type in the scene and optionally under a given node.
booleanvrMetaNodeExists(string metaName, boolean versioned =false)
Returns true if there is a metanode with the given name.
MULTI< string, number, string, number >vrMetaNodeGetProperty(string metaName, string propName)
Gets the name, type and type description of a MetaNode property.
MULTI< string, number, string, boolean, number >vrMetaNodeGetPropertyByIndex(string metaName, number idx)
Gets the name, type and type description of a MetaNode property.
numbervrMetaNodeGetPropertyCount(string metaName)
Gets the number of properties defined by a MetaNode.

Functions Documentation​

vrAddPropertyArrayBool​

void vrAddPropertyArrayBool(
    string metaName,
    string propName,
    number length,
    boolean ... 
)

Adds a new boolean array property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • length The length of the array
  • ... The default value(s) to apply to the array elements

vrAddPropertyArrayChar​

void vrAddPropertyArrayChar(
    string metaName,
    string propName,
    number length,
    number ... 
)

Adds a new character array property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • length The length of the array
  • ... The default value(s) to apply to the array elements

vrAddPropertyArrayDouble​

void vrAddPropertyArrayDouble(
    string metaName,
    string propName,
    number length,
    number ... 
)

Adds a new double array property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • length The length of the array
  • ... The default value(s) to apply to the array elements

vrAddPropertyArrayFloat​

void vrAddPropertyArrayFloat(
    string metaName,
    string propName,
    number length,
    number ... 
)

Adds a new float array property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • length The length of the array
  • ... The default value(s) to apply to the array elements

vrAddPropertyArrayInt​

void vrAddPropertyArrayInt(
    string metaName,
    string propName,
    number length,
    number ... 
)

Adds a new integer array property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • length The length of the array
  • ... The default value(s) to apply to the array elements

vrAddPropertyArrayWorldFloat​

void vrAddPropertyArrayWorldFloat(
    string metaName,
    string propName,
    number length,
    number ... 
)

Adds a new world float array property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • length The length of the array
  • ... The default value(s) to apply to the array elements

vrAddPropertyBool​

void vrAddPropertyBool(
    string metaName,
    string propName,
    boolean defaultVal =false
)

Adds a new boolean property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultVal The default value to apply to the property

vrAddPropertyChar​

void vrAddPropertyChar(
    string metaName,
    string propName,
    number defaultVal =0,
    number minVal =VR_CHAR_MIN,
    number maxVal =VR_CHAR_MAX
)

Adds a new character property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultVal The default value to apply to the property
  • minVal The minimum value that can be assigned to the property
  • maxVal The maximum value that can be assigned to the property

vrAddPropertyDouble​

void vrAddPropertyDouble(
    string metaName,
    string propName,
    number defaultVal =0.0,
    number minVal =VR_DOUBLE_MIN,
    number maxVal =VR_DOUBLE_MAX
)

Adds a new double property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultVal The default value to apply to the property
  • minVal The minimum value that can be assigned to the property
  • maxVal The maximum value that can be assigned to the property

vrAddPropertyFloat​

void vrAddPropertyFloat(
    string metaName,
    string propName,
    number defaultVal =0.0,
    number minVal =VR_FLOAT_MIN,
    number maxVal =VR_FLOAT_MAX
)

Adds a new float property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultVal The default value to apply to the property
  • minVal The minimum value that can be assigned to the property
  • maxVal The maximum value that can be assigned to the property

vrAddPropertyInt​

void vrAddPropertyInt(
    string metaName,
    string propName,
    number defaultVal =0,
    number minVal =VR_INT_MIN,
    number maxVal =VR_INT_MAX
)

Adds a new integer property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultVal The default value to apply to the property
  • minVal The minimum value that can be assigned to the property
  • maxVal The maximum value that can be assigned to the property
void vrAddPropertyLink(
    string metaName,
    string propName,
    string filter =0
)

Adds a new link property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • filter A comma-separated list of metanode types that can be linked to (e.g. "Assembly" or "Visual,Sequence")

vrAddPropertyMat3d​

void vrAddPropertyMat3d(
    string metaName,
    string propName
)

Adds a new mat3d property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyMat3f​

void vrAddPropertyMat3f(
    string metaName,
    string propName
)

Adds a new mat3f property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyMat3w​

void vrAddPropertyMat3w(
    string metaName,
    string propName
)

Adds a new mat3w property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyMat4d​

void vrAddPropertyMat4d(
    string metaName,
    string propName
)

Adds a new mat4d property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyMat4f​

void vrAddPropertyMat4f(
    string metaName,
    string propName
)

Adds a new mat4f property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyMat4w​

void vrAddPropertyMat4w(
    string metaName,
    string propName
)

Adds a new mat4w property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyObserver​

void vrAddPropertyObserver(
    string key,
    Any valueChangedCallback,
    string metaName,
    string propNames,
    vrnode user =nil
)

Adds an observer of one or more properties of a metanode. The callback function will be executed once per update whenever the value of a specified property is changed.

Parameters:

  • key A unique key for this observer. This can be passed to the vrRemoveObserver function to remove this observer
  • valueChangedCallback A Lua function to execute whenever a specified property is changed. This function should have a signature like "function(node, value1, ...)" - i.e. with a value argument for each observed property. It can be a string name of a global function or a Lua function object
  • metaName The name of the metanode to observe for property changes (i.e. "Assembly")
  • propNames A comma-separated list of properties to observe (e.g. "Enabled" or "Enabled,Transform")
  • user The user associated with this observer (optional - defaults to current user)

vrAddPropertyString​

void vrAddPropertyString(
    string metaName,
    string propName,
    string defaultVal =0
)

Adds a new string property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultVal The default value to apply to the property

vrAddPropertyVec2d​

void vrAddPropertyVec2d(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number minX =VR_DOUBLE_MIN,
    number minY =VR_DOUBLE_MIN,
    number maxX =VR_DOUBLE_MAX,
    number maxY =VR_DOUBLE_MAX
)

Adds a new vec2d property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property

vrAddPropertyVec2f​

void vrAddPropertyVec2f(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number minX =VR_FLOAT_MIN,
    number minY =VR_FLOAT_MIN,
    number maxX =VR_FLOAT_MAX,
    number maxY =VR_FLOAT_MAX
)

Adds a new vec2f property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property

vrAddPropertyVec2i​

void vrAddPropertyVec2i(
    string metaName,
    string propName,
    number defaultX =0,
    number defaultY =0,
    number minX =VR_INT_MIN,
    number minY =VR_INT_MIN,
    number maxX =VR_INT_MAX,
    number maxY =VR_INT_MAX
)

Adds a new vec2i property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property

vrAddPropertyVec2w​

void vrAddPropertyVec2w(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number minX =VR_WORLD_FLOAT_MIN,
    number minY =VR_WORLD_FLOAT_MIN,
    number maxX =VR_WORLD_FLOAT_MAX,
    number maxY =VR_WORLD_FLOAT_MAX
)

Adds a new vec2w property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property

vrAddPropertyVec3d​

void vrAddPropertyVec3d(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number defaultZ =0.0,
    number minX =VR_DOUBLE_MIN,
    number minY =VR_DOUBLE_MIN,
    number minZ =VR_DOUBLE_MIN,
    number maxX =VR_DOUBLE_MAX,
    number maxY =VR_DOUBLE_MAX,
    number maxZ =VR_DOUBLE_MAX
)

Adds a new vec3d property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property

vrAddPropertyVec3f​

void vrAddPropertyVec3f(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number defaultZ =0.0,
    number minX =VR_FLOAT_MIN,
    number minY =VR_FLOAT_MIN,
    number minZ =VR_FLOAT_MIN,
    number maxX =VR_FLOAT_MAX,
    number maxY =VR_FLOAT_MAX,
    number maxZ =VR_FLOAT_MAX
)

Adds a new vec3f property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property

vrAddPropertyVec3i​

void vrAddPropertyVec3i(
    string metaName,
    string propName,
    number defaultX =0,
    number defaultY =0,
    number defaultZ =0,
    number minX =VR_INT_MIN,
    number minY =VR_INT_MIN,
    number minZ =VR_INT_MIN,
    number maxX =VR_INT_MAX,
    number maxY =VR_INT_MAX,
    number maxZ =VR_INT_MAX
)

Adds a new vec3i property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property

vrAddPropertyVec3w​

void vrAddPropertyVec3w(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number defaultZ =0.0,
    number minX =VR_WORLD_FLOAT_MIN,
    number minY =VR_WORLD_FLOAT_MIN,
    number minZ =VR_WORLD_FLOAT_MIN,
    number maxX =VR_WORLD_FLOAT_MAX,
    number maxY =VR_WORLD_FLOAT_MAX,
    number maxZ =VR_WORLD_FLOAT_MAX
)

Adds a new vec3w property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property

vrAddPropertyVec4d​

void vrAddPropertyVec4d(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number defaultZ =0.0,
    number defaultW =0.0,
    number minX =VR_DOUBLE_MIN,
    number minY =VR_DOUBLE_MIN,
    number minZ =VR_DOUBLE_MIN,
    number minW =VR_DOUBLE_MIN,
    number maxX =VR_DOUBLE_MAX,
    number maxY =VR_DOUBLE_MAX,
    number maxZ =VR_DOUBLE_MAX,
    number maxW =VR_DOUBLE_MAX
)

Adds a new vec4d property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • defaultW The default w value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • minW The minimum w value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property
  • maxW The maximum w value that can be assigned to the property

vrAddPropertyVec4f​

void vrAddPropertyVec4f(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number defaultZ =0.0,
    number defaultW =0.0,
    number minX =VR_FLOAT_MIN,
    number minY =VR_FLOAT_MIN,
    number minZ =VR_FLOAT_MIN,
    number minW =VR_FLOAT_MIN,
    number maxX =VR_FLOAT_MAX,
    number maxY =VR_FLOAT_MAX,
    number maxZ =VR_FLOAT_MAX,
    number maxW =VR_FLOAT_MAX
)

Adds a new vec4f property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • defaultW The default w value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • minW The minimum w value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property
  • maxW The maximum w value that can be assigned to the property

vrAddPropertyVec4i​

void vrAddPropertyVec4i(
    string metaName,
    string propName,
    number defaultX =0,
    number defaultY =0,
    number defaultZ =0,
    number defaultW =0,
    number minX =VR_INT_MIN,
    number minY =VR_INT_MIN,
    number minZ =VR_INT_MIN,
    number minW =VR_INT_MIN,
    number maxX =VR_INT_MAX,
    number maxY =VR_INT_MAX,
    number maxZ =VR_INT_MAX,
    number maxW =VR_INT_MAX
)

Adds a new vec4i property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • defaultW The default w value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • minW The minimum w value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property
  • maxW The maximum w value that can be assigned to the property

vrAddPropertyVec4w​

void vrAddPropertyVec4w(
    string metaName,
    string propName,
    number defaultX =0.0,
    number defaultY =0.0,
    number defaultZ =0.0,
    number defaultW =0.0,
    number minX =VR_WORLD_FLOAT_MIN,
    number minY =VR_WORLD_FLOAT_MIN,
    number minZ =VR_WORLD_FLOAT_MIN,
    number minW =VR_WORLD_FLOAT_MIN,
    number maxX =VR_WORLD_FLOAT_MAX,
    number maxY =VR_WORLD_FLOAT_MAX,
    number maxZ =VR_WORLD_FLOAT_MAX,
    number maxW =VR_WORLD_FLOAT_MAX
)

Adds a new vec4w property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultX The default x value to apply to the property
  • defaultY The default y value to apply to the property
  • defaultZ The default z value to apply to the property
  • defaultW The default w value to apply to the property
  • minX The minimum x value that can be assigned to the property
  • minY The minimum y value that can be assigned to the property
  • minZ The minimum z value that can be assigned to the property
  • minW The minimum w value that can be assigned to the property
  • maxX The maximum x value that can be assigned to the property
  • maxY The maximum y value that can be assigned to the property
  • maxZ The maximum z value that can be assigned to the property
  • maxW The maximum w value that can be assigned to the property

vrAddPropertyVectorBool​

void vrAddPropertyVectorBool(
    string metaName,
    string propName
)

Adds a new boolean vector property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyVectorChar​

void vrAddPropertyVectorChar(
    string metaName,
    string propName
)

Adds a new character vector property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyVectorDouble​

void vrAddPropertyVectorDouble(
    string metaName,
    string propName
)

Adds a new double vector property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyVectorFloat​

void vrAddPropertyVectorFloat(
    string metaName,
    string propName
)

Adds a new float vector property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyVectorInt​

void vrAddPropertyVectorInt(
    string metaName,
    string propName
)

Adds a new integer vector property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyVectorString​

void vrAddPropertyVectorString(
    string metaName,
    string propName
)

Adds a new string vector property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyVectorWorldFloat​

void vrAddPropertyVectorWorldFloat(
    string metaName,
    string propName
)

Adds a new world float vector property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property

vrAddPropertyWorldFloat​

void vrAddPropertyWorldFloat(
    string metaName,
    string propName,
    number defaultVal =0.0,
    number minVal =VR_WORLD_FLOAT_MIN,
    number maxVal =VR_WORLD_FLOAT_MAX
)

Adds a new world float property to an unfinished metanode.

Parameters:

  • metaName The name of the metanode
  • propName The name of the property
  • defaultVal The default value to apply to the property
  • minVal The minimum value that can be assigned to the property
  • maxVal The maximum value that can be assigned to the property

vrCreateMetaNode​

void vrCreateMetaNode(
    string metaName,
    number flags =0
)

Creates a new metanode.

Parameters:

  • metaName The name of the metanode
  • flags The flags to apply to the metanode

vrFinishMetaNode​

void vrFinishMetaNode(
    string metaName
)

Finishes a metanode (call this after creating it and adding properties, etc.)

Parameters:

  • metaName The name of the metanode

vrGatherMetaNode​

table vrGatherMetaNode(
    string metaName,
    vrnode node =nil
)

Returns a list of all nodes of given type in the scene and optionally under a given node.

Parameters:

  • metaName The type of node to list
  • node The node to start searching from

Return: Array of nodes of the specified type

vrMetaNodeExists​

boolean vrMetaNodeExists(
    string metaName,
    boolean versioned =false
)

Returns true if there is a metanode with the given name.

Parameters:

  • metaName The metanode name to query
  • versioned Whether to query versioned metanode names

Return: True if exists

vrMetaNodeGetProperty​

MULTI< string, number, string, number > vrMetaNodeGetProperty(
    string metaName,
    string propName
)

Gets the name, type and type description of a MetaNode property.

Return:

  • The name of the property
  • The type of the property
  • The description of the type of property
  • The number of elements in the property (e.g. greater than 1 for arrays)

vrMetaNodeGetPropertyByIndex​

MULTI< string, number, string, boolean, number > vrMetaNodeGetPropertyByIndex(
    string metaName,
    number idx
)

Gets the name, type and type description of a MetaNode property.

Parameters:

  • metaName The name of the metanode
  • idx The index of the property (zero based).

Return:

  • The name of the property
  • The type of the property
  • The description of the type of property
  • Whether the property can be saved in a file
  • The number of elements in the property (e.g. greater than 1 for arrays)

vrMetaNodeGetPropertyCount​

number vrMetaNodeGetPropertyCount(
    string metaName
)

Gets the number of properties defined by a MetaNode.

Parameters:

  • metaName The name of the metanode

Return: The number of properties on the metanode