Skip to main content

Tree

Functions for interacting with the tree views.

Functions​

TypeName
voidvrDeleteChildren(vrnode node)
Deletes the children of a node.
voidvrDeleteUnreferenced(vrnode node)
Recursively deletes all unreferenced nodes in this branch.
voidvrDeveloperSaveTree(vrnode node, string file, boolean newUUID =false)
Saves the tree from a specified node down.
stringvrGetSelectedTreeFrame()
Returns the name of the selected tree frame.
vrnodevrLibrariesNode()
Returns the Libraries node the tree.
voidvrLoadTree(vrnode node, string file, boolean supportOlder =false, boolean neverBroadcast =false, boolean noSave =false, boolean noHistory =false, boolean newUUID =false)
Loads a Visionary Render format file.
voidvrMergeTree(string file, vrnode analyzeSettings)
Merges a Visionary Render format file with the current scene.
voidvrSaveTree(vrnode node, string file, boolean newUUID =false)
Saves a Visionary Render format file.
voidvrScenesNode()
Returns the Scenes node from the tree.
vrnodevrSelectHistoryEntry(vrnode historyEntry)
Navigates to an entry in the selection history.
vrnodevrSelectNext(number distance =1)
Navigates to the next selection.
booleanvrSelectNode(vrnode selectionGroup, vrnode node)
Selects a node by adding it to the specified selection group.
vrnodevrSelectNodes(vrnode [] nodes, string(optional) allowedViews[] =empty, boolean(optional) alsoShowProperties =false)
Selects the specified array of nodes in the most appropriate view.
vrnodevrSelectPrevious(number distance =1)
Navigates to the previous selection.
voidvrSetSelectedTreeFrame(string name)
Sets the currently selected tree view frame by name.
vrnodevrSystemLibsNode()
Returns the SystemsLib node from the tree.
vrnodevrTreeControlRangeSelect(vrnode view =nil)
Selects or deselects all nodes between the specified node and the last selected node without affecting the rest of the selection.
vrnodevrTreeControlSelect(vrnode view =nil)
Selects (or deselects the currently selected) node without affecting the rest of the selection.
vrnodevrTreeRangeSelect(vrnode view =nil)
Selects all nodes between the specified node and the last selected node.
vrnodevrTreeRoot()
Returns the root node.
tablevrTreeSearch(vrnode startNode, string searchQuery)
Searches the tree and returns a table of results matching the query.
vrnodevrTreeSelect(vrnode view =nil)
Selects the specified node in the specified view (or any view if nil).
voidvrTreeViewSelectionCollapse(string view)
Collapses the current selection.
voidvrTreeViewSelectionCollapseAll(string view)
Collapses the current selection and its descendants.
voidvrTreeViewSelectionExpand(string view)
Expands the current selection.
voidvrTreeViewSelectionExpandAll(string view)
Expands the current selection and its descendants.
voidvrTreeViewSelectionSelectAllSiblings(string view)
Selects all siblings.
voidvrTreeViewSelectionSelectChildren(string view)
Selects children.
voidvrTreeViewSelectionSelectInvert(string view)
Inverts selection.
voidvrTreeViewSelectionSelectParent(string view)
Selects parent(s) of the current selection.
voidvrTreeViewSelectionSelectSiblings(string view)
Selects siblings (of same type).
voidvrTriggerRename(string view, vrnode node)
Triggers a node rename in the tree view.

Functions Documentation​

vrDeleteChildren​

void vrDeleteChildren(
    vrnode node
)

Deletes the children of a node.

Parameters:

  • node The node to delete the children of

vrDeleteUnreferenced​

void vrDeleteUnreferenced(
    vrnode node
)

Recursively deletes all unreferenced nodes in this branch.

Parameters:

  • node Node to start deleting from

vrDeveloperSaveTree​

void vrDeveloperSaveTree(
    vrnode node,
    string file,
    boolean newUUID =false
)

Saves the tree from a specified node down.

Parameters:

  • node The node to start saving from
  • file Path to the file to save as
  • newUUID True removes the UUIDs from nodes into the file.

vrGetSelectedTreeFrame​

string vrGetSelectedTreeFrame()

Returns the name of the selected tree frame.

vrLibrariesNode​

vrnode vrLibrariesNode()

Returns the Libraries node the tree.

vrLoadTree​

void vrLoadTree(
    vrnode node,
    string file,
    boolean supportOlder =false,
    boolean neverBroadcast =false,
    boolean noSave =false,
    boolean noHistory =false,
    boolean newUUID =false
)

Loads a Visionary Render format file.

Parameters:

  • node The node on which to load the contents of the file (use vrTreeRoot if loading a full scene)
  • file The full path to the file
  • supportOlder True loads older format files that may have missing information. Default (false) will fail to load older files.
  • noSave True prevents the loaded nodes from being saved.
  • noHistory True prevents the loaded nodes being added to the undo history.
  • newUUID True ignores UUIDs from file.

vrMergeTree​

void vrMergeTree(
    string file,
    vrnode analyzeSettings
)

Merges a Visionary Render format file with the current scene.

Parameters:

  • file Path to the file to merge
  • analyzeSettings Merge Analysis settings node

vrSaveTree​

void vrSaveTree(
    vrnode node,
    string file,
    boolean newUUID =false
)

Saves a Visionary Render format file.

Parameters:

  • node The node to start saving from (use vrTreeRoot for a full scene save)
  • file The path to the output file
  • newUUID True creates new UUIDs from nodes into the file.

vrScenesNode​

void vrScenesNode()

Returns the Scenes node from the tree.

vrSelectHistoryEntry​

vrnode vrSelectHistoryEntry(
    vrnode historyEntry
)

Navigates to an entry in the selection history.

Return: The selection group containing the now current selection

vrSelectNext​

vrnode vrSelectNext(
    number distance =1
)

Navigates to the next selection.

Parameters:

  • distance Number of steps in the selection history to move

Return: The selection group containing the now current selection

vrSelectNode​

boolean vrSelectNode(
    vrnode selectionGroup,
    vrnode node
)

Selects a node by adding it to the specified selection group.

Parameters:

  • selectionGroup The selection group to add to
  • node The node to select

Return: true if the node was selected

vrSelectNodes​

vrnode vrSelectNodes(
    vrnode [] nodes,
    string(optional) allowedViews[] =empty,
    boolean(optional) alsoShowProperties =false
)

Selects the specified array of nodes in the most appropriate view.

Parameters:

  • nodes Nodes to select. Can be one node or an array of nodes
  • allowedViews Views to consider selection in. Can be empty to consider all views. Accepts selection group names
  • alsoShowProperties Specifies whether to also display the properties window for the new selection

Return: The view that the nodes were selected in

vrSelectPrevious​

vrnode vrSelectPrevious(
    number distance =1
)

Navigates to the previous selection.

Parameters:

  • distance Number of steps in the selection history to move

Return: The selection group containing the now current selection

vrSetSelectedTreeFrame​

void vrSetSelectedTreeFrame(
    string name
)

Sets the currently selected tree view frame by name.

vrSystemLibsNode​

vrnode vrSystemLibsNode()

Returns the SystemsLib node from the tree.

vrTreeControlRangeSelect​

vrnode vrTreeControlRangeSelect(
    vrnode view =nil
)

Selects or deselects all nodes between the specified node and the last selected node without affecting the rest of the selection.

Return: The selection container that the selection was made in

vrTreeControlSelect​

vrnode vrTreeControlSelect(
    vrnode view =nil
)

Selects (or deselects the currently selected) node without affecting the rest of the selection.

Return: The selection container that the selection was made in

vrTreeRangeSelect​

vrnode vrTreeRangeSelect(
    vrnode view =nil
)

Selects all nodes between the specified node and the last selected node.

Return: The selection container that the selection was made in

vrTreeRoot​

vrnode vrTreeRoot()

Returns the root node.

vrTreeSearch​

table vrTreeSearch(
    vrnode startNode,
    string searchQuery
)

Searches the tree and returns a table of results matching the query.

Parameters:

  • startNode The node to start searching from
  • searchQuery A query in the format [and|or] [name|type|type.prop] [equals|not|contains] <query> (see the Advanced Query section of the user manual for further information).

Return: Array of nodes matching the search query

vrTreeSelect​

vrnode vrTreeSelect(
    vrnode view =nil
)

Selects the specified node in the specified view (or any view if nil).

Return: The selection container that the selection was made in

vrTreeViewSelectionCollapse​

void vrTreeViewSelectionCollapse(
    string view
)

Collapses the current selection.

Parameters:

  • view The name of the view

vrTreeViewSelectionCollapseAll​

void vrTreeViewSelectionCollapseAll(
    string view
)

Collapses the current selection and its descendants.

Parameters:

  • view The name of the view

vrTreeViewSelectionExpand​

void vrTreeViewSelectionExpand(
    string view
)

Expands the current selection.

Parameters:

  • view The name of the view

vrTreeViewSelectionExpandAll​

void vrTreeViewSelectionExpandAll(
    string view
)

Expands the current selection and its descendants.

Parameters:

  • view The name of the view

vrTreeViewSelectionSelectAllSiblings​

void vrTreeViewSelectionSelectAllSiblings(
    string view
)

Selects all siblings.

Parameters:

  • view The name of the view

vrTreeViewSelectionSelectChildren​

void vrTreeViewSelectionSelectChildren(
    string view
)

Selects children.

Parameters:

  • view The name of the view

vrTreeViewSelectionSelectInvert​

void vrTreeViewSelectionSelectInvert(
    string view
)

Inverts selection.

Parameters:

  • view The name of the view

vrTreeViewSelectionSelectParent​

void vrTreeViewSelectionSelectParent(
    string view
)

Selects parent(s) of the current selection.

Parameters:

  • view The name of the view

vrTreeViewSelectionSelectSiblings​

void vrTreeViewSelectionSelectSiblings(
    string view
)

Selects siblings (of same type).

Parameters:

  • view The name of the view

vrTriggerRename​

void vrTriggerRename(
    string view,
    vrnode node
)

Triggers a node rename in the tree view.

Parameters:

  • view The name of the view
  • node The node to rename