Share

VRED Live Reference Module

Find a list of all Live References, information on their state, update status, and Live Reference and source locations. See what content is visible, hidden, and needs reloading.

Use the Live Reference module to create a link to Alias Live References and identify any connection issues. Choose when Alias updates are received, reload files, quickly find content, and quickly select nodes in the Scenegraph and Reference Editor.

Live Reference Module

From the Scene menu, select Live Reference to access this module.

2 Toolbar

Find the following tools in the Live Reference toolbar:

  • Create Live Reference icon - Opens a file browser for selecting a Live Reference file, then opens the Create Live References dialog to create the live connection. See Create Live References Dialog for more informatiion.

  • Delete icon - Removes the selected Live References file from the list.

  • Update from Alias icon - Establishes a connection with Alias and updates the selected Live Reference. Use this for updating a file where Automatic Update has been turned off.

  • Select Node icon - Provides a quick way to find and select the currently selected file in the Reference Editor and Scenegraph.

3 Search and Filters

Use the Search field to search by name or with a single character. Note that only single search terms are supported. Further configure your search using the filter settings. Quickly see the search rsults with help from the icons in the columns. Click Filter icon to access the filters.

Filters available in the Alias and VRED columns

Tip:

If the node structure is greyed out, click Reload View icon to reload the node tree.

Accessing the node tree

4 Live References List

Find a list of all Live References and information on their state and that of Automatic Update, as well as the Live Reference and source locations.

Live References List

Tip:

To access a list for customizing which columns are displayed, click arrow icon. Checked options are displayed and unchecked are hidden.

Menu for setting the displayed columns

Icons

An assortment of icons are used to help with identifying what things are and their state.

  • Live Reference - The icon next to a Live Reference indicates its type.

    • Live Reference icon - Standard Live Reference

    • Transformed Live Ref icon - Transformed Live Reference

    • Hidden transformed Live Ref icon - Hidden transformed Live Reference. To unhide it, in either the Scenegraph or Reference Editor, click the box next to it to add a check.

  • State - These icons indicate the state of the Live Reference.

    • Good icon - Good - No issue was found.

    • Warning icon - Warning - An issue was found which needs troubleshooting.

    • Reload icon - Reload - The Alias Live Reference has changed, and since Automatic Updates is off, the file must be reloaded in VRED to incorporate them.

      Live Reference list showing a file with changes that have not been consumed

  • Auto - These icons indicate the status of Automatic Update.

    • Automatic update is enabled icon - Enabled

    • Automatic update is disabled icon - Disabled - This is due to an issue with the state of the Live Reference file (Warning icon).

    • Automatic update is off icon - Off - To enable and update the file, click the icon. It changes to Automatic update is enabled icon.

  • Location - Provides the location of the VRED Live Reference file.

  • Source - Provides the location of the Alias live source file.

    Tip:

    Use the environment variable, ALIAS_VRED_LIVEREF_LOC, for specifying data location. If ALIAS_VRED_LIVEREF_LOC is used to set the file path, and the Live Reference is available, VRED stops looking for other paths and loads the data.

Context Menu

Right-click within the Live Reference area to access a context menu for quickly accessing Update from Alias, Automatic Update, Reload View, Create, Select Nodes, Show in Reference Editor, Re-Import Live Reference, and Replace Live Source. See the Menu section for information on these options.

5 Node Column

The Nodes column displays the node structure for the currently selected Live Reference. Use the search and filters to quickly locate specific nodes. Use slider, Expand icon, and Collapse icon to expand and collapse the tree.

Node Tree

Nodes in the tree will be either gold, indicating the geometry is visible, grey, indicating the view needs to be reloaded, or white, indicating hidden content. When something is hidden, to make it visible, right-click the Live Reference and select Show in Reference Editor from its context menu. Now, in the Reference Editor, click the box next to the reference to add a check, making its geometry visible. When you return to the Live References module, click Reload View icon to reload the view.

Gold Grey White
Gold node structure Grey node structure White node structure

Node Filters

Click Filter icon and select any of the following options. If the Live Reference contains a node matching the enabled filter(s), the Node column updates. Click Expand node tree icon to expand the tree to see the filtered nodes.

Tip:

If the node structure is greyed out, click Reload View icon to reload the node tree.

Accessing the node tree

  • Select All - Selects all the filters, displaying the filtered results.

  • Select None - Deselect all filters, displaying all nodes.

  • Invert Selection - Selects all unselected filters, while deselecting the previously selected ones, changing the filtered results.

  • Materials - Displays only material nodes.

    Materials in the Node tree

  • Cameras - Displays camera nodes.

    Cameras in the Node tree

  • Lights - Displays light nodes.

    Lights in the Node tree

  • Annotations - Displays annotation nodes.

    Annotations in the Node tree

  • Animations - Displays animated nodes.

    animated nodes in the Node tree

  • Show Components - Displays components.

    Components in the Node tree

Revert Context Menu

When Reload View icon is clicked, the context menu options change. Use these options to revert a Live Reference back to its previous state. Find the following options:

  • Reload View - Loads the node tree of the selected Live Reference into the Node column, making it selectable and searchable. Use this when working on multiple Live References to switch between them and reload their nodes.
  • Select - Selects the node in the Scenegraph and viewport.
  • Revert All - Reverts all changes to the Live Reference file back to their previous state.
  • Revert Edit - Reverts only edits made to the Live Reference back to their previous state.
  • Revert Name - Reverts any name changes to the Live Reference back to their previous state.
  • Revert Material - Reverts any material changes to the Live Reference back to the previous state.
  • Revert Transformation - Reverts any transformation changes to the Live Reference back to the previous state.
  • Revert Visibility - Reverts any visibility changes to the Live Reference back to the previous state.
  • Revert Structure - Reverts any changes to the node structure of the Live Reference back to the previous state.

6 Alias and VRED Columns

When filters are set, icons may appear in the columns, indicating a match. This makes it easier to identify matching nodes. Click the icon in the column to highlight the node in the node tree.

Alias and VRED Columns with icons and nodes selected

Alias and VRED Filters

Click Filter icon and select any of the following options. If the Live Reference contains a node matching the enabled filter(s), the column updates. To see which node(s) match the filter (indicated by an icon in the Alias or VRED column), click Expand node tree icon. If no nodes are displayed, there is no match.

Example of an icon in the VRED column

  • Select All - Selects all the filters, displays icons for the filtered results, and updates the nodes displayed in the Node column accordingly.
  • Select None - Deselect all filters.
  • Invert Selection - Selects all unselected filters, while deselecting the previously selected ones, changing the filtered results.
  • New - Displays New icon in the Alias or VRED columns, indicating nodes added to the file. The nodes in the Node column also update.
  • Removed - Displays Removed icon in the Alias or VRED columns, indicating nodes removed from the file. The nodes in the Node column also update.
  • Edited - Displays Pencil icon in the Alias or VRED columns, indicating edited nodes. The nodes in the Node column also update.
  • Transformed - Displays transform manipulator icon in the Alias or VRED columns, indicating transformed nodes.
  • Material Changed - Displays material ball icon in the Alias or VRED columns, indicating nodes with material changes.
  • Renamed - Displays Renamed icon in the Alias or VRED columns, indicating renamed nodes.
  • Visibility Changed - Displays Visibility icon in the Alias or VRED columns, indicating nodes with changed visibility.
  • Structure Changed - Displays icon in the Alias or VRED columns, indicating a change to the node structure of the Live Reference.

Revert Context Menu

When Reload View icon is clicked, the context menu options in the Alias and VRED columns change. Use these options to revert a Live Reference back to its previous state. Find Reload View, Select, Revert All, Revert Edit, Revert Name, Revert Material, Revert Transformation, Revert Visibility, and Revert Structure. For information on these options, see Revert Context Menu in the Node Column section.

Was this information helpful?