unreal.UsdSparseVolumeTextureAssetUserData

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

Bases: UsdAssetUserData

We use this mainly to help in mapping between stage timeCode and the FrameIndex for animated SVTs

C++ Source:

  • Plugin: USDImporter

  • Module: USDClasses

  • File: USDAssetUserData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • prim_paths (Array[str]): [Read-Write] Paths to prims that generated the asset that owns this AssetUserData

  • source_open_vdb_asset_prim_paths (Array[str]): [Read-Write] Paths to all the OpenVDBAsset prims that led to the generation of this SVT asset

  • stage_identifier_to_metadata (Map[str, UsdCombinedPrimMetadata]): [Read-Write] Holds metadata collected for this asset, from all relevant Source prims. The asset that owns this user data may be shared via the asset cache, and reused for even entirely different stages. This map lets us keep track of which stage owns which bits of metadata

  • time_sample_path_indices (Array[int32]): [Read-Write] Corresponding indices of the frame of the SVT that should be played at a particular timeCode. Example: TimeSamplePathTimeCodes is [10, 20] and TimeSamplePathIndices is [2, 7] –> At timeCode 10 the frame index 2 of the SVT should be played, i.e. the .vdb file that is the third entry within TimeSamplePaths

  • time_sample_path_time_codes (Array[double]): [Read-Write] TimeCodes of all the filePath attribute time samples as seen on the OpenVDBAsset prim in its own layer, in order

  • time_sample_paths (Array[str]): [Read-Write] File paths that originated each of the SVT frames, in order. The SVT should have as many frames as there are entries in this array.

property source_open_vdb_asset_prim_paths: None

[Read-Write] Paths to all the OpenVDBAsset prims that led to the generation of this SVT asset

Type:

(Array[str])

property time_sample_path_indices: None

[Read-Write] Corresponding indices of the frame of the SVT that should be played at a particular timeCode. Example: TimeSamplePathTimeCodes is [10, 20] and TimeSamplePathIndices is [2, 7] –> At timeCode 10 the frame index 2 of the SVT should be played, i.e. the .vdb file that is the third entry within TimeSamplePaths

Type:

(Array[int32])

property time_sample_path_time_codes: None

[Read-Write] TimeCodes of all the filePath attribute time samples as seen on the OpenVDBAsset prim in its own layer, in order

Type:

(Array[double])

property time_sample_paths: None

[Read-Write] File paths that originated each of the SVT frames, in order. The SVT should have as many frames as there are entries in this array.

Type:

(Array[str])