Connect Sample

The stage created by the HelloWorld Sample

Overview

Build your own NVIDIA Omniverse Connector with prebuilt source code samples that use Pixar’s USD and Omniverse Client Library API’s.

Run build.bat to download the USD and Omniverse dependencies, generate the Visual Studio solution file, and build it.

If interested in what dependencies are necessary to build your own Connector, examine either the premake.lua build configuration file or the output project files in the _compiler folder.

Omni CLI

A command line utility to manage files on a Nucleus Server (omnicli.bat).

This program was initially created to exercise most of the Omniverse Client Library API, but has grown to be a useful utility to interact with Nucleus servers. Typing help will produce a menu that shows the many functions available. Among the most useful are the move/copy functions which can transfer data to and from servers.

HelloWorld (C++)

A sample program that creates a USD stage on a Nucleus server (run_sample.bat).

The sample demonstrates how to:

  • connect to an Omniverse server

  • create a USD stage

  • create a polygonal box and add it to the stage

  • upload an MDL material and its textures to an Omniverse server

  • bind an MDL and USD Preview Surface material to the box

  • add a light to the stage

  • move and rotate the box with live updates

  • disconnect from an Omniverse server

  • print verbose Omniverse logs

  • open an existing stage and find a mesh to do live edits

HelloWorld (Python)

A sample program with the same functionality of the C++ HelloWorld sample written in Python (run_py_sample.bat).

Launcher

The Omniverse Launcher in Windows will open a File Explorer window to allow browsing/running the sample on disk.

To find where the Connect Sample is installed in Linux, find the Connect Sample under the Library:Connectors tab, click the hamburger icon and select “Settings”:

Go to the Settings from the hamburger menu button

Clicking the folder icon next to the Install Path will open a file browser window to where it is installed:

Click the folder icon to open the install location of the Connect Sample

Release Notes

101.1 Point Release

  • Add Linux package for the Omniverse Launcher

  • Add a Python 3 Hello World sample

  • Update the Omniverse Client Library to 1.13

  • Update to Python 3.7

  • Add a Nucleus Checkpoint example

  • Add the ability to create/access a USD stage on local disk in the Hello World sample

100.2 Update

  • Update the Omniverse Client Library fix an issue with overlapping file writes

100.1 Point Release

  • First release

  • HelloWorld sample that demonstrates how to:

    • connect to an Omniverse server

    • create a USD stage

    • create a polygonal box and add it to the stage

    • upload an MDL material and its textures to an Omniverse server

    • bind an MDL and USD Preview Surface material to the box

    • add a light to the stage

    • move and rotate the box with live updates

    • print verbose Omniverse logs

    • open an existing stage and find a mesh to do live edits

  • OmniCLI sample that exercises most of the Omniverse Client Library API