USD Zip TOP node

Utility node for creating .usdz files containing USD assets.

Since

22.0

This node takes in file input(s) and produces self-contained .usdz files of USD assets by calling the usdzip commandline tool.

See https://openusd.org/release/toolset.html#usdzip for more details about this utility.

Parameters ¶

Generate When

Determines when this node will generate work items. You should generally leave this set to “Automatic” unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.

All Upstream Items are Generated

This node will generate work items once all of the input nodes have generated their work items.

All Upstream Items are Cooked

This node will generate work items once all of the input nodes have cooked their work items.

Each Upstream Item is Cooked

This node will generate work items each time a work item in an input node is cooked.

Automatic

The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.

Cache Mode

Determines how the processor node handles work items that report expected file results.

Automatic

If the expected result file exists on disk, the work item is marked as cooked without being scheduled. If the file does not exist on disk, the work item is scheduled as normal. If upstream work item dependencies write out new files during a cook, the cache files on work items in this node will also be marked as out-of-date.

Automatic (Ignore Upstream)

The same as Automatic, except upstream file writes do not invalidate cache files on work items in this node and this node will only check output files for its own work items.

Read Files

If the expected result file exists on disk, the work item is marked as cooked without being scheduled. Otherwise the work item is marked as failed.

Write Files

Work items are always scheduled and the expected result file is ignored even if it exists on disk.

Cook Type

Determines how work items in the node should cook, e.g. if they should run in process, out of process, or using services.

Source ¶

Creation Method

Asset Layer

The path to the asset root layer. Every external dependency will be automatically added to the .usdz output.

Custom List

Provides a list of files to zip together based on the provided multiparm of file paths.

Input Source

File Path

The path to the file to be read. The file path control depends on what Creation Method is set.

File Tag

The data tag that identifies the result from the upstream work item. Only available when File Source is set to Upstream Output File.

Recurse Directories

For Custom List work, will recurse directories for paths to include in the zip.

Path

The path to a file to be added to the output .usdz file.

Asset File Path

The path to the asset root file to be read. This file and all external dependencies are added to the output .usdz file.

Output ¶

Output File

Name of the .usdz file(s) to create.

Check Compliance

Perform compliance checking of the input files. If the input asset or root layer fails any of the compliance checks, the package is not created and the program fails.

Verbose Logging

Turns on verbose mode, which causes messages regarding files being added to the package to be output to stdout.

Parameters ¶

Source ¶

Output ¶

TOP nodes