Revit

Overview

The OMNIVERSE® REVIT CONNECT® Plug-In offers a simple toolkit for Revit Users to send and live sync their model data to an Omniverse Nucleus. This not only gives Revit users a first class renderer through Omniverse View or Omniverse Kit but also the ability to open, edit and sync with any of the NVIDIA Omniverse™ Connect applications. Now, depending on the use case, Revit users can choose the workflows and pipelines that work best for their needs while maintaining up to date revisions for all downstream consumers of their work.

Install Instructions

Please see Launcher Documentation for Installing Connectors.

User Interface

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.

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. .. image:: ../content/images/connect_revit_omniverse_ribbon.png :align: center :alt: Omniverse Ribbon Menu

Send to View

Sends your file directly to Omniverse View. Simply click “Send to View” and Omniverse View will launch with your model loaded and ready to go. If you do not have View installed, you will see the Settings dialog.

Send to View

Note

You must be sure that Omniverse View is installed or that you can access it 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.

Send to View (Video)

Live Sync (Video)

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

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

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 Project

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

Live Sync

The Live Sync toggle switches between a compact “Off” state and and a more detailed “On” state. When Live Sync is on in Revit and in View, changes made in the Revit model are updated in View in real-time.

Sign In Sign In

Setting

Result

Live Sync

Toggle to enable / disable live sync on current file.

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 View install as your viewer.

Note

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

Settings

Send to View Settings

Result

Unset

No View Settings (This setting disables Send to View)

Send to Local

Omniverse View 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

Save

Commits the Changes and Closes the Window

Cancel

Closes the Window and Discarding the Changes

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 BIM Information

The feature is under development

Include Vegetation

When checked, all plants in the Revit model are exported

Enable Family Instancing

When checked, export Revit Family objects

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

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 View, 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.

Materials

When sending your materials to Omniverse View, we replace the low quality textures and shaders associated with Revit and replace them with High Quality Custom Materials inside of Omniverse View. This is done by material mapping and can be controlled via CSV.

CSV and Materials

The CSV Mapping File for Revit can be located in the following directory.

<Documents>/Omniverse/Revit/omniverseMDLtable.csv

CSV File Structure

A CSV file is a Comma Separated Values table of data whose field’s end is defined by a comma ‘,’.

Using Spreadsheet Tools

These tables are a very common format and can be opened/edited inside of Excel (or other spreadsheet tools) and will have 5 columns in them when viewed.

Format

Column

Expected Value

Column A

Name of the material from the application.
Note: Any commas (,) are replaced with an asterisk (*)

Column B

Indicates if there is a parameter override | NONE: default, no special characteristics | COLOR: the 5th column (Column E) will have the parameter name in the MDL
GENERIC: keyword and last resort match in mapping (looks for the value in Column A
in the string of the material name we get from the application e.g. if Column A is
glass and the material from Revit was Special Glass then it would match)
EXCLUDE: materials found in the application but NOT mapped, user could convert these
to real mappings by setting to NONE and changing the values in Column C/D/E (potentially)

Column C

MDL name (no .MDL)

Column D

Path into the location in the Omniverse database (points to a Mount)

Column E

If necessary, the parameter override in MDL

Examples

1
2
3
4
Cardboard,NONE,Cardboard,/NVIDIA/AEC/Library/Materials/Wall_Board
Blue Paint,COLOR,Paint_Satin,/NVIDIA/AEC/Library/Materials/Miscellaneous,diffuse_tint
glass,GENERIC,Clear_Glass,/NVIDIA/AEC/Library/Materials/Glass
Some Material Name,EXCLUDE,WhiteMode,/NVIDIA/AEC/Library/Materials/Styles

code …

Release Notes

Connect 104.2.2017

Fixed

  • OM-36734 - Use Client Library 1.13.15

  • OM-36727 - Australian Fern not mapping correctly

  • OM-36359 - Mullions not exporting

  • OM-36346 - Revit furniture CSV is not working

  • OM-36332 - Revit family with long name or non standard characters does not publish

  • OM-36280 - Revit workshared files have an improper USD hierarchy

  • OM-36126 - MDL temporary files left in <Documents> folder

  • OM-35667 - Revit not showing the correct build in About

  • OM-35501 - Revit connector not exporting linked files

Connect 104.1.1972

Features:

  • Export as prop

  • Support for Revit 2022

  • Support layered USD’s for linked models

  • Checkpoint for Revit

  • Support S3 URL’s in the Connectors

  • Support for instancing of Family Data

  • Separate save options from publish dialog into settings dialog

Fixes:

  • Some light positions for Wall Sconce end up inside walls

  • When A Bad Server Name Is Entered, Connectors Should Handle The Entry In A Way That Is User Friendly

  • Vegetation export does not work for non RPC trees

  • Create Folder Icon and Field Are Out Of Alignment

  • Revit light color is always white

  • Linked models with -‘s in the name (dashes) fail to save

  • Revit Application Crashes After Switching Server

Connect 102.1.1926

  • Support for linked models using layered USD files when using Publish as Project

  • Revit categories now supported on export

../_images/revit_matching-view-categories.png

Connect 101.1.2

  • Updated client library

  • Ribbon fixes for tooltips

  • Fix for ‘hang’ when saving out linked files from Revit with multiple copies of a linked model

  • Fix for when Nucleus is not present and exporting a model or Send to View

  • Save as Prop feature now available - save just the USD not as part of a project

Connect 100.2.0

  • Updated client library for Nucleus connection

  • Fixed Send to View hang for certain filenames

Connect 100.1

  • Generic material support now in CSV

  • Updates to Revit Publish dialog

  • Ability to export imported DWG files in Revit

  • Move to Launcher

  • Fixed missing furniture exports

  • Move to new mount location for materials, vegetation

2020.2 Hotfix

  • Client Library Updated
    • Fixed a bug that would sometimes (very rarely) cause data loss if you got a disconnect while uploading a file.

    • Fixed a bug that would fail to download a file if it was an exact multiple of 1MB

2020.2 Point Release

New Features

  • Update to new OmniConnect library

  • Support for Revit 2021

  • Furniture Mappings

Bug Fixes

  • Performing a Function on an Object Is A Step Behind

  • Objects In Respective Layers Only Display After Reopening the Model/Scene

  • Curtain panels showing invalid at the end

  • Excessive export times

  • Large files, long export times or failed to export

  • Large Revit file not converting

  • Light direction incorrect for some Revit light components

  • Error Upon Opening Revit with Omniverse Panel

  • Revit local setup app RevitOmniSetup.exe for 2020 is copying CSV files to Documents

  • Some AEC materials working in recent Kit builds

  • Cannot Create a New Folder While In the Midst of Exporting/Publishing

  • Furniture mappings not correct

  • Live sync change with moving a light does not work

Known Limitations

Known Limitations

Family Data instancing has been added as a Beta level feature in the Revit Connector. In general, this will take any replicated Family Data item from Revit and represent it once in USD as geometry. All other locations will be instanced geometry. This saves on space and increases general RTX performance. There is a known bug where sometimes the data will be flipped in orientation. This may occur if family data has been re-used but re-oriented. A fix is in process for a future release of the connector.