unreal.UsdReferenceOptions

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

Bases: Object

Options to display when adding a reference or a payload for a prim

C++ Source:

  • Plugin: USDCore

  • Module: USDClasses

  • File: USDReferenceOptions.h

Editor Properties: (see get_editor_property/set_editor_property)

  • internal_reference (bool): [Read-Write] When enabled, the reference/payload will target a prim on this stage

  • target_file (FilePath): [Read-Write] File to use as the reference

  • target_prim_path (str): [Read-Write] Use a specific prim of the target stage as the referenced/payload prim

  • time_code_offset (float): [Read-Write] Offset to apply to the referenced/payload prim’s time sampled attributes

  • time_code_scale (float): [Read-Write] TimeCode scaling factor to apply to the referenced/payload prim’s time sampled attributes

  • use_default_prim (bool): [Read-Write] Use the default prim of the target stage as the referenced/payload prim

property internal_reference: bool

[Read-Write] When enabled, the reference/payload will target a prim on this stage

Type:

(bool)

property target_file: FilePath

[Read-Write] File to use as the reference

Type:

(FilePath)

property target_prim_path: str

[Read-Write] Use a specific prim of the target stage as the referenced/payload prim

Type:

(str)

property time_code_offset: float

[Read-Write] Offset to apply to the referenced/payload prim’s time sampled attributes

Type:

(float)

property time_code_scale: float

[Read-Write] TimeCode scaling factor to apply to the referenced/payload prim’s time sampled attributes

Type:

(float)

property use_default_prim: bool

[Read-Write] Use the default prim of the target stage as the referenced/payload prim

Type:

(bool)