Using the Data Adapter

Enabling The Extension

Note

This extension is enabled by default in Create 2022.3.0 and above.

The extension can be enabled via the Window -> Extensions window.

Search for Data Adapter.

There are three extensions available. You will see:
  • omni.data.adapter.core

  • omni.data.adapter.ui

  • omni.data.adapter.bundle

In most cases enabling the bundle extension is all that is needed. This will load both core and ui extensions automatically.

Once enabled, the Data Adapter panels can be opened via the Window -> Utilities -> Data Adapter menu item.

Using The Adapter

When the Data Adapter is enabled, the following UI is displayed:

../../_images/ext_data_adapter_main_interface.png
  • Load Preset
    • Load a previously saved JSON configuration file describing a series of processes.

  • Save Preset
    • Save the current process stack to a JSON file for later use.

  • Execute All
    • Executes all of the processes that are configured from top to bottom.

  • Clear All Processes
    • Removes all processes from the UI.

  • Add Data Adapter Process
    • Add processes that will be performed on the stage.

Reordering Processes

As processes are added they will be appended to the list. Processes can be reordered (click and drag the drag handle in the top-left corner of a process) or removed (click the delete button in the top-right corner of a process). You can also expand/collapse a process by clicking on the top header section of it.

../../_images/ext_data_adapter_processes.png

The image above shows the main interface with a couple of processes, in the middle of a drag operation. The blue drop target highlights to show where it is valid to move a process. Also shown are where to click to initiate a drag or delete a process.

Editing Prim Paths

Some processes can have a list of prim paths or regular expressions specified in order to restrict what they operate on:

../../_images/ext_data_adapter_edit_prim_paths.png

Those processes will have an argument that looks like the screenshot above. You can freely type a prim path or regular expression in the text field. Clicking Add will add any selected prims in the stage to the list. Clicking the pencil icon will open a new window, shown below, that lets you more easily manipulate what is included.

../../_images/ext_data_adapter_edit_prim_paths_panel.png

This panel lets you add the stage selection, delete items, or select items in the stage.