unreal.InterchangeUsdTranslatorSettings

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

Bases: InterchangeTranslatorSettings

Interchange Usd Translator Settings

C++ Source:

  • Plugin: InterchangeOpenUSD

  • Module: InterchangeOpenUSDImport

  • File: InterchangeUsdTranslator.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attribute_regex_filter (str): [Read-Write] Regex to match against USD prim attribute names to decide whether to convert them into translated node user attributes

  • custom_handler_entries (Array[SchemaHandlerEntry]): [Read-Write] Custom array of schema handlers to use for translation. When this is empty, the default FSchemaHandlerRegistry::RegisteredHandlerEntries array will be used instead.

    It is expected for this array to essentially be a reorder of FSchemaHandlerRegistry::RegisteredHandlerEntries, with additionally some modified property values on schema handler entries, if needed (e.g. enabled or custom render contexts).

    It is not sufficient to create a new FSchemaHandlerEntry instance from scratch and insert here directly: If you have a custom handler, you want to register it on FSchemaHandlerRegistry instead, so as to also get the handler generator function correctly registered. At that point, your handler will also be added to FSchemaHandlerRegistry::RegisteredHandlerEntries.

  • geometry_purpose (int32): [Read-Write] Only import geometry prims with these specific purposes from the USD file

  • interpolation_type (UsdInterpolationType): [Read-Write] Describes how to interpolate between a timeSample value and the next

  • kinds_to_collapse (int32): [Read-Write] Which prim kinds that are allowed to collapse its children and/or be collapsed. See also the “USD.CollapsePrimsWithoutKind” cvar.

  • material_purpose (Name): [Read-Write] Specifies which material purpose to use when parsing USD material bindings, in addition to the “allPurpose” fallback

  • metadata_regex_filter (str): [Read-Write] Regex to match against the full USD prim metadata key to decide whether to convert them into translated node user attributes.

    Note that nested dictionaries are flattened using the “:” character as separator. So a myMetadata key inside the customData dictionary will end up with the full key ‘customData:myMetadata’, and could be selected by a regex filter ‘customData:my’, or just ‘custom’, or ‘my’, etc.

  • override_stage_options (bool): [Read-Write] Whether to use the specified StageOptions instead of the stage’s own settings

  • point_instancer_collapsing (UsdPointInstancerCollapsing): [Read-Write] How the USD Translator should behave when it tries collapsing a subtree and encounters a PointInstancer prim

  • prims_to_import (Array[str]): [Read-Write] List of prim paths to import. Defaults to just [“/”], which imports the entire stage.

    Example: [TEXT(“/Root/MySubtree”), TEXT(“/Classes/MyClassPrim”)]

    Note that unlike the other settings this does not persist across imports, as it is specific to each individual stage.

  • stage_options (UsdStageOptions): [Read-Write] Custom StageOptions to use for the stage

  • translate_prim_attributes (bool): [Read-Write] Whether to convert USD prim default attribute opinions (i.e. non-animated) into translated node user attributes, ultimately ending up imported as asset and actor metadata.

    Note that AttributeRegexFilter may be needed in order to select only the desired metadata, as otherwise regular attributes like ‘points’ and ‘faceVertexCounts’ will also get translated into Interchange metadata, which could be expensive.

  • translate_prim_metadata (bool): [Read-Write] Whether to convert USD prim metadata into translated node user attributes, if they pass the regex filter. See MetadataRegexFilter.

  • use_prim_kinds_for_collapsing (bool): [Read-Write] Use KindsToCollapse to determine when to collapse prim subtrees or not (defaults to disabled on Interchange). Disable this if you want to prevent collapsing, or to control it manually by right-clicking on individual prims.

  • use_schema_for_collapsing (bool): [Read-Write] Whether to use the dedicated collapsing schema to collapse prim subtrees into single meshes