Manual

The Omniverse Revit Plugin brings Revit into the Omniverse Platform through the use of NVIDIA Omniverse™ Connect tools similar to other NVIDIA Omniverse™ Connect applications.

Install the Connector

Follow our Connector installation instructions to install this connector.

User Interface

With the Plugin installed, Revit should display an Omniverse Menu now visible in the top menu.

Clicking this menu will reveal the ribbon panel for Omniverse Interactions.

Send to Omniverse

Sends your file directly to Omniverse USD Presenter or Create. The “Send To” application is controlled in the settings. Simply click “Send to Omniverse” and Omniverse USD Presenter or Create will launch with your model loaded and ready to go. If you do not have View or Create installed, you will see the Settings dialog.

Note

You must be sure that Omniverse USD Presenter or Create are installed or that you can access them from a server for this feature to work. See Settings for more details.

Note

When you Send your file, you create a connection for Live Sync which is visible in the Live Sync Path dialogue.

Note

If Nucleus is not installed or is not running, you will be asked if you want to save locally. To do this automatically, turn on “Do not use Nucleus” in the settings. Live workflow cannot be used with this setting on.

Publish Project

Publishes your file to the desired location as a named Project. Publishing your project to your NVIDIA Omniverse™ Nucleus allows you to continue your work in other Omniverse Apps and connectors.

Note

When you export your file, you create a connection for Live Sync which is visible in the Live Sync Path dialogue.

When Publish is clicked, the Revit model is saved as “child” .usd file, with a name matching the Revit model name. A parent project.usd is created with a reference to the child .usd file.

Element	Result
Refresh	Updates the Window with Latest Data
Left/Right	Moves Through the Current Directory Structure in a Step By Step Fashion
Create New Folder	Creates a New Directory at Current File Path
Left Pane	Lists NVIDIA Omniverse™ Nucleus Directories (If Logged-In) and Local Drives / Directories
Right Pane	Lists Files in Currently Selected Directory
Project Folder	The location and name of the project to create
Save format	Allows Selection of File Export Type
Description	Text to be used as the text on the file checkpoint
Show Publish Options	Display the Settings dialog so that user can select Publish/Export options
Publish	Publishes the Revit file using the Project Workflow.
Cancel	Stops the Export Process and Closes Publish Dialogue

Export as Prop

Like Publish Project, this exports your file to the desired location as a more compact Prop format

Note

When you export your file, you create a connection for Live Sync which is visible in the Live Sync Path dialogue.

When Export clicked, the Revit model is saved as a .usd file.

Element	Result
Refresh	Updates the Window with Latest Data
Left/Right	Moves Through the Current Directory Structure in a Step By Step Fashion
Create New Folder	Creates a New Directory at Current File Path
Left Pane	Lists NVIDIA Omniverse™ Nucleus Directories (If Logged-In) and Local Drives / Directories
Right Pane	Lists Files in Currently Selected Directory
Project Folder	The location and name of the project to create
Save format	Allows Selection of File Export Type
Description	Text to be used as the text on the file checkpoint
Show Publish Options	Display the Settings dialog so that user can select Publish/Export options
Export	Exports the Revit file as a Prop file
Cancel	Stops the Export Process and Closes Export Dialogue

Batch Export

Use this feature to export all or a subset Revit files within a folder (up to 3 levels of depth from the root folder) as props or projects. The hierarchy of the folders and files is preserved in the export.

Note

Select either as Projects or as Props depending on the intended result.

Select the root folder containing the files you would like to export.

Check / Uncheck the files you want to export / not export respectively.

Specify the output location you would like to export these files to and the batch export begins.

Additional Notes:

• Revit files which are lower than the current version will be automatically upgraded

• User will be required to click through Revit UI / popups as they appear, including workset selection, errors.

Live Sync

The Live Sync button switches between “Off” state and and “On” state. When turning on Live Sync, you can either join an existing Live Session or create a new Live Session. When Live Sync is on in Revit and in View or Create, changes made in the Revit model are updated in View or Create in real-time. When using Live Sync on a project export, you must join the corresponding layer from the layers tab in Create.

Setting	Result
Live Sync	Toggle to enable / disable live sync on current file.
Participants	Show the participants of the active Live Session
Path	When connected to a file, will show path to linked file.
Connect	Opens a dialog where you can select the .usd file to link with.

Account

The Account dialog allows users to connect to their NVIDIA Omniverse™ Nucleus Server for Exporting, using Live Sync and for Mounts.

Setting	Result
Server	Address of Omniverse Nucleus Server
Ok	Begins the Connection with Selected User/Server
Cancel	Stops the Sign-In Process and Closes the Sign-In Window

Note

If you have trouble logging into Omniverse via the Revit Plugin, try Launching Revit as Administrator.

Settings

The settings dialog allows you to select a preferred View or Create install as your viewer.

Note

You will need to have View or Create installed and selected to use Send to Omniverse.

Send to View Settings	Result
Unset	No View Settings (This setting disables Send to View)
Send to Local	Omniverse USD Presenter or Create Launch Path
Use Current/Use Custom	“Use Current” locates current View Installs Automatically, “Use Custom” uses the Custom View Location value
Custom View Location	Allows Selections of View Installs not Found by Automatic
Send to Server	Omniverse Remote View Launch Path
Use Current/Use Custom	“Use Current” locates current Remote View Installs Automatically, “Use Custom” uses the Remote Launcher location value
Remote Launcher	Allows for Selection of a Remote Viewer
Render Size	Render Quality to Use in View when Launching Remotely
Project/Prop toggle	Determines the output type when using Send To View. See Publish Project and Export As Prop for details
Do Not Use Nucleus	Send to Omniverse will bypass Nucleus and save to the specified folder, OFF by default, must be OFF to use Live Workflow
Local Folder Path	Path to save files to when Do Not Use Nucleus is enabled
Save	Commits the Changes and Closes the Window
Cancel	Closes the Window and Discarding the Changes

Scene Optimizer

When enabled, runs USD optimizations on scene data for USD export or sending to Omniverse.

Publish/Export Options	Result
Include cameras	When checked, all elevations in the the Revit model are exported as cameras
Include lights	When checked, Revit Light objects are exported
Include Vegetation	When checked, all plants in the Revit model are exported
Include Rooms	When checked, exports rooms within the model as mesh volumes.
Include Spaces	When checked, exports spaces within the model as mesh volumes.
Include Drawings	When checked, exports drawings as textured mesh planes anchored at real-world scale to the model.
Enable Family Instancing	When checked, export Revit Family objects
Enable Logging	When checked, a log is created and a dialog displaying any errors or warnings is shown after export
Export By Selected Views	When checked, users can export views within a single Revit files as separate USDs.
Use Material Mapping	When this and Use Autodesk Materials are both checked, mapped materials are used in place of Autodesk rendering assets.
Use Autodesk Materials	When checked, use the rendering assets of Revit materials
Include BIM Information	When checked, parameters of Revit elements are exported as USD properties

Scene Optimization

Scene Optimization utilizes core optimization libraries found in the standalone application and kit extension that performs scene optimizations at the USD level. This allows complex scenes to be converted into more lightweight representations which can be displayed and evaluated more quickly.

The integration provides various processes which can be used individually or in combination stack to optimize a scene. A few base configurations have been provided in the connector to optimize the data prior to sending to Create.

To use a different optimization preset, click > + then navigate to the desired json configuration file.

Please see the Scene Optimizer user manual for information on the optimization operations and how to create custom configuration files.

Note

Merging texture based materials is not currently supported, only base colors.

Export By Selected Views

With this setting checked, users can export views within a single Revit files as separate USDs. Depending on whether the user has selected prop or project export, the USDs are combined into a single project or not.

This feature is intended for models whose elements are separated by views showing worksets, phases, or other forms of categorization set by the user.

Similar to the Batch export UI, users can select which views to export. For example, this Brownstone model has views separating interior, exterior and FF&E elements:

When exported as a project to Omniverse, elements in views are exported as separate USD files and combined into a single project (viewed in Create):

Additional Notes

• If an element is shown in multiple views, it will be exported to each USD representing that view.

• Names of exported views take the provided name of the file in the export UI + the name of the view.

Export Log

With logging enabled in settings, warnings and errors encountered in export as surfaced in a simple UI after export. This can provide some clarity on elements which failed to convert.

Note

Logs are saved in %localappdata%NVIDIA CorporationOmniverseLogs

Drawing Export

With this setting checked, you can now export drawings from Print Sets as textured mesh quads which are anchored in place to their respective areas.

To create a print set, open the Print dialog in Revit. You have the ability to choose which print set’s drawings you would like exported to the model.

Drawings must have crop regions in their view in order to anchor to the model. If a drawing wasn’t successfully exported, this is because the drawing did not possess a crop region.

Drawings are located in the USD hierarchy under the path World/{modelName}/Media/Drawings , which is invisible by default.

Use drawing export in combination with the Section widget in Create to bring your floorplans to life:

Additional Notes

• Transparency can be applied in images in Create by modifying the material.

Room & Space Export

You can now check Include Rooms and Include Spaces in the settings window. This will export these areas as volumes.

Rooms and spaces are located in the USD hierarchy under the path World/{modelName}/Geometry/Rooms , which is invisible by default.

In versions 2022 and 2023, you can select a color scheme with which to color the exported rooms - this will create new materials in your USD.

Additional Notes

• Volume of room object may be smaller than the volume of the room.

• If a valid color cannot be generated, a random or default one is assigned.

About

The About dialog shows the current version information, and provides helpful links to access Release Notes and to Get Support

File creation from Send to Omniverse, Publish Project or Export as Prop

Exporting your project to your NVIDIA Omniverse™ Nucleus allows you to continue your work in other Omniverse Apps and connectors.

Note

When you export your file, you create a connection for Live Sync which is visible in the Live Sync Path dialogue.