unreal.DatasmithDeltaGenSceneElement

class unreal.DatasmithDeltaGenSceneElement(outer=None, name='None')

Bases: unreal.DatasmithSceneElementBase

Extends UDatasmithSceneElementBase with a couple of functions that can be used by Blueprints and Python to handle DeltaGen scene imports. This library handles importing into memory Datasmith scene objects, so that the imported data can be processed or parsed. Later, this intermediate (potentially processed) object can be imported, creating assets and scene actors.

See: UDatasmithDeltaGenBlueprintLibrary

C++ Source:

  • Plugin: DatasmithFBXImporter
  • Module: DatasmithDeltaGenImporter
  • File: DatasmithDeltaGenBlueprintLibrary.h
classmethod construct_datasmith_scene_from_file(file_path, package_name, datasmith_import_options, delta_gen_import_options) → DatasmithDeltaGenSceneElement

Open an existing DeltaGen FBX file from disk, returning the DatasmithScene object before its imported or assets are created

Parameters:
  • file_path (str) – FBX file path to open (example: c:/MyFolder/MyFiles.fbx)
  • package_name (str) – Content folder to import to (example: /Game/ImportedScenes)
  • datasmith_import_options (DatasmithImportBaseOptions) – Base datasmith import options, like whether to import geometry, materials, etc
  • delta_gen_import_options (DatasmithDeltaGenImportOptions) – Import options specific to DeltaGen, like whether to import variants or not. Can be nullptr/None
Returns:

The opened Datasmith scene, that can be modified and later imported or destroyed

Return type:

DatasmithDeltaGenSceneElement

destroy_scene() → None

Destroy reference to the Datasmith Scene DestroyScene is called automatically after ImportScene, once the assets have been created and spawned into the level

get_all_animation_timelines() -> Array(DeltaGenTmlDataTimeline)

Returns a copy to an array with all parsed animation timelines from the .tml file

Returns:Array of AnimNodes
Return type:Array(DeltaGenTmlDataTimeline)
get_all_variants() -> Array(DeltaGenVarDataVariantSwitch)

Returns a copy to an array with all parsed variants and variant sets from the .var file

Returns:Array of FDeltaGenVarDataVariantSwitch
Return type:Array(DeltaGenVarDataVariantSwitch)
import_scene() → DatasmithDeltaGenImportFactoryCreateFileResult

Import a Datasmith Scene created with ConstructDatasmithSceneFromFile.

Returns:A structure that contains the created scene actors as well as referenced to the created data table assets
Return type:DatasmithDeltaGenImportFactoryCreateFileResult
set_all_animation_timelines(new_timelines) → None

Sets the scene AnimNodes to the received array

Parameters:new_timelines (Array(DeltaGenTmlDataTimeline)) –
set_all_variants(new_variants) → None

Sets the scene variants to the received array

Parameters:new_variants (Array(DeltaGenVarDataVariantSwitch)) – Array of variants taken by copy