Skip to main content

GUI

Functions for interacting with the Visionary Render GUI.

Functions​

TypeName
voidvrAddToolbarButton(vrnode toolbarNode, vrnode groupNode, string name, number type, string caption, string icon, string command, string userString, string clusterScope, string statusTxt)
Adds a button to a toolbar dock group.
vrnodevrAddToolbarButtonGroup(vrnode toolbarUINode, string groupName, boolean hasScrollBar =true)
Adds a new group for toolbar buttons to be attached to.
vrnodevrAddToolbarDock(vrnode notebookNode, string tabName, string tabIcon)
Adds a docked window to a notebook that toolbars can be added to.
voidvrCloseNotebookPane(string notebookName, string paneName)
Closes the specified pane of the given notebook.
voidvrCloseSequence(vrnode selection)
Closes the specified sequence in the sequencer window.
voidvrFilterView(string view, string metaType)
Sets the filter for a specified view.
voidvrGalleryRequestImport(string typeName, string importerName, string prompt, vrnode destination =nil)
Imports a file using an importer registered with the gallery.
voidvrHideModalDialogues(boolean suppressed =false)
Suppresses all modal dialogue message boxes.
voidvrLoadGalleryFolders(string path)
Add sub-folders of the specified folder to the gallery.
stringvrMessageBox(string text, string caption, string flagList)
Displays a message box to the user.
voidvrOpenNotebookPane(string notebookName, string paneName)
Opens the specified pane of the given notebook.
voidvrPopupGalleryWindow()
Pops up the gallery window.
voidvrPopupPropertyWindow(vrnode view =nil)
Pops open the property window.
voidvrPopupToolsWindow()
Pops up the tools window.
voidvrPresentMessage(string msg)
Presents a message box to the user.
voidvrProgressBegin(string/int(optional) msg/ val, int(optional) max, string(optional) msg)
Begins showing the progress display.
voidvrProgressEnd()
Ends the progress display.
voidvrProgressEvents(boolean enabled =true)
Create Nodes under user tree to indicate when progress events are occuring.
voidvrProgressYield(string/int(optional) msg/ val, int(optional) max, string(optional) msg)
Updates the progress display.
voidvrResetWindows()
Resets the windows to their initial positions and states that they were when the application was started.
voidvrSetGUIEnabled(boolean enabled, vrnode userNode =nil)
Shows or hides the windows over the 3D scene.
voidvrSetIconToCurrentView(vrnode node)
Sets the browser icon for a node to the current view.
voidvrSetIconToDefault(vrnode node)
Sets the browser icon for a node to the default icon.
voidvrSetIconToTexture(vrnode node, vrnode texture)
Sets the browser icon for a node to a texture.
voidvrSetStatusBar(string text, number duration =0.0)
Set the text and duration of the text in the status bar.
voidvrShowAnnotationReviewWindow(vrnode annotationNode =nil)
Pops up the applicaiton annotation review window for the specified annotation node.
voidvrShowGalleryType(string typeName)
Shows a type in the gallery window.
voidvrShowGradientWindow(vrnode gradientNode)
Pops up the application gradient editor for the specified gradient node.
voidvrShowGUIFrame(vrnode uiNode, boolean show)
Show or hide a GUI frame.
voidvrShowImporterSettings(vrnode importerNode)
Invokes a dialog that shows the importer settings for the given node.
voidvrShowNextSelection(number distance =1)
Navigates to the next selection and shows the properties of the nodes.
voidvrShowNodeProperties(vrnode selection, boolean popup =false)
Pops up the application property editor for the specified view selection.
voidvrShowPreviousSelection(number distance =1)
Navigates to the previous selection and shows the properties of the nodes.
voidvrShowPropertyWindow(vrnode selection =nil, boolean popup =false)
Pops up the application property editor for the specified view selection.
voidvrShowScriptWindow(vrnode scriptNode =nil)
Pops up the application script editor for the specified script node.
voidvrShowSequence(vrnode selection)
Shows the specified sequence in the sequencer window.
voidvrShowSequencer(vrnode selection)
Shows the sequencer window.
voidvrShowSettingsWindow(vrnode selection =nil, number tabIndex =-1)
Pops up the application settings for the specified settings group.
voidvrToggleGUIEnabled(vrnode userNode =nil)
Toggles the visibility of the windows over the 3D scene.
booleanvrToggleNotebookPane(string notebookName, string paneName)
If the current pane is visible it will be hidden, if it's hidden it will be made visible (and selected).
voidvrToggleSubtreeStats()
Toggles the subtree stats display in the properties window.
voidvrUpdateMenu(vrnode uinode)
Create menu item frames for children of the menu node.
voidvrUpdateSelectionHistoryMenu(vrnode menu)
Updates a menu to display the current selection history.

Functions Documentation​

vrAddToolbarButton​

void vrAddToolbarButton(
    vrnode toolbarNode,
    vrnode groupNode,
    string name,
    number type,
    string caption,
    string icon,
    string command,
    string userString,
    string clusterScope,
    string statusTxt
)

Adds a button to a toolbar dock group.

Parameters:

  • toolbarNode The toolbar dock to add the button to.
  • groupNode The toolbar dock group to add the button to.
  • name The name of the button node.
  • type The button type.
  • caption The button caption.
  • icon The icon for the button.
  • command The lua command for the button.
  • userString The user parameters for the lua command.
  • clusterScope The cluster scope of the button.
  • statusTxt The status text displayed while hovering over the button

vrAddToolbarButtonGroup​

vrnode vrAddToolbarButtonGroup(
    vrnode toolbarUINode,
    string groupName,
    boolean hasScrollBar =true
)

Adds a new group for toolbar buttons to be attached to.

Parameters:

  • toolbarUINode The tool tab node to attach the button group to
  • groupName The name of the button group
  • hasScrollBar Whether to allow the group to scroll

Return: the group node

vrAddToolbarDock​

vrnode vrAddToolbarDock(
    vrnode notebookNode,
    string tabName,
    string tabIcon
)

Adds a docked window to a notebook that toolbars can be added to.

Parameters:

  • notebookNode The notebook uinode to dock to
  • tabName The title of the frame
  • tabIcon The icon of the frame

Return: the dock node

vrCloseNotebookPane​

void vrCloseNotebookPane(
    string notebookName,
    string paneName
)

Closes the specified pane of the given notebook.

Parameters:

  • notebookName Specifies the name of the notebook.
  • paneName Specifies the name of the pane.

vrCloseSequence​

void vrCloseSequence(
    vrnode selection
)

Closes the specified sequence in the sequencer window.

vrFilterView​

void vrFilterView(
    string view,
    string metaType
)

Sets the filter for a specified view.

Parameters:

  • view The name of the view
  • metaType The type to filter

vrGalleryRequestImport​

void vrGalleryRequestImport(
    string typeName,
    string importerName,
    string prompt,
    vrnode destination =nil
)

Imports a file using an importer registered with the gallery.

Parameters:

  • typeName Specifies the name of a gallery asset type.
  • importerName Specifies the name of a registered importer, or an empty string to use all importers.
  • prompt A prompt to display in the file dialogue.
  • destination The parent node for the imported data.

vrHideModalDialogues​

void vrHideModalDialogues(
    boolean suppressed =false
)

Suppresses all modal dialogue message boxes.

Parameters:

  • suppressed Whether to suppress the dialogue messages or not

vrLoadGalleryFolders​

void vrLoadGalleryFolders(
    string path
)

Add sub-folders of the specified folder to the gallery.

Parameters:

  • path Specifies the path to the folder to search.

vrMessageBox​

string vrMessageBox(
    string text,
    string caption,
    string flagList
)

Displays a message box to the user.

Parameters:

  • text The main body of the message.

  • caption The text to put in the title bar.

  • flagList String indicating what kind of input is required, and an icon to show.

  • "okcancel,warning" would display a box with OK and CANCEL buttons, with a warning icon.

  • "yesno,question" would display a box with YES and NO buttons, with a question icon.

  • "abortretryignore,error" would display ABORT, RETRY and IGNORE buttons, with an error icon.

Return: Returns one of the following based on selected button: cancel, continue, no, ok, retry, tryagain, yes

vrOpenNotebookPane​

void vrOpenNotebookPane(
    string notebookName,
    string paneName
)

Opens the specified pane of the given notebook.

Parameters:

  • notebookName Specifies the name of the notebook.
  • paneName Specifies the name of the pane.

vrPopupGalleryWindow​

void vrPopupGalleryWindow()

Pops up the gallery window.

vrPopupPropertyWindow​

void vrPopupPropertyWindow(
    vrnode view =nil
)

Pops open the property window.

Parameters:

  • view Selection to display the properties of

vrPopupToolsWindow​

void vrPopupToolsWindow()

Pops up the tools window.

vrPresentMessage​

void vrPresentMessage(
    string msg
)

Presents a message box to the user.

Parameters:

  • msg The message to display

vrProgressBegin​

void vrProgressBegin(
    string/int(optional) msg/ val,
    int(optional) max,
    string(optional) msg
)

Begins showing the progress display. Note: if the operation is short, the progress display may not be shown.

Parameters:

  • msg/val

  • When the only argument, string message to display

  • When not the only argument, integer progress value for bar display

    • max The maximum range of the progress bar
    • msg The message to display

vrProgressEnd​

void vrProgressEnd()

Ends the progress display.

vrProgressEvents​

void vrProgressEvents(
    boolean enabled =true
)

Create Nodes under user tree to indicate when progress events are occuring.

Parameters:

  • enabled Whether to enable progress messages

vrProgressYield​

void vrProgressYield(
    string/int(optional) msg/ val,
    int(optional) max,
    string(optional) msg
)

Shows and updates the progress display.

Parameters:

  • msg/val

  • When the only argument, string message to display

  • When not the only argument, integer progress value for bar display

    • max The maximum range of the progress bar
    • msg The message to display

vrResetWindows​

void vrResetWindows()

Resets the windows to their initial positions and states that they were when the application was started.

vrSetGUIEnabled​

void vrSetGUIEnabled(
    boolean enabled,
    vrnode userNode =nil
)

Shows or hides the windows over the 3D scene.

Parameters:

  • userNode user whose gui should be affected (defaults to local user)

vrSetIconToCurrentView​

void vrSetIconToCurrentView(
    vrnode node
)

Sets the browser icon for a node to the current view.

vrSetIconToDefault​

void vrSetIconToDefault(
    vrnode node
)

Sets the browser icon for a node to the default icon.

vrSetIconToTexture​

void vrSetIconToTexture(
    vrnode node,
    vrnode texture
)

Sets the browser icon for a node to a texture.

Parameters:

  • texture The texture node

vrSetStatusBar​

void vrSetStatusBar(
    string text,
    number duration =0.0
)

Set the text and duration of the text in the status bar.

Parameters:

  • text Text to display
  • duration Number of seconds to display the status message

vrShowAnnotationReviewWindow​

void vrShowAnnotationReviewWindow(
    vrnode annotationNode =nil
)

Pops up the applicaiton annotation review window for the specified annotation node.

Parameters:

  • annotationNode The annotation node to show

vrShowGalleryType​

void vrShowGalleryType(
    string typeName
)

Shows a type in the gallery window.

Parameters:

  • typeName Specifies the name of the type to show.

vrShowGradientWindow​

void vrShowGradientWindow(
    vrnode gradientNode
)

Pops up the application gradient editor for the specified gradient node.

Parameters:

  • gradientNode The gradient node to show

vrShowGUIFrame​

void vrShowGUIFrame(
    vrnode uiNode,
    boolean show
)

Show or hide a GUI frame.

Parameters:

  • uiNode The frame node
  • show True to show, false to hide

vrShowImporterSettings​

void vrShowImporterSettings(
    vrnode importerNode
)

Invokes a dialog that shows the importer settings for the given node.

Parameters:

  • importerNode Importer node

vrShowNextSelection​

void vrShowNextSelection(
    number distance =1
)

Navigates to the next selection and shows the properties of the nodes.

Parameters:

  • distance The number of steps forward in the selection history to go

vrShowNodeProperties​

void vrShowNodeProperties(
    vrnode selection,
    boolean popup =false
)

Pops up the application property editor for the specified view selection.

vrShowPreviousSelection​

void vrShowPreviousSelection(
    number distance =1
)

Navigates to the previous selection and shows the properties of the nodes.

Parameters:

  • distance The number of steps back in the selection history to go

vrShowPropertyWindow​

void vrShowPropertyWindow(
    vrnode selection =nil,
    boolean popup =false
)

Pops up the application property editor for the specified view selection.

Parameters:

  • selection The selection group to show properties for
  • popup True if the properties window should be shown if currently hidden

vrShowScriptWindow​

void vrShowScriptWindow(
    vrnode scriptNode =nil
)

Pops up the application script editor for the specified script node.

Parameters:

  • scriptNode The script node to show

vrShowSequence​

void vrShowSequence(
    vrnode selection
)

Shows the specified sequence in the sequencer window.

vrShowSequencer​

void vrShowSequencer(
    vrnode selection
)

Shows the sequencer window.

Parameters:

  • selection The sequence node to show

vrShowSettingsWindow​

void vrShowSettingsWindow(
    vrnode selection =nil,
    number tabIndex =-1
)

Pops up the application settings for the specified settings group.

Parameters:

  • selection The setting category node to show
  • tabIndex Zero-indexed tab number to show

vrToggleGUIEnabled​

void vrToggleGUIEnabled(
    vrnode userNode =nil
)

Toggles the visibility of the windows over the 3D scene.

Parameters:

  • userNode user whose gui should be affected (defaults to local user)

vrToggleNotebookPane​

boolean vrToggleNotebookPane(
    string notebookName,
    string paneName
)

If the current pane is visible it will be hidden, if it's hidden it will be made visible (and selected).

Parameters:

  • notebookName Specifies the name of the notebook.
  • paneName Specifies the name of the pane.

Return: true if the pane is set to visible

vrToggleSubtreeStats​

void vrToggleSubtreeStats()

Toggles the subtree stats display in the properties window.

vrUpdateMenu​

void vrUpdateMenu(
    vrnode uinode
)

Create menu item frames for children of the menu node.

Parameters:

  • uinode The menu node parent

vrUpdateSelectionHistoryMenu​

void vrUpdateSelectionHistoryMenu(
    vrnode menu
)

Updates a menu to display the current selection history.