Omniverse Connector Documentation

The Omniverse Connector for CityEngine provides an uni-directional link to Omniverse Nucleus. On top of the basic export functionality, repeated exports with the same name will accumulate using USD composition techniques. This allows for convenient tweaking of an exported model (e.g. updating a single building in a large city) without having to re-run full exports (which are potentially time-consuming).

Omniverse Create and CityEngine side-by-side

Installation Instructions

  1. Install at least one of these CityEngine versions: 2022.1, 2023.0 or 2023.1. Please refer to CityEngine - Get Started for installation instructions.
  2. Install the connector from the corresponding Omniverse Launcher item, see Omniverse Launcher Overview for additional information. You will be able to select into which CityEngine version(s) to install the connector.

Usage Manual

The Omniverse Connector is available through a CityEngine model exporter and behaves like the default USD exporter. The only difference is that the USD data is sent to Nucleus instead of to disk.

Sending Models to Omniverse

The typical steps to send a CityEngine scene to Omniverse are as follows:

  1. In Cityengine, create layers and shapes and optionally assign CGA rules.
  2. Select the desired layers, shapes and/or models.
  3. Choose File -> Export Models… -> Omniverse Connector
  4. Specify the desired Nucleus host name, path and export name, e.g. myName
  5. Click finish.
  6. The exported USD scene will be written to e.g. /Users/CityEngine/myName.
  7. In an Omniverse app (e.g. Composer), either open the /Users/CityEngine/myName/myName_root.usdc file directly or add it as sub-layer or reference to an existing scene.

Updating a prior export

Note: the Omniverse apps (e.g. Composer) will automatically detect when CityEngine updates a layer and will prompt for layer reloading.

If the connector detects a prior export (e.g. /Users/CityEngine/myCity/myCity_root.usdc) on Nucleus with the same name (e.g. myCity), it will non-destructively layer the new models on top of the existing data and hide the outdated models. The data of each such iteration is placed in corresponding edit directories, e.g. /Users/CityEngine/myCity/edit_1/.

Note: to identify updated models between CityEngine and Omniverse, the connector concatenates the CityEngine Shape Name and ObjectID with an underscore _ in between.

CityEngine Inspector

In above example, the resulting prim in Omniverse will be called Shape_1692b074_24b8_11b2_868c_0050b6c161ae_2.

Export Option Reference

export options

Please also refer to the model export section in the CityEngine Manual.

Release Notes

Version 1.0.4 (2023-11-30)

Version 1.0.3 (2023-06-15)

Version 1.0.2 (2023-03-11)

Version 1.0.1 (2022-10-19)

Version 1.0.0 (2022-04-30)

Version 0.9.3 (2021-11-04)

Version 0.9.2 (2021-11-03)

Version 0.9.1 (2021-10-29)

Version 0.9.0 (2021-10-05)

Known Limitations

ArcGIS Blog

Read articles from the CityEngine team.

Go to the blog

What's New

Discover recently added capabilities of CityEngine.

See what's new


Build expertise and connect with the CityEngine community

Build expertise


Share experiences and learn tricks from the CityEngine community.

Join the conversation