1. Epic GamesDeveloper
  3. FDatasmithImportContext

FDatasmithImportContext

API > API/Plugins > API/Plugins/DatasmithImporter

References

   
Module DatasmithImporter
Header /Engine/Plugins/Enterprise/DatasmithImporter/Source/DatasmithImporter/Public/DatasmithImportContext.h
Include #include "DatasmithImportContext.h"

Syntax

struct FDatasmithImportContext

Variables

  Type Name Description
Public variable FDatasmithActorImportContext ActorsContext Actors specific import context
Public variable TArray< TObjectPtr< UDatasmithOptionsBase > > AdditionalImportOptions Per-Translator settings related to the import of a Datasmith scene
Public variable FDatasmithAssetsImportContext AssetsContext Assets specific import context
Public variable bool bImportedViaScript  
Public variable bool bIsAReimport  
Public variable TAtomic< bool > bUserCancelled Indicates if the user has canceled the import process
Public variable TSharedPtr< void > ContextExtension Generic extension
Public variable FFeedbackContext * FeedbackContext Feedback context provided by ImportFactory. Used to display import progress
Public variable FMD5Hash FileHash Cached MD5 hash value for faster processing
Public variable TSharedPtr< IDatasmithScene > FilteredScene IDatasmithScene object filtered with only what will actually go through the import process
Public variable TArray< USceneComponent * > Hierarchy Stack of parent components we're currently importing under
Public variable TMap< TSharedRef< IDatasmithClothElement >, TObjectPtr< UObject > > ImportedClothes  
Public variable TArray< UObject * > ImportedClothPresets  
Public variable TMap< TSharedRef< IDatasmithLevelSequenceElement >, TObjectPtr< ULevelSequence > > ImportedLevelSequences Map of imported level sequences for each level sequence element
Public variable TMap< TSharedRef< IDatasmithLevelVariantSetsElement >, TObjectPtr< ULevelVariantSets > > ImportedLevelVariantSets Map of imported level variant sets for each level variant set element
Public variable TMap< TSharedRef< IDatasmithBaseMaterialElement >, UMaterialFunction * > ImportedMaterialFunctions Map of imported material function for each material element, they are only imported as a per-required basis
Public variable TMap< FString, TSharedRef< IDatasmithBaseMaterialElement > > ImportedMaterialFunctionsByName Register IDatasmithMeshElement by their name so they can be searched faster
Public variable TMap< TSharedRef< IDatasmithBaseMaterialElement >, TObjectPtr< UMaterialInterface > > ImportedMaterials Map of imported material for each material element
Public variable TMap< uint32, TObjectPtr< UMaterialInterface > > ImportedParentMaterials List of potential parent materials with their hash. Used to create material instances from.
Public variable TMap< TSharedRef< IDatasmithMeshElement >, TObjectPtr< UStaticMesh > > ImportedStaticMeshes Map of imported mesh for each mesh element
Public variable TMap< FString, TSharedRef< IDatasmithMeshElement > > ImportedStaticMeshesByName Register IDatasmithMeshElement by their name so they can be searched faster
Public variable TMap< TSharedRef< IDatasmithTextureElement >, UE::Interchange::FAssetImportResultRef > ImportedTextures Map of imported texture for each texture element
Public variable EObjectFlags ObjectFlags Object flags to apply to newly imported objects
Public variable TObjectPtr< UDatasmithImportOptions > Options Settings related to the import of a Datasmith scene
Public variable TSet< FString > ParsedIesFiles List of previously parsed IES files
Public variable TSharedPtr< IDatasmithScene > Scene IDatasmithScene object requested to be imported to UE editor
Public variable TObjectPtr< UDatasmithScene > SceneAsset Scene asset
Public variable FString SceneName Name of the scene being created
Public variable TSharedPtr< IDatasmithTranslator > SceneTranslator Name of the scene being created

Constructors

  Type Name Description
Public function  

FDatasmithImportContext ( const TSharedPtr< UE::DatasmithImporter::FExternalSource >& InExternalSource,
bool bLoadConfig,
const FName& LoggerName,
const FText& LoggerLabel
)

  
Public function  

FDatasmithImportContext ( const FString& InFileName,
bool bLoadConfig,
const FName& LoggerName,
const FText& LoggerLabel,
TSharedPtr< IDatasmithTranslator > InSceneTranslator
)

 Please use constructor using ExternalSource

Functions

  Type Name Description
Public function void

AddImportedActor ( AActor* InActor
)

 Add newly created Actor to context's map
Public function void

AddSceneComponent ( const FString& InName,
USceneComponent* InMeshComponent
)

 Add newly created SceneComponent to context's map
Public function void Displays all the messages that were added through AddMessage in the MessageLogModule
Public function Const TArray< AActor * >  
Public function bool

Init ( const FString& InImportPath,
EObjectFlags InFlags,
FFeedbackContext* InWarn,
const TSharedPtr< FJsonObject >& ImportSettingsJson,
bool bSilent
)

 Initialize members required before loading anything, must call InitScene() independendly when using this function.
Public function bool

InitOptions ( const TSharedPtr< FJsonObject >& ImportSettingsJson,
const TOptional< FString >& InImportPath,
bool bSilent
)

 First part of the Init process, requires a call to SetupDestination and InitScene after that.
Public function void

InitScene ( const TSharedRef< IDatasmithScene >& InScene
)

 Set the scene and initialize related members. Should be called before starting the import process.
Public function TSharedRef< FTokenizedMessage >

LogError ( const FText& InErrorMessage
)

 Push messages for display to the end-user
Public function TSharedRef< FTokenizedMessage >

LogInfo ( const FText& InInfoMessage
)

  
Public function TSharedRef< FTokenizedMessage >

LogWarning ( const FText& InWarningMessage,
bool bPerformance
)

  
Public function bool

SetupDestination ( const FString& InImportPath,
EObjectFlags InFlags,
FFeedbackContext* InWarn,
bool bSilent
)

 Second part of the Init process, replaces Init, requires a call to InitOptions before that.
Public function Const bool  
Public function void Replace or add options based on it's UClass.

Deprecated Functions

  Type Name Description
Public function  

FDatasmithImportContext ( const FString& InFileName,
bool bLoadConfig,
const FName& LoggerName,
const FText& LoggerLabel,
TSharedPtr< IDatasmithTranslator > InSceneTranslator
)

 Please use constructor using ExternalSource
Public function bool

Init ( TSharedRef< IDatasmithScene > InScene,
const FString& InImportPath,
EObjectFlags InFlags,
FFeedbackContext* InWarn,
const TSharedPtr< FJsonObject >& ImportSettingsJson,
bool bSilent
)

 The options initialization should not require a scene. Please use other implemetantion of Init() and call InitScene() individually.
Public function bool

InitOptions ( TSharedRef< IDatasmithScene > InScene,
const TSharedPtr< FJsonObject >& ImportSettingsJson,
bool bSilent
)

 Please use other InitOptions() implementations, having a valid scene should not be a requirement for initializing the options.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page