unreal.UsdMetadataImportOptions

class unreal.UsdMetadataImportOptions(collect_metadata: bool = False, collect_from_entire_subtrees: bool = False, collect_on_components: bool = False, blocked_prefix_filters: None = [], invert_filters: bool = False)

Bases: StructBase

Usd Metadata Import Options

C++ Source:

• Plugin: USDImporter

• Module: USDClasses

• File: USDMetadataImportOptions.h

Editor Properties: (see get_editor_property/set_editor_property)

• blocked_prefix_filters (Array[str]): [Read-Write] When collecting metadata, we will ignore all entries that start with these prefixes. Note that you can use the “:” separator for nested dictionaries, so for example using “customData:ign” to ignore anything within the “ignoredValues” dictionary inside the “customData” dictionary

• collect_from_entire_subtrees (bool): [Read-Write] Whether to collect USD metadata from not only a particular prim, but its entire subtree, when apropriate. This is useful when used together with collapsing settings, for example.

• collect_metadata (bool): [Read-Write] Whether to collect USD prim metadata into AssetUserData objects at all

• collect_on_components (bool): [Read-Write] We will always add the collected metadata to AssetUserData objects assigned to all generated assets that support them. When this option is enabled, however, we will also separately collect USD prim metadata and add that to AssetUserData objects added to every spawned component. This can be useful for tracking metadata on prims that don’t usually generate assets, like simple Xforms, cameras, lights, etc., or for collecting metadata for prims with alternative draw modes enabled, like bounds or cards: We won’t generate the usual assets for those, but the metadata could still be collected on the components with this option.

• invert_filters (bool): [Read-Write] When this is false (default), the “BlockedPrefixFilters” property describe prefixes to block, and metadata entries that match any of those prefixes are ignored and not collected. When this is true, the “BlockedPrefixFilters” property is inverted, and describes prefixes to allow. In that case, entries are only allowed and collected if they match at least one of the provided prefixes.

property blocked_prefix_filters: None

[Read-Write] When collecting metadata, we will ignore all entries that start with these prefixes. Note that you can use the “:” separator for nested dictionaries, so for example using “customData:ign” to ignore anything within the “ignoredValues” dictionary inside the “customData” dictionary

Type:

(Array[str])

property collect_from_entire_subtrees: bool

[Read-Write] Whether to collect USD metadata from not only a particular prim, but its entire subtree, when apropriate. This is useful when used together with collapsing settings, for example.

Type:

(bool)

property collect_metadata: bool

[Read-Write] Whether to collect USD prim metadata into AssetUserData objects at all

Type:

(bool)

property collect_on_components: bool

[Read-Write] We will always add the collected metadata to AssetUserData objects assigned to all generated assets that support them. When this option is enabled, however, we will also separately collect USD prim metadata and add that to AssetUserData objects added to every spawned component. This can be useful for tracking metadata on prims that don’t usually generate assets, like simple Xforms, cameras, lights, etc., or for collecting metadata for prims with alternative draw modes enabled, like bounds or cards: We won’t generate the usual assets for those, but the metadata could still be collected on the components with this option.

Type:

(bool)

property invert_filters: bool

[Read-Write] When this is false (default), the “BlockedPrefixFilters” property describe prefixes to block, and metadata entries that match any of those prefixes are ignored and not collected. When this is true, the “BlockedPrefixFilters” property is inverted, and describes prefixes to allow. In that case, entries are only allowed and collected if they match at least one of the provided prefixes.

Type:

(bool)