1. Epic GamesDeveloper
  3. FDatasmithImportContext

FDatasmithImportContext

API > API/Plugins > API/Plugins/DatasmithImporter

   
Name FDatasmithImportContext
Type struct
Header File /Engine/Plugins/Enterprise/DatasmithImporter/Source/DatasmithImporter/Public/DatasmithImportContext.h
Include Path #include "DatasmithImportContext.h"

Syntax

struct FDatasmithImportContext

Constructors

Name Remarks Include Path Unreal Specifiers

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

   DatasmithImportContext.h  

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

   DatasmithImportContext.h  

Structs

Name Remarks
FInternalReferenceCollector GC UObject own by DatasmithImportContext

Variables

Public

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

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentSceneActorIndex int32   DatasmithImportContext.h  
FInternalReferenceCollector friend   DatasmithImportContext.h  
ImportedActorMap TMap< FString, TObjectPtr< AActor > > Map of StaticMeshActor objects added to the World at import DatasmithImportContext.h  
ImportedSceneComponentMap TMap< FString, TObjectPtr< USceneComponent > > Map of SceneComponent objects added to the World at import DatasmithImportContext.h  
Logger FScopedLogger Handles messages logged during the import process DatasmithImportContext.h  
ReferenceCollector FInternalReferenceCollector   DatasmithImportContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddImportedActor ( AActor* InActor
)

 Add newly created Actor to context's map DatasmithImportContext.h  

void AddSceneComponent ( const FString& InName,
USceneComponent* InMeshComponent
)

 Add newly created SceneComponent to context's map DatasmithImportContext.h  

void DisplayMessages()

 Displays all the messages that were added through AddMessage in the MessageLogModule DatasmithImportContext.h  

TArray< AActor * > GetImportedActors()

   DatasmithImportContext.h  

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

 Initialize members required before loading anything DatasmithImportContext.h  

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. DatasmithImportContext.h  

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

 First part of the Init process, replaces Init, requires a call to SetupDestination and InitScene after that. DatasmithImportContext.h  

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. DatasmithImportContext.h  

void InitScene ( const TSharedRef< IDatasmithScene >& InScene
)

 Set the scene and initialize related members. Should be called before starting the import process. DatasmithImportContext.h  

TSharedRef< FTokenizedMessage > LogError ( const FText& InErrorMessage
)

 Push messages for display to the end-user DatasmithImportContext.h  

TSharedRef< FTokenizedMessage > LogInfo ( const FText& InInfoMessage
)

   DatasmithImportContext.h  

TSharedRef< FTokenizedMessage > LogWarning ( const FText& InWarningMessage,
bool bPerformance
)

   DatasmithImportContext.h  

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. DatasmithImportContext.h  

bool ShouldImportActors()

   DatasmithImportContext.h  

void UpdateImportOption ( UDatasmithOptionsBase* Option
)

 Replace or add options based on it's UClass. DatasmithImportContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page