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

Omniverse Menu Location

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.

Omniverse Ribbon Menu

Send to Omniverse

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

Send to Omniverse

Note

You must be sure that Omniverse USD Presenter or Omniverse USD Composer 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.

Publish Project

Note

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

Publish Project

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

Uri

Path to the Currently Selected Directory

Left Pane

Lists NVIDIA Omniverse™ Nucleus Directories (If Logged-In) and Local Drives / Directories

Center Pane

Lists Files and Folders in Currently Selected Directory

Right Pane

File/Folder information, Checkpoint Comment input

File Name

Name of the .project.usd to Save

Extension

Choose between .usd, .usda etc

Publish Project

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

Export Prop

Note

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

Publish Prop

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

Element

Result

Uri

Path to the Currently Selected Directory

Left Pane

Lists NVIDIA Omniverse™ Nucleus Directories (If Logged-In) and Local Drives / Directories

Center Pane

Lists Files and Folders in Currently Selected Directory

Right Pane

File/Folder information, Checkpoint Comment input

File Name

Name of the File to Save

Extension

Choose between .usd, .usda etc

Publish Prop

Publishes the Revit file using the Prop Workflow.

Cancel

Stops the Export Process and Closes Publish Dialogue

Batch Export

Use this feature to export all of the Revit files within a folder as props or projects. The hierarchy of the folders and files is preserved in the export. A configurable .json file will be created in the selected input folder. This .json can be edited to drive settings for future bactch exports.

Batch export button

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.

Batch Publish

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

Batch Publish

Additional Notes:

  • Revit files which are lower than the current version will be automatically upgraded, but not saved

  • Most Revit pop-ups have been supressed but occasionally the user will be required to click through Revit UI / popups as they appear.

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 Omniverse USD Presenter or Omniverse USD Composer, changes made in the Revit model are updated in Omniverse USD Presenter or Omniverse USD Composer in real-time. When using Live Sync on a project export, you must join the corresponding layer from the layers tab in Omniverse USD Composer.

Sign In Sign In

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.

Sign In

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 Omniverse USD Presenter or Omniverse USD Composer install as your viewer.

Note

You will need to have Omniverse USD Presenter or Omniverse USD Composer installed and selected to use Send to Omniverse.

Settings

Send to Omniverse Settings

Result

Unset

No Omniverse Settings (This setting disables Send to Omniverse)

Send to Local

Omniverse USD Presenter or Omniverse USD Composer Launch Path

Use Current/Use Custom

“Use Current” locates current Omniverse USD Presenter and Omniverse USD Composer Installs Automatically, “Use Custom” uses the Custom Location value

Custom Location

Allows Selections of Installs not Found by Automatic

Send to Server

Omniverse Remote Launch Path

Use Current/Use Custom

“Use Current” locates current Remote 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 when Launching Remotely

Project/Prop toggle

Determines the output type when using Send To Omniverse. 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 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 is 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

Advanced Settings Options

Result

Use Advanced Settings

When checked, Advanced Settings are used during exports

Edit

Opens a dialog to edit the Advanced Settings

Advanced Settings

Advanced Settings allow a “One-Click” export experience with fully customizable settings. These settings are saved internally to the Revit file, so all members of the Project Team can export in the same way. Additionally, Advanced settings allow for a Project or BIM Manager to set an override .json file to control a subset of export settings across projects.

Advanced Settings

Standard Options

Result

Include Cameras

When checked, all elevations in 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 colored by selected color scheme.

Include Spaces

When checked, exports spaces within the model as mesh volumes colored by selected color scheme.

Include Drawings

When checked, exports drawings from selected Publish Set 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

Include BIM Information

When checked, parameters of Revit elements are exported as USD properties

Include Links

When checked, linked Revit models are included in the export

Use Revit Materials

When selected, use the rendering assets of Revit materials

Use Material Mapping

When selected, mapped materials are used in place of Autodesk rendering assets.

Prop Export

When selected, Revit model is exported with Prop Workflow

Project Export

When selected, Revit model is exported with Project Workflow

View Options

Result

View Name

3D Revit View to export

Detail Level

Set the detail level to be temporarily applied to the view during export

Phase Filter

Set the phase filter to be temporarily applied to the view during export

View Template

Set the view template to be temporarily applied to the view during export

Coordinate System

Set the coordinate system to be used during model export

Output Options

Result

Output Folder

Select a folder for the export

File Name

Specify the name and usd extension of the file. Tokens may be used as variables in the file name.

Global Json

Optionally select a .json file to override some of all of the Advanced Settings

I/O

Result

Import Json

Select a .json file to import and apply its settings

Export Json

Save the current advanced settings as an external .json file

Save

Save the current advanced settings internally into the Revit model (Revit file must be Saved/Synced for settings to persist)

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 Omniverse USD Composer.

../_images/connect_revit_scene_optimization.png ../_images/connect_revit_scene_optimization_json.png

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.

../_images/revit_release-notes_108_2_2211_4ExportBySelectedViews.png

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:

../_images/revit_release-notes_108_2_2211_6SelectedViewsStep1.png

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

../_images/revit_release-notes_108_2_2211_6SelectedViewsStep2.gif

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.

../_images/revit_release-notes_108_2_2211_5ExportLogUI.png

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.

../_images/revit_release-notes_108_2_2228_drawings.png

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.

../_images/revit_release-notes_108_2_2228_printSets.png

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.

../_images/revit_release-notes_108_2_2228_elevation_trans2.png

Use drawing export in combination with the Section widget in Omniverse USD Composer to bring your floorplans to life:

../_images/revit_release-notes_108_2_2228_drawings_gif.gif

Additional Notes

  • Transparency can be applied in images in Omniverse USD Composer 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.

../_images/revit_release-notes_108_2_2228_roomVolumes.png

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.

../_images/revit_release-notes_108_2_2228_roomScheme.png

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

Settings

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.