unreal.USDPregenSettings

class unreal.USDPregenSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: DeveloperSettings

USD Pregen

C++ Source:

• Plugin: USDPregen

• Module: USDPregenInterchange

• File: USDPregenSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

• import_content_path (DirectoryPath): [Read-Write] Content directory where USD Pregen imports will place assets.

• package_sub_path_template (str): [Read-Write] Template used to build the package sub-path for UAssets produced by USD Pregen imports. Recognized ${PLACEHOLDER} substitutions:

  ${DEFINITION_NAME} - leaf asset definition name (e.g. “tree_02”) ${DEFINITION_VERSION} - leaf asset definition version (e.g. “v2.1”) ${DEFINITION_UID} - leaf asset definition unique id ${PERMUTATION_ID} - target’s permutation id ${ASSET_TYPE} - Unreal asset type (e.g. “StaticMesh”) ${METADATA:KEY} - looks up KEY in the leaf definition’s metadata (populated from

  USD assetInfo, less the built-in keys). Nested dicts are descended via colon-separated paths, e.g. ${METADATA:nested:subcategory}. Missing keys, dict-valued leaves, and array-valued leaves collapse to the “_” sentinel.

  Values are sanitized to package-name-safe characters (alphanumeric and underscore). Empty values become the sentinel “_” so adjacent labels don’t end up as orphans: e.g. “versions/${DEFINITION_VERSION}/” with no version becomes “versions/_/”

• pipelines (Array[SoftObjectPath]): [Read-Write] Pipeline stack used for USD Pregen scene imports via Interchange. These pipelines override the default Interchange pipeline stack when importing through the Pregen button.

property import_content_path: DirectoryPath

[Read-Write] Content directory where USD Pregen imports will place assets.

Type:

(DirectoryPath)

property package_sub_path_template: str

[Read-Write] Template used to build the package sub-path for UAssets produced by USD Pregen imports. Recognized ${PLACEHOLDER} substitutions:

${DEFINITION_NAME} - leaf asset definition name (e.g. “tree_02”) ${DEFINITION_VERSION} - leaf asset definition version (e.g. “v2.1”) ${DEFINITION_UID} - leaf asset definition unique id ${PERMUTATION_ID} - target’s permutation id ${ASSET_TYPE} - Unreal asset type (e.g. “StaticMesh”) ${METADATA:KEY} - looks up KEY in the leaf definition’s metadata (populated from

USD assetInfo, less the built-in keys). Nested dicts are descended via colon-separated paths, e.g. ${METADATA:nested:subcategory}. Missing keys, dict-valued leaves, and array-valued leaves collapse to the “_” sentinel.

Values are sanitized to package-name-safe characters (alphanumeric and underscore). Empty values become the sentinel “_” so adjacent labels don’t end up as orphans: e.g. “versions/${DEFINITION_VERSION}/” with no version becomes “versions/_/”

Type:

(str)

property pipelines: None

[Read-Write] Pipeline stack used for USD Pregen scene imports via Interchange. These pipelines override the default Interchange pipeline stack when importing through the Pregen button.

Type:

(Array[SoftObjectPath])