Connecting to an Omniverse Live Session

Mode

Tool

Tool set

Live

 

Omniverse Connector

(Windows only)

 

Visualization

Vectorworks offers Windows users the ability to create or join an Omniverse Live Session, where you can live sync the active Vectorworks file with other users connected to the same live session. (See Connecting to the NVIDIA Omniverse collaboration platform for the technical requirements for connecting to Omniverse.) The live session can send both graphical and non-graphical data (such as IFC and record information) from the Vectorworks drawing to Omniverse, depending on the Omniverse Connector preferences. 

Live sessions are associated with specific models and specific USD file paths on the Nucleus server. These connections must be established each time a new live session is begun, either by selecting an existing USD file to use for the new session, or by creating a new file and file path for the session. Because live sessions are a collaborative environment, live sessions created by other participants are available for use, as long as they are associated with the same file path.

To create or join an Omniverse Live Session:

From a Vectorworks design layer, select a 3D view.

Click the tool, and then click Preferences.

The Omniverse Connector Preferences dialog box opens; see Omniverse Connector preferences.

Set the desired settings on the Export tab, select the desired Nucleus Server on the Tool tab, and then click OK

Click the mode. 

If you are not already logged in to the Omniverse platform, you are prompted to do so.

The Choose Model Path dialog box opens.

Click to show/hide the parameters.Click to show/hide the parameters.

Parameter

Description

Select model USD path on Nucleus server

Uses an existing USD file for this model on the Nucleus server

Publish current file to define path

Creates a new USD file and establishes the file path for the live session. 

Define the model path and USD file to be used for this live session.

Depending whether you're selecting an existing file or publishing a new one, either the Select File for Live Session dialog box or the Publish to Omniverse dialog box opens. The Select File for Live Sessions dialog box contains the folder browser and file information browser needed to select a file, without the additional options needed to publish a USD file. 

These dialog boxes provide access to folders saved to the Nucleus server specified in the Omniverse Connector Preferences dialog box; to change servers and access different folders, exit the dialog box and change the selection there. 

Select a file or publish one as described in Publishing to Omniverse.

After you set up the file path, the Live Session Options dialog box opens.

Click to show/hide the parameters.Click to show/hide the parameters.

Parameter

Description

Create new session

Creates a new live session; name the session

Join existing session

Joins an existing live session; select the session from the list of ongoing live sessions associated with the current Vectorworks document's USD model path

Participants

Displays participants already connected to the live session

Create or select the live session to join.

The Status bar indicates you joined the session, and Live mode is selected on the Tool bar.

Open an Omniverse application, such as USD Composer.

Within the Omniverse application, navigate to the exported Vectorworks file on the Nucleus server and make the session live as instructed in the Omniverse help.

You enter a synchronized live session; all participants' file changes automatically display in Omniverse for everyone in the session. A message on the Vectorworks and Omniverse Status bars indicates if participants enter or leave the live session.

Completing any of the following actions during the Vectorworks session automatically pauses the live session; a message on the Status bar indicates when a live session has been paused, and Live mode on the Tool bar is deselected:

Switch to a different open Vectorworks file

Change to Top/Plan view

Change to a view that shows a significantly different view of the model (such as a view with different visible classes and layers, and so on) that would change the reference model for Omniverse

Navigate to a sheet layer

Enter a symbol or group

Click Live mode on the Tool bar to restart the live session; as long as the original file used for the live session remains open and is used to restart the session, the same Live Session Settings displayed on the Omniverse Connector Preferences dialog box apply.

Ending an Omniverse Live Session

To end a live session:

Click Live mode on the Tool bar of an active session; the mode toggles off. 

If you're the administrator of the live session you're ending, the Merge or Discard Live Session dialog box opens. If you're not the administrator, you are given the choice of whether to merge the changes to a new sublayer, or to discard the changes. 

Click to show/hide the parameters.Click to show/hide the parameters.

Parameter

Description

Merge changes to the USD root layer

Commits the changes made in the Vectorworks file during the live session to the main model that all participants share; the changes replace the information in the root file

Merge changes to a new USD sublayer

Saves the changes made in the Vectorworks file during the live session to a new sublayer of the main model. This selection makes the changes available for use by other participants as a reference in an organized composition of USD models but does not replace the information in the root file; it is recommended when someone else is in charge of managing the overall project and file.

Discard Live Session changes

Does not save the changes made in the Vectorworks file during the live session; the Vectorworks file retains the changes, but they are not added to the USD model

A message on the Status bar indicates the live session was ended, and Live mode on the Tool bar is deselected. The USD file path and session name are cleared from the Live Session Settings and must be reestablished before a new session can begin.

Closing the Vectorworks file used for the live session also ends a live session and clears the session settings.

Connecting to the NVIDIA Omniverse collaboration platform

Omniverse Connector preferences

Sending a model to Omniverse locally

Publishing to Omniverse

 

Was this page helpful?