Nodes

Functions for interacting with nodes.

Classes

Type	Name
struct	vrnode A node in the tree.

Functions

Type	Name
vrnode	vrCopyNode(vrnode fromNode, vrnode toNode, boolean recursive =true, boolean ancestors =false, boolean noSave =false, boolean noHistory =false) Copies a node, and optionally its children, and adds that as a child of another node.
void	vrCopyNodeValues(vrnode fromNode, vrnode toNode, number mask) Copies the property values from one node to another of the same MetaNode type.
vrnode	vrCreateNode(string metaName, string nodeName, vrnode parent, number flags =0, vrnode beforeSibling =nil) Creates a new node and attaches it to a parent node.
void	vrDeleteNode(vrnode node) Deletes a node and, if present, its children.
void	vrDescribeNode(vrnode node) Prints to the log a description of the node, its property names and values.
vrnode	vrGetOrCreateNode(string metaName, string nodeName, vrnode parent, number flags =0, vrnode beforeSibling =nil) Gets an existing node or creates one (creation attaches it to a parent node).
void	vrNodeArrayClear(node/property nodeOrProp, string propName) Clears an array property.
Any	vrNodeArrayGetElement(node/property nodeOrProp, string propName, integer element) Gets the value of an element of an array property.
number	vrNodeArrayGetSize(node/property nodeOrProp, string propName) Gets the size of an array property.
void	vrNodeArrayPop(node/property nodeOrProp, string propName, number count) Pops a value from the end of an array property.
void	vrNodeArrayPush(node/property nodeOrProp, string propName, ... ) Pushes a new value to the end of an array property.
void	vrNodeArraySet(node/property nodeOrProp, string propName, ... ) Sets the values of an array property to a new array.
void	vrNodeArraySetElement(node/property nodeOrProp, string propName, integer element, ... ) Sets the value of one or more existing element of an array property.
void	vrNodeArraySetSize(node/property nodeOrProp, string propName, number newSize) Sets the size of an array property.
void	vrNodeCaptureTransform(vrnode node, boolean recursive, boolean overwrite =false) Captures the transform of a node, overwriting any existing saved transform.
void	vrNodeComposeLocalTransform(vrnode node, vrvec3 p, vrvec3 r, vrvec3 s, string prop =0) Compose the nodes local transform property from seperate position, rotation and scale tables / vectors.
void	vrNodeComposeTransform(vrnode node, vrvec3 p, vrvec3 r, vrvec3 s) Compose the nodes world transform property from seperate position, rotation and scale tables / vectors.
void	vrNodeCopyValue(vrnode fromNode, vrnode toNode, string propName) Copies the value of a property from one node to another of the same MetaNode type.
MULTI< vrvec3, vrvec3, vrvec3 >	vrNodeDecomposeLocalTransform(vrnode node, string prop =0) Decomposes the nodes local transform property into seperate postion, rotation and scale tables / vectors.
MULTI< vrvec3, vrvec3, vrvec3 >	vrNodeDecomposeTransform(vrnode node) Decomposes the nodes world transform property into seperate postion, rotation and scale tables / vectors.
vrnode	vrNodeFindChild(vrnode node, string path, boolean caseSensitive =true) Finds a descendant of a node by path.
void	vrNodeForEachChild(vrnode node, Any function) Calls a function for each child of a node.
void	vrNodeForEachChildOfType(vrnode node, string metaType, Any function) Calls a function for each child of a node that matches a specified type.
vrnode	vrNodeGetAncestor(vrnode node, string metaName) Gets the first ancestor of the specified type.
table	vrNodeGetBacklinks(vrnode node) Gets all nodes that link to this node.
vrnode	vrNodeGetChild(vrnode node, string metaType =0, string name =0) Gets the first child of a node.
MULTI< vrvec3, vrvec3 >	vrNodeGetChildBoundingBox(vrnode node) Gets the combined bounding box of all a nodes children, relative to that node.
vrnode	vrNodeGetChildByIndex(vrnode node, number idx) Gets a nodes child by its zero-based index. Note: this function may result in poor performance when iterating over lots of nodes - use vrNodeGetChild and vrNodeGetSibling instead (see the Best Practices section of the Programming Guide for more info).
number	vrNodeGetChildCount(vrnode node) Counts the children of a node. Note: this function may result in poor performance when iterating over lots of nodes - use vrNodeGetChild and vrNodeGetSibling instead (see the Best Practices section of the Programming Guide for more info).
MULTI< vrvec3, vrvec3 >	vrNodeGetLocalBoundingBox(vrnode node) Gets the local bounding box of a node.
vrvec3	vrNodeGetLocalBoundingBoxCentre(vrnode node) Gets the centre of the local bounding box of a node.
vrvec3	vrNodeGetLocalBoundingSphereCentre(vrnode node) Gets the centre of the local bounding sphere of a node.
MULTI< vrvec3, number >	vrNodeGetLocalBounds(vrnode node) Gets the local bounding box and sphere of a node.
void	vrNodeGetLocallyModified(vrnode node) Queries whether or not this node's last modification was made by the local visionary render instance.
vrvec3	vrNodeGetLocalPosition(vrnode node, string prop =0) Gets the local position of the node.
number	vrNodeGetLocalPositionX(vrnode node, string prop =0) Gets the local x position of the node.
number	vrNodeGetLocalPositionY(vrnode node, string prop =0) Gets the local y position of the node.
number	vrNodeGetLocalPositionZ(vrnode node, string prop =0) Gets the local z position of the node.
vrvec3	vrNodeGetLocalRotation(vrnode node, string prop =0) Gets the local rotation of the node.
number	vrNodeGetLocalRotationX(vrnode node, string prop =0) Gets the local x rotation of the node.
number	vrNodeGetLocalRotationY(vrnode node, string prop =0) Gets the local y rotation of the node.
number	vrNodeGetLocalRotationZ(vrnode node, string prop =0) Gets the local z rotation of the node.
vrvec3	vrNodeGetLocalScale(vrnode node, string prop =0) Gets the local scale of the node.
number	vrNodeGetLocalScaleX(vrnode node, string prop =0) Gets the local x scale of the node.
number	vrNodeGetLocalScaleY(vrnode node, string prop =0) Gets the local y scale of the node.
number	vrNodeGetLocalScaleZ(vrnode node, string prop =0) Gets the local z scale of the node.
string	vrNodeGetMetaNode(vrnode node, boolean versioned =false) Gets the name of the MetaNode that a node is an instance of. This can also be referred to as the node type.
string	vrNodeGetName(vrnode node) Gets the name of a node.
boolean	vrNodeGetNoHistory(vrnode node) Queries whether this node can be recorded in the history for undo/redo operations.
boolean	vrNodeGetNoSave(vrnode node) Queries whether this node can be saved in a VRText/VRNative file.
boolean	vrNodeGetNoSimulation(vrnode node) Queries whether this node can be affected by simulations, such as physics and collision.
vrnode	vrNodeGetParent(vrnode node) Gets the parent of a node.
string	vrNodeGetPath(vrnode node) Gets the encoded path to a node relative to the tree root.
vrvec3	vrNodeGetPosition(vrnode node) Gets the world position of the node.
number	vrNodeGetPositionX(vrnode node) Gets the world x position of the node.
number	vrNodeGetPositionY(vrnode node) Gets the world y position of the node.
number	vrNodeGetPositionZ(vrnode node) Gets the world z position of the node.
vrnode	vrNodeGetPreviousSibling(vrnode node, string metaType =0, string name =0) Gets the previous sibling (adjacent) node to a node.
string	vrNodeGetRelativePath(vrnode node, vrnode relativeTo) Gets the encoded path to a node, relative to another node.
MULTI< vrvec3, vrvec3, vrvec3 >	vrNodeGetRelativeTransform(vrnode node, string propName, vrnode otherNode) Gets the position, rotation and scale of the world transform of one node relative to another.
vrvec3	vrNodeGetRotation(vrnode node) Gets the world rotation of the node.
number	vrNodeGetRotationX(vrnode node) Gets the world x rotation of the node.
number	vrNodeGetRotationY(vrnode node) Gets the world y rotation of the node.
number	vrNodeGetRotationZ(vrnode node) Gets the world z rotation of the node.
vrvec3	vrNodeGetScale(vrnode node) Gets the world scale of the node.
number	vrNodeGetScaleX(vrnode node) Gets the world x scale of the node.
number	vrNodeGetScaleY(vrnode node) Gets the world y scale of the node.
number	vrNodeGetScaleZ(vrnode node) Gets the world z scale of the node.
vrnode	vrNodeGetSibling(vrnode node, string metaType =0, string name =0) Gets the sibling (adjacent) node to a node.
vrnode	vrNodeGetTail(vrnode node, string metaType =0, string name =0) Gets the last child of a node.
table	vrNodeGetTraits(vrnode node) Gets the list of traits that this node has. Can also be thought of as the base class of a node (e.g. Texture, Viewport, etc). This function is expensive and can affect performance. To check a specific trait use vrNodeHasTrait.
Any	vrNodeGetValue(vrnode node, string propName) Gets the value of a property of a node.
Any	vrNodeGetValueByIndex(vrnode node, number idx) Gets the value of a property of a node finding the property by its index.
boolean	vrNodeHasTrait(vrnode node, string traitName) Checks if the node is of a type with a specific trait. This is a lot faster than vrNodeGetTraits.
boolean	vrNodeIsAncestor(vrnode node1, vrnode node2) Query whether the first specified node is an ancestor of the second.
boolean	vrNodeIsInGroup(vrnode node, vrnode groupNode) Returns true is the node is in the group.
boolean	vrNodeIsLocal(vrnode node) Query whether the specified node belongs to the local network user.
boolean	vrNodeIsMetaFiltered(vrnode view, vrnode node) Returns true if the node's meta type is filtered in the specified view.
void	vrNodeRestoreTransform(vrnode node, boolean recursive) Restores the captured transform of a node.
vrnode	vrNodeRoot(vrnode node) Finds the root tree node. This is almost always equivilent to vrTreeRoot.
void	vrNodeSetLocalPosition(vrnode node, vrvec3 v, string prop =0) Sets the local position of the node.
void	vrNodeSetLocalPositionX(vrnode node, number d, string prop =0) Sets the local x position of the node.
void	vrNodeSetLocalPositionY(vrnode node, number d, string prop =0) Sets the local y position of the node.
void	vrNodeSetLocalPositionZ(vrnode node, number d, string prop =0) Sets the local z position of the node.
void	vrNodeSetLocalRotation(vrnode node, vrvec3 v, string prop =0) Sets the local rotation of the node.
void	vrNodeSetLocalRotationX(vrnode node, number d, string prop =0) Sets the local x rotation of the node.
void	vrNodeSetLocalRotationY(vrnode node, number d, string prop =0) Sets the local y rotation of the node.
void	vrNodeSetLocalRotationZ(vrnode node, number d, string prop =0) Sets the local z rotation of the node.
void	vrNodeSetLocalScale(vrnode node, vrvec3 v, string prop =0) Sets the local scale of the noed.
void	vrNodeSetLocalScaleX(vrnode node, number d, string prop =0) Sets the local x scale of the node.
void	vrNodeSetLocalScaleY(vrnode node, number d, string prop =0) Sets the local y scale of the node.
void	vrNodeSetLocalScaleZ(vrnode node, number d, string prop =0) Sets the local z scale of the node.
void	vrNodeSetName(vrnode node, string newName) Sets the name of a node.
void	vrNodeSetNoHistory(vrnode node, boolean noHistory) Specifies whether this node can be recorded in the history for undo/redo operations.
void	vrNodeSetNoSave(vrnode node, boolean noSave) Specifies whether this node can be saved in a VRText/VRNative file.
void	vrNodeSetNoSimulation(vrnode node, boolean noSimulation) Specifies whether this node should be affected by simulations, such as physics and collision.
void	vrNodeSetParent(vrnode node, vrnode parent =nil, vrnode beforeSibling =nil, boolean preserveWorldTransform =false) Sets the parent of a node.
void	vrNodeSetPosition(vrnode node, vrvec3 v) Sets the world position of the node.
void	vrNodeSetPositionX(vrnode node, number d) Sets the world x position of the node.
void	vrNodeSetPositionY(vrnode node, number d) Sets the world y position of the node.
void	vrNodeSetPositionZ(vrnode node, number d) Sets the world z position of the node.
void	vrNodeSetRelativeTransform(vrnode node, string propName, vrnode otherNode, Any vpos, Any vrot, Any vscale) Sets the position, rotation and scale of the world transform of a node relative to another.
void	vrNodeSetRotation(vrnode node, vrvec3 v) Sets the world rotation of the node.
void	vrNodeSetRotationX(vrnode node, number d) Sets the world x rotation of the node.
void	vrNodeSetRotationY(vrnode node, number d) Sets the world y rotation of the node.
void	vrNodeSetRotationZ(vrnode node, number d) Sets the world z rotation of the node.
void	vrNodeSetScale(vrnode node, vrvec3 v) Sets the world scale fo the noed.
void	vrNodeSetScaleX(vrnode node, number d) Sets the world x scale of the node.
void	vrNodeSetScaleY(vrnode node, number d) Sets the world y scale of the node.
void	vrNodeSetScaleZ(vrnode node, number d) Sets the world z scale of the node.
void	vrNodeSetValue(vrnode node, string propName, Any value) Sets the value of one of the properties of a node.
void	vrNodeSetValueByIndex(vrnode node, number idx, Any value) Sets the value of one of the properties of a node finding the property by its index.

Functions Documentation

vrCopyNode

vrnode vrCopyNode(
    vrnode fromNode,
    vrnode toNode,
    boolean recursive =true,
    boolean ancestors =false,
    boolean noSave =false,
    boolean noHistory =false
)

Copies a node, and optionally its children, and adds that as a child of another node.

Parameters:

• fromNode The node to copy from
• toNode The node which will become the parent of the copy
• recursive Whether to also copy descendants
• ancestors Whether to also copy ancestors (excluding their children) that lead to fromNode. In this case the return value is the clone of the oldest ancestor
• noSave Whether the new copy is able to be saved in files
• noHistory Whether the new copy should have an undo history

Return: The new copy of the node

vrCopyNodeValues

void vrCopyNodeValues(
    vrnode fromNode,
    vrnode toNode,
    number mask
)

Copies the property values from one node to another of the same MetaNode type.

Parameters:

• fromNode The node to copy properties from
• toNode The node to copy to
• mask Bitmask where any bits set to 0 mean that property will not be copied. Use vrBitsToInteger to create this bit mask

vrCreateNode

vrnode vrCreateNode(
    string metaName,
    string nodeName,
    vrnode parent,
    number flags =0,
    vrnode beforeSibling =nil
)

Creates a new node and attaches it to a parent node.

Parameters:

• metaName The type of node to create
• nodeName The name of the newly created node
• parent The parent of the newly created node
• flags Any additional flags to set on the new node
• beforeSibling The sibling to insert this before (defaults to inserting at the end of the parent's children)

Return: The newly created node

vrDeleteNode

void vrDeleteNode(
    vrnode node
)

Deletes a node and, if present, its children.

Parameters:

• node The node to delete

vrDescribeNode

void vrDescribeNode(
    vrnode node
)

Prints to the log a description of the node, its property names and values.

vrGetOrCreateNode

vrnode vrGetOrCreateNode(
    string metaName,
    string nodeName,
    vrnode parent,
    number flags =0,
    vrnode beforeSibling =nil
)

Gets an existing node or creates one (creation attaches it to a parent node).

Parameters:

• metaName The type of node to find/create
• nodeName The name of node to find, or set on the newly created node
• parent The parent node
• flags Any additional flags to set on the new node
• beforeSibling The sibling to insert this before (defaults to inserting at the end of the parent's children)

Return: The first child of parent with specified name and type, or the newly created node if there wasn't a match

vrNodeArrayClear

void vrNodeArrayClear(
    node/property nodeOrProp,
    string propName
)

Clears an array property.

Parameters:

• nodeOrProp The node or property to modify
• propName If a node was specified, the name of the array property

vrNodeArrayGetElement

Any vrNodeArrayGetElement(
    node/property nodeOrProp,
    string propName,
    integer element
)

Gets the value of an element of an array property.

Parameters:

• nodeOrProp The node or property to read the element from
• propName If a node was specified, the name of the array property
• element The index of the array element (zero based)

Return: The value in the array at the specified index

vrNodeArrayGetSize

number vrNodeArrayGetSize(
    node/property nodeOrProp,
    string propName
)

Gets the size of an array property.

Parameters:

• nodeOrProp The node or property to read
• propName If a node was specified, the name of the array property

Return: The size of the array property

vrNodeArrayPop

void vrNodeArrayPop(
    node/property nodeOrProp,
    string propName,
    number count
)

Pops a value from the end of an array property.

Parameters:

• nodeOrProp The node or property to modify
• propName If a node was specified, the name of the array property
• count Number of values to pop (default: 1)

vrNodeArrayPush

void vrNodeArrayPush(
    node/property nodeOrProp,
    string propName,
    ... 
)

Pushes a new value to the end of an array property.

Parameters:

• nodeOrProp The node or property to modify
• propName If a node was specified, the name of the array property
• ... Values to insert into the array. Specify as many as needed as individual values, tables or vectors.

vrNodeArraySet

void vrNodeArraySet(
    node/property nodeOrProp,
    string propName,
    ... 
)

Sets the values of an array property to a new array.

Parameters:

• nodeOrProp The node or property to modify
• propName If a node was specified, the name of the array property
• ... Values to insert into the array. Specify as many as needed as individual values, tables or vectors.

vrNodeArraySetElement

void vrNodeArraySetElement(
    node/property nodeOrProp,
    string propName,
    integer element,
    ... 
)

Sets the value of one or more existing element of an array property.

Parameters:

• nodeOrProp The node or property to modify
• propName If a node was specified, the name of the array property
• element The index of the first element to set
• ... The value(s) to set at the specified index

vrNodeArraySetSize

void vrNodeArraySetSize(
    node/property nodeOrProp,
    string propName,
    number newSize
)

Sets the size of an array property.

Parameters:

• nodeOrProp The node or property to modify
• propName If a node was specified, the name of the array property
• newSize New size of the array property

vrNodeCaptureTransform

void vrNodeCaptureTransform(
    vrnode node,
    boolean recursive,
    boolean overwrite =false
)

Captures the transform of a node, overwriting any existing saved transform.

Parameters:

• node The node to capture
• recursive True captures all the child transforms too.
• overwrite True overwrites any exisiting saved transform. False will only create a new one if there is not a saved one already.

vrNodeComposeLocalTransform

void vrNodeComposeLocalTransform(
    vrnode node,
    vrvec3 p,
    vrvec3 r,
    vrvec3 s,
    string prop =0
)

Compose the nodes local transform property from seperate position, rotation and scale tables / vectors.

Parameters:

• node The node to set the local transform of
• p The local position
• r The local rotation
• s The local scale
• prop The name of the property containing the transform

vrNodeComposeTransform

void vrNodeComposeTransform(
    vrnode node,
    vrvec3 p,
    vrvec3 r,
    vrvec3 s
)

Compose the nodes world transform property from seperate position, rotation and scale tables / vectors.

Parameters:

• node The node to set the transform of
• p The world position
• r The world rotation
• s The world scale

vrNodeCopyValue

void vrNodeCopyValue(
    vrnode fromNode,
    vrnode toNode,
    string propName
)

Copies the value of a property from one node to another of the same MetaNode type.

Parameters:

• fromNode The node to copy from
• toNode The node to copy to
• propName The name of the property to copy

vrNodeDecomposeLocalTransform

MULTI< vrvec3, vrvec3, vrvec3 > vrNodeDecomposeLocalTransform(
    vrnode node,
    string prop =0
)

Decomposes the nodes local transform property into seperate postion, rotation and scale tables / vectors.

Parameters:

• node The node to get the transform of
• prop The name of the property containing the transform

Return:

• The local position
• The local rotation
• The local scale

vrNodeDecomposeTransform

MULTI< vrvec3, vrvec3, vrvec3 > vrNodeDecomposeTransform(
    vrnode node
)

Decomposes the nodes world transform property into seperate postion, rotation and scale tables / vectors.

Parameters:

• node The node to get the transform of

Return:

• The world position
• The world rotation
• The world scale

vrNodeFindChild

vrnode vrNodeFindChild(
    vrnode node,
    string path,
    boolean caseSensitive =true
)

Finds a descendant of a node by path.

Parameters:

• node The node to search from
• path The path or name of the node to search from
• caseSensitive Whether to match case in the path

Return: The node at the specified path, or false if not found

vrNodeForEachChild

void vrNodeForEachChild(
    vrnode node,
    Any function
)

Calls a function for each child of a node.

Parameters:

• node The parent node
• function The function to call for each child node. This function should have a signature of function(node). This can be a string name of a global function, or a lua function object. If the function returns a value other than nil, the function will not be called for further children and the value will be returned to the caller

vrNodeForEachChildOfType

void vrNodeForEachChildOfType(
    vrnode node,
    string metaType,
    Any function
)

Calls a function for each child of a node that matches a specified type.

Parameters:

• node The parent node
• metaType The type of child nodes to find
• function The function to call for each child node. This function should have a signature of function(node). This can be a string name of a global function, or a lua function object. If the function returns a value other than nil, the function will not be called for further children and the value will be returned to the caller

vrNodeGetAncestor

vrnode vrNodeGetAncestor(
    vrnode node,
    string metaName
)

Gets the first ancestor of the specified type.

Parameters:

• node The node to get the ancestor of
• metaName The type of ancestor to look for

Return: Ancestor node of the specified type, or false if there isn't one

vrNodeGetBacklinks

table vrNodeGetBacklinks(
    vrnode node
)

Gets all nodes that link to this node.

Parameters:

• node The node to look for references to

Return: Array of nodes that have link properties pointing to this node

vrNodeGetChild

vrnode vrNodeGetChild(
    vrnode node,
    string metaType =0,
    string name =0
)

Gets the first child of a node.

Parameters:

• node The node to get the child of
• metaType The type of child to get
• name The name of the child to get

Return: The first child node, of the type in the metaType parameter, if specified, or false if there are no suitable child nodes

vrNodeGetChildBoundingBox

MULTI< vrvec3, vrvec3 > vrNodeGetChildBoundingBox(
    vrnode node
)

Gets the combined bounding box of all a nodes children, relative to that node.

Return:

• The min point of the bounding box
• The max point of the bounding box

vrNodeGetChildByIndex

vrnode vrNodeGetChildByIndex(
    vrnode node,
    number idx
)

Gets a nodes child by its zero-based index. Note: this function may result in poor performance when iterating over lots of nodes - use vrNodeGetChild and vrNodeGetSibling instead (see the Best Practices section of the Programming Guide for more info).

Parameters:

• node The node to get the child of
• idx The index of the child (zero based)

Return: The specified child node, or false if out of range

vrNodeGetChildCount

number vrNodeGetChildCount(
    vrnode node
)

Counts the children of a node. Note: this function may result in poor performance when iterating over lots of nodes - use vrNodeGetChild and vrNodeGetSibling instead (see the Best Practices section of the Programming Guide for more info).

Parameters:

• node The node whose children to count

Return: The number of direct child nodes

vrNodeGetLocalBoundingBox

MULTI< vrvec3, vrvec3 > vrNodeGetLocalBoundingBox(
    vrnode node
)

Gets the local bounding box of a node.

Return:

• The min point of the bounding box
• The max point of the bounding box

vrNodeGetLocalBoundingBoxCentre

vrvec3 vrNodeGetLocalBoundingBoxCentre(
    vrnode node
)

Gets the centre of the local bounding box of a node.

vrNodeGetLocalBoundingSphereCentre

vrvec3 vrNodeGetLocalBoundingSphereCentre(
    vrnode node
)

Gets the centre of the local bounding sphere of a node.

vrNodeGetLocalBounds

MULTI< vrvec3, number > vrNodeGetLocalBounds(
    vrnode node
)

Gets the local bounding box and sphere of a node.

Return:

• The dimensions of the local bounding box
• The radius of the bounding sphere

vrNodeGetLocallyModified

void vrNodeGetLocallyModified(
    vrnode node
)

Queries whether or not this node's last modification was made by the local visionary render instance.

Parameters:

• node The node to query.

vrNodeGetLocalPosition

vrvec3 vrNodeGetLocalPosition(
    vrnode node,
    string prop =0
)

Gets the local position of the node.

Parameters:

• node The node to get the vector from
• prop The name of the property to get

Return: The vector value

vrNodeGetLocalPositionX

number vrNodeGetLocalPositionX(
    vrnode node,
    string prop =0
)

Gets the local x position of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalPositionY

number vrNodeGetLocalPositionY(
    vrnode node,
    string prop =0
)

Gets the local y position of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalPositionZ

number vrNodeGetLocalPositionZ(
    vrnode node,
    string prop =0
)

Gets the local z position of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalRotation

vrvec3 vrNodeGetLocalRotation(
    vrnode node,
    string prop =0
)

Gets the local rotation of the node.

Parameters:

• node The node to get the vector from
• prop The name of the property to get

Return: The vector value

vrNodeGetLocalRotationX

number vrNodeGetLocalRotationX(
    vrnode node,
    string prop =0
)

Gets the local x rotation of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalRotationY

number vrNodeGetLocalRotationY(
    vrnode node,
    string prop =0
)

Gets the local y rotation of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalRotationZ

number vrNodeGetLocalRotationZ(
    vrnode node,
    string prop =0
)

Gets the local z rotation of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalScale

vrvec3 vrNodeGetLocalScale(
    vrnode node,
    string prop =0
)

Gets the local scale of the node.

Parameters:

• node The node to get the vector from
• prop The name of the property to get

Return: The vector value

vrNodeGetLocalScaleX

number vrNodeGetLocalScaleX(
    vrnode node,
    string prop =0
)

Gets the local x scale of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalScaleY

number vrNodeGetLocalScaleY(
    vrnode node,
    string prop =0
)

Gets the local y scale of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetLocalScaleZ

number vrNodeGetLocalScaleZ(
    vrnode node,
    string prop =0
)

Gets the local z scale of the node.

Parameters:

• node The node to read the value from
• prop The name of the property to read

Return: The value of the vector element

vrNodeGetMetaNode

string vrNodeGetMetaNode(
    vrnode node,
    boolean versioned =false
)

Gets the name of the MetaNode that a node is an instance of. This can also be referred to as the node type.

Parameters:

• node Node to get the type of
• versioned Whether to get the full versioned metanode name rather than the unversioned name

Return: The node type

vrNodeGetName

string vrNodeGetName(
    vrnode node
)

Gets the name of a node.

Parameters:

• node The node to get the name of

Return: The name of the node

vrNodeGetNoHistory

boolean vrNodeGetNoHistory(
    vrnode node
)

Queries whether this node can be recorded in the history for undo/redo operations.

Parameters:

• node The node to query the 'no history' flag of

Return: true if the node is flagged as 'no history', i.e. true if the node cannot be recorded for undo/redo

vrNodeGetNoSave

boolean vrNodeGetNoSave(
    vrnode node
)

Queries whether this node can be saved in a VRText/VRNative file.

Parameters:

• node The node to query the 'no save' flag of

Return: true if the node is flagged as 'no save', i.e. true if the node cannot be saved.

vrNodeGetNoSimulation

boolean vrNodeGetNoSimulation(
    vrnode node
)

Queries whether this node can be affected by simulations, such as physics and collision.

Parameters:

• node The node to query the 'no simulation' flag of

Return: true if the node is flagged as 'no simulation', i.e. the physics system ignores this node

vrNodeGetParent

vrnode vrNodeGetParent(
    vrnode node
)

Gets the parent of a node.

Parameters:

• node The node to get the parent of

Return: The parent node

vrNodeGetPath

string vrNodeGetPath(
    vrnode node
)

Gets the encoded path to a node relative to the tree root.

Parameters:

• node The node to get the path of

Return: The encoded path (special characters are encoded, e.g. space = %20

vrNodeGetPosition

vrvec3 vrNodeGetPosition(
    vrnode node
)

Gets the world position of the node.

Parameters:

• node The node to get the world vector from

Return: The vector value

vrNodeGetPositionX

number vrNodeGetPositionX(
    vrnode node
)

Gets the world x position of the node.

Parameters:

• node The node to get the x value of

Return: The value of the vector element

vrNodeGetPositionY

number vrNodeGetPositionY(
    vrnode node
)

Gets the world y position of the node.

Parameters:

• node The node to get the y value of

Return: The value of the vector element

vrNodeGetPositionZ

number vrNodeGetPositionZ(
    vrnode node
)

Gets the world z position of the node.

Parameters:

• node The node to get the z value of

Return: The value of the vector element

vrNodeGetPreviousSibling

vrnode vrNodeGetPreviousSibling(
    vrnode node,
    string metaType =0,
    string name =0
)

Gets the previous sibling (adjacent) node to a node.

Parameters:

• metaType The type of sibling to get
• name The name of the child to get

Return: The previous sibling node, of the type in the metaType parameter, if specified, or false if there are no suitable siblings

vrNodeGetRelativePath

string vrNodeGetRelativePath(
    vrnode node,
    vrnode relativeTo
)

Gets the encoded path to a node, relative to another node.

Parameters:

• node The node to get the path of
• relativeTo The node to get the path relative to

Return: The encoded relative path (special characters are encoded, e.g. space = %20

vrNodeGetRelativeTransform

MULTI< vrvec3, vrvec3, vrvec3 > vrNodeGetRelativeTransform(
    vrnode node,
    string propName,
    vrnode otherNode
)

Gets the position, rotation and scale of the world transform of one node relative to another.

Return:

• The relative world position
• The relative world rotation
• The relative world scale

vrNodeGetRotation

vrvec3 vrNodeGetRotation(
    vrnode node
)

Gets the world rotation of the node.

Parameters:

• node The node to get the world vector from

Return: The vector value

vrNodeGetRotationX

number vrNodeGetRotationX(
    vrnode node
)

Gets the world x rotation of the node.

Parameters:

• node The node to get the x value of

Return: The value of the vector element

vrNodeGetRotationY

number vrNodeGetRotationY(
    vrnode node
)

Gets the world y rotation of the node.

Parameters:

• node The node to get the y value of

Return: The value of the vector element

vrNodeGetRotationZ

number vrNodeGetRotationZ(
    vrnode node
)

Gets the world z rotation of the node.

Parameters:

• node The node to get the z value of

Return: The value of the vector element

vrNodeGetScale

vrvec3 vrNodeGetScale(
    vrnode node
)

Gets the world scale of the node.

Parameters:

• node The node to get the world vector from

Return: The vector value

vrNodeGetScaleX

number vrNodeGetScaleX(
    vrnode node
)

Gets the world x scale of the node.

Parameters:

• node The node to get the x value of

Return: The value of the vector element

vrNodeGetScaleY

number vrNodeGetScaleY(
    vrnode node
)

Gets the world y scale of the node.

Parameters:

• node The node to get the y value of

Return: The value of the vector element

vrNodeGetScaleZ

number vrNodeGetScaleZ(
    vrnode node
)

Gets the world z scale of the node.

Parameters:

• node The node to get the z value of

Return: The value of the vector element

vrNodeGetSibling

vrnode vrNodeGetSibling(
    vrnode node,
    string metaType =0,
    string name =0
)

Gets the sibling (adjacent) node to a node.

Parameters:

• metaType The type of sibling to get
• name The name of the child to get

Return: The next sibling node, of the type in the metaType parameter, if specified, or false if there are no suitable siblings

vrNodeGetTail

vrnode vrNodeGetTail(
    vrnode node,
    string metaType =0,
    string name =0
)

Gets the last child of a node.

Parameters:

• metaType The type of child to get
• name The name of the child to get

Return: The last child node, of the type in the metaType parameter, if specified, or false if there are no suitable child nodes

vrNodeGetTraits

table vrNodeGetTraits(
    vrnode node
)

Gets the list of traits that this node has. Can also be thought of as the base class of a node (e.g. Texture, Viewport, etc). This function is expensive and can affect performance. To check a specific trait use vrNodeHasTrait.

Parameters:

• node Node to get the traits of

Return: Array of traits that this node has

vrNodeGetValue

Any vrNodeGetValue(
    vrnode node,
    string propName
)

Gets the value of a property of a node.

Parameters:

• node The node to read the property from
• propName The name of the property to read

Return: The value of the property

vrNodeGetValueByIndex

Any vrNodeGetValueByIndex(
    vrnode node,
    number idx
)

Gets the value of a property of a node finding the property by its index.

Parameters:

• node The node to read the property from
• idx The index of the property to read

Return: The value of the property

vrNodeHasTrait

boolean vrNodeHasTrait(
    vrnode node,
    string traitName
)

Checks if the node is of a type with a specific trait. This is a lot faster than vrNodeGetTraits.

Parameters:

• node The node to check the traits of
• traitName The name of the trait to check

Return: true if the node has the specified trait

vrNodeIsAncestor

boolean vrNodeIsAncestor(
    vrnode node1,
    vrnode node2
)

Query whether the first specified node is an ancestor of the second.

Parameters:

• node1 The first node
• node2 The second node

Return: true if the first node is an ancestor of the second

vrNodeIsInGroup

boolean vrNodeIsInGroup(
    vrnode node,
    vrnode groupNode
)

Returns true is the node is in the group.

Parameters:

• node The node in question
• groupNode The Group node in question

Return: True or False

vrNodeIsLocal

boolean vrNodeIsLocal(
    vrnode node
)

Query whether the specified node belongs to the local network user.

Parameters:

• node The node to query

Return: true if the node belongs to the local user

vrNodeIsMetaFiltered

boolean vrNodeIsMetaFiltered(
    vrnode view,
    vrnode node
)

Returns true if the node's meta type is filtered in the specified view.

Parameters:

• view The view selection node
• node The node to query the filter state of

vrNodeRestoreTransform

void vrNodeRestoreTransform(
    vrnode node,
    boolean recursive
)

Restores the captured transform of a node.

Parameters:

• node The node to restore
• recursive True restores all the child transforms too.

vrNodeRoot

vrnode vrNodeRoot(
    vrnode node
)

Finds the root tree node. This is almost always equivilent to vrTreeRoot.

Parameters:

• node The node to get the root of

Return: The root node

vrNodeSetLocalPosition

void vrNodeSetLocalPosition(
    vrnode node,
    vrvec3 v,
    string prop =0
)

Sets the local position of the node.

Parameters:

• node The node to set the vector on
• v The value to set
• prop The name of the property to set

vrNodeSetLocalPositionX

void vrNodeSetLocalPositionX(
    vrnode node,
    number d,
    string prop =0
)

Sets the local x position of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalPositionY

void vrNodeSetLocalPositionY(
    vrnode node,
    number d,
    string prop =0
)

Sets the local y position of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalPositionZ

void vrNodeSetLocalPositionZ(
    vrnode node,
    number d,
    string prop =0
)

Sets the local z position of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalRotation

void vrNodeSetLocalRotation(
    vrnode node,
    vrvec3 v,
    string prop =0
)

Sets the local rotation of the node.

Parameters:

• node The node to set the vector on
• v The value to set
• prop The name of the property to set

vrNodeSetLocalRotationX

void vrNodeSetLocalRotationX(
    vrnode node,
    number d,
    string prop =0
)

Sets the local x rotation of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalRotationY

void vrNodeSetLocalRotationY(
    vrnode node,
    number d,
    string prop =0
)

Sets the local y rotation of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalRotationZ

void vrNodeSetLocalRotationZ(
    vrnode node,
    number d,
    string prop =0
)

Sets the local z rotation of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalScale

void vrNodeSetLocalScale(
    vrnode node,
    vrvec3 v,
    string prop =0
)

Sets the local scale of the noed.

Parameters:

• node The node to set the vector on
• v The value to set
• prop The name of the property to set

vrNodeSetLocalScaleX

void vrNodeSetLocalScaleX(
    vrnode node,
    number d,
    string prop =0
)

Sets the local x scale of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalScaleY

void vrNodeSetLocalScaleY(
    vrnode node,
    number d,
    string prop =0
)

Sets the local y scale of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetLocalScaleZ

void vrNodeSetLocalScaleZ(
    vrnode node,
    number d,
    string prop =0
)

Sets the local z scale of the node.

Parameters:

• node The node to set the value on
• d The value to set
• prop The name of the property to set

vrNodeSetName

void vrNodeSetName(
    vrnode node,
    string newName
)

Sets the name of a node.

Parameters:

• node The node to set the name of
• newName The new name for the node

vrNodeSetNoHistory

void vrNodeSetNoHistory(
    vrnode node,
    boolean noHistory
)

Specifies whether this node can be recorded in the history for undo/redo operations.

Parameters:

• node The node to set the 'no history' flag of
• noHistory Whether the 'no-history' flag should be active, i.e. true if the node should not be recorded.

vrNodeSetNoSave

void vrNodeSetNoSave(
    vrnode node,
    boolean noSave
)

Specifies whether this node can be saved in a VRText/VRNative file.

Parameters:

• node The node to set the 'no save' flag of
• noSave Whether the 'no-save' flag should be active, i.e. true if the node should not be saved.

vrNodeSetNoSimulation

void vrNodeSetNoSimulation(
    vrnode node,
    boolean noSimulation
)

Specifies whether this node should be affected by simulations, such as physics and collision.

Parameters:

• node The node to set the 'no simulation' flag of
• noSimulation Whether the 'no simulation' flag should be active, i.e. true if the node should not be simulated.

vrNodeSetParent

void vrNodeSetParent(
    vrnode node,
    vrnode parent =nil,
    vrnode beforeSibling =nil,
    boolean preserveWorldTransform =false
)

Sets the parent of a node.

Parameters:

• node The node to set the parent of
• parent New parent. If this is nil, the parent is cleared, effectively deleting the node from the tree.
• beforeSibling Specifies where to add the node in the parent's list of children, or nil to add it at the end of the list.
• preserveWorldTransform If true, the node's position, rotation and scale in the world will be maintained.

vrNodeSetPosition

void vrNodeSetPosition(
    vrnode node,
    vrvec3 v
)

Sets the world position of the node.

Parameters:

• node The node to set the vector on
• v The value to set

vrNodeSetPositionX

void vrNodeSetPositionX(
    vrnode node,
    number d
)

Sets the world x position of the node.

Parameters:

• node The node to set the x value on
• d The value to set

vrNodeSetPositionY

void vrNodeSetPositionY(
    vrnode node,
    number d
)

Sets the world y position of the node.

Parameters:

• node The node to set the y value on
• d The value to set

vrNodeSetPositionZ

void vrNodeSetPositionZ(
    vrnode node,
    number d
)

Sets the world z position of the node.

Parameters:

• node The node to set the z value on
• d The value to set

vrNodeSetRelativeTransform

void vrNodeSetRelativeTransform(
    vrnode node,
    string propName,
    vrnode otherNode,
    Any vpos,
    Any vrot,
    Any vscale
)

Sets the position, rotation and scale of the world transform of a node relative to another.

Parameters:

• vpos XYZ Position specified in a table {x, y, z}.
• vrot Euler Rotation specified in a table {x, y, z}.
• vscale XYZ Scale specified in a table {x, y, z}.

vrNodeSetRotation

void vrNodeSetRotation(
    vrnode node,
    vrvec3 v
)

Sets the world rotation of the node.

Parameters:

• node The node to set the vector on
• v The value to set

vrNodeSetRotationX

void vrNodeSetRotationX(
    vrnode node,
    number d
)

Sets the world x rotation of the node.

Parameters:

• node The node to set the x value on
• d The value to set

vrNodeSetRotationY

void vrNodeSetRotationY(
    vrnode node,
    number d
)

Sets the world y rotation of the node.

Parameters:

• node The node to set the y value on
• d The value to set

vrNodeSetRotationZ

void vrNodeSetRotationZ(
    vrnode node,
    number d
)

Sets the world z rotation of the node.

Parameters:

• node The node to set the z value on
• d The value to set

vrNodeSetScale

void vrNodeSetScale(
    vrnode node,
    vrvec3 v
)

Sets the world scale fo the noed.

Parameters:

• node The node to set the vector on
• v The value to set

vrNodeSetScaleX

void vrNodeSetScaleX(
    vrnode node,
    number d
)

Sets the world x scale of the node.

Parameters:

• node The node to set the x value on
• d The value to set

vrNodeSetScaleY

void vrNodeSetScaleY(
    vrnode node,
    number d
)

Sets the world y scale of the node.

Parameters:

• node The node to set the y value on
• d The value to set

vrNodeSetScaleZ

void vrNodeSetScaleZ(
    vrnode node,
    number d
)

Sets the world z scale of the node.

Parameters:

• node The node to set the z value on
• d The value to set

vrNodeSetValue

void vrNodeSetValue(
    vrnode node,
    string propName,
    Any value
)

Sets the value of one of the properties of a node.

Parameters:

• node The node to get the property on
• propName The name of the property.
• value The new property value to set. This value type should match the property type.

vrNodeSetValueByIndex

void vrNodeSetValueByIndex(
    vrnode node,
    number idx,
    Any value
)

Sets the value of one of the properties of a node finding the property by its index.

Parameters:

• node The node to set the property on
• idx The index of the property
• value The new property value to set. This value type should match the property type.