1. Epic GamesDeveloper
  3. UInterchangeManager

UInterchangeManager

API > API/Runtime > API/Runtime/InterchangeEngine

Inheritance Hierarchy

  • UObject
  • UInterchangeManager

References

   
Module InterchangeEngine
Header /Engine/Source/Runtime/Interchange/Engine/Public/InterchangeManager.h
Include #include "InterchangeManager.h"

Syntax

UCLASS (Transient, BlueprintType, CustomConstructor, MinimalAPI)  
class UInterchangeManager : public UObject

Variables

  Type Name Description
Public variable FInterchangeOnAssetPostImport OnAssetPostImport  
Public variable FInterchangeOnAssetPostReimport OnAssetPostReimport  
Public variable FInterchangeOnBatchImportComplete OnBatchImportComplete  
Public variable FOnImportFinished OnImportFinished Fires when the last import process finishes.
Public variable FOnImportStarted OnImportStarted Fires when the first import process starts.
Public variable FSimpleMulticastDelegate OnPreDestroyInterchangeManager Called when before the application is exiting.
Public variable FOnSanitizeName OnSanitizeName Fire when we need to sanitize a name, make sure your delegate code is thread safe, since it will be broadcast in any thread.

Constructors

  Type Name Description
Public function  

UInterchangeManager ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function void This function cancels all tasks and finishes them as fast as possible.
Public function Const bool

CanReimport ( const UObject* Object,
TArray< FString >& OutFilenames
)

 Returns true if Interchange can create this type of asset and is able to translate its source files.
Public function Const bool

CanTranslateSourceData ( const UInterchangeSourceData* SourceData,
bool bSceneImportOnly
)

 Check whether there is a registered translator for this source data.
Public function Const bool

CanTranslateSourceDataWithPayloadInterface ( const UInterchangeSourceData* SourceData,
const UClass* PayloadInterfaceClass
)

 Check whether there is a translator registered that can translate the source data with the specified PayloadInterface.
Public function Const bool

ConvertImportData ( UObject* Asset,
const FString& Extension
)

 Call all the registered converters to see if any converter can convert the data.
Public function Const bool

ConvertImportData ( const UObject* SourceImportData,
FImportAssetParameters& ImportAssetParameters
)

 Call all the registered converter, until one can convert the source import data to UInterchangeAssetImportData @Param SourceImportData - The source import data options.
Public function Const bool

ConvertImportData ( const UObject* SourceImportData,
const UClass* DestinationClass,
UObject** DestinationImportData
)

 Call all the registered converter, until one can convert the source data to the destination @Param SourceImportData - The source import data options.
Public function TSharedRef< UE::Interchange::FImportAsyncHelper, ESPMode::ThreadSafe > Return a pointer to an FImportAsyncHelper.
Public function Static UFunction BlueprintCallable, Category UInterchangeSourceData *

CreateSourceData ( const FString& InFileName
)

 Script helper to create a source data object that points to a file on disk.
Public function bool

EnqueuePostImportTask ( TSharedPtr< FInterchangePostImportTask > PostImportTask
)

 Queue task that are not directly a import or re-import of assets.
Public function UFunction BlueprintCallable, Category bool

ExportAsset ( const UObject* Asset,
bool bIsAutomated
)

 Call this to start an asset export process.
Public function UFunction BlueprintCallable, Category bool

ExportScene ( const UObject* World,
bool bIsAutomated
)

 Call this to start a scene export process.
Protected function void

FindPipelineCandidate ( TArray< UClass* >& PipelineCandidates
)

 Find all pipeline candidates (C++, Blueprint, and Python).
Public function Const UInterchangeEditorUtilitiesBase * Get the editor utilities, those are use for editor operation like saving an asset.
Public function Static UInterchangeManager & Return the Interchange Manager singleton.
Public function Static UFunction BlueprintCallable, Category UInterchangeManager * Return the pointer to the Interchange Manager singleton.
Public function Const UFunction BlueprintCallable, Category const UClass *

GetRegisteredFactoryClass ( const UClass* ClassToMake
)

 Script helper to get a registered factory for a specified class.
Public function Static TOptional< bool > Gets the bReplaceExistingAllDialogAnswer.
Public function Const TArray< FString >

GetSupportedAssetTypeFormats ( const EInterchangeTranslatorAssetType ForTranslatorAssetType,
const EInterchangeTranslatorType ForTranslatorType,
bool bStrictMatchTranslatorType
)

 Returns the list of formats supporting the specified translator asset type.
Public function Const TArray< FString >

GetSupportedFormats ( const EInterchangeTranslatorType ForTranslatorType
)

 Returns the list of supported formats for a given translator type.
Public function Const TArray< FString >

GetSupportedFormatsForObject ( const UObject* Object,
int32 SourceFileIndex
)

 Returns the list of supported formats for a given Object.
Public function Const UInterchangeTranslatorBase *

GetTranslatorForSourceData ( const UInterchangeSourceData* SourceData
)

 Return the first translator that can translate the source data.
Public function Const UInterchangeTranslatorBase *

GetTranslatorSupportingPayloadInterfaceForSourceData ( const UInterchangeSourceData* SourceData,
const UClass* PayloadInterfaceClass
)

 Return the first translator that can translate the source data with the specified PayloadInterface.
Public function bool

ImportAsset ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters
)

 Call this to start a synchronous asset import process.
Public function UFunction BlueprintCallable, Category bool

ImportAsset ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters,
TArray< UObject* >& OutImportedObjects
)

 Call this to start a synchronous asset import process.
Public function UE::Interchange::FAssetImportResultRef

ImportAssetAsync ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters
)

 Call this to start an asynchronous asset import process.
Public function UE::Interchange::FAssetImportResultRef

ImportAssetWithResult ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters
)

 Call this to start a synchronous asset import process.
Protected function TTuple< UE::Interchange::FAssetImportResultRef, UE::Interchange::FSceneImportResultRef >

ImportInternal ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters,
const UE::Interchange::EImportType ImportType
)

 Called by the public Import functions.
Public function UFunction BlueprintCallable, Category bool

ImportScene ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters
)

 Call this to start a synchronous scene import process.
Public function TTuple< UE::Interchange::FAssetImportResultRef, UE::Interchange::FSceneImportResultRef >

ImportSceneAsync ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters
)

 Call this to start a asynchronous scene import process.
Protected function Static bool Return true if Interchange can show UI.
Public function Static bool Checks if there are any imports in progress.
Public function bool Return true if Interchange is actively importing or exporting, or false otherwise.
Public function Static bool Return the CVar that enables or disables Interchange.
Public function Const bool

IsObjectBeingImported ( UObject* Object
)

 Return true if the object is being imported, or false otherwise.
Public function bool

RegisterFactory ( const UClass* Factory
)

 All factories must be registered with the manager.
Public function bool

RegisterImportDataConverter ( const UClass* Converter
)

 All converters must be registered with the manager.
Public function bool

RegisterTranslator ( const UClass* TranslatorClass
)

 All translators must be registered with the manager.
Public function bool

RegisterWriter ( const UClass* Writer
)

 All writers must be registered with the manager, @Param Writer - The UClass of the writer you want to register,
Public function void

ReleaseAsyncHelper ( TWeakPtr< UE::Interchange::FImportAsyncHelper, ESPMode::ThreadSafe > AsyncHelper
)

 Delete the specified AsyncHelper and remove it from the array that was holding it.
Public function Static void Checks if the bReplaceExistingAllDialogAnswer.
Public function void

SanitizeNameInline ( FString& NameToSanitize,
const ESanitizeNameTypeFlags NameType
)

  
Public function UFunction BlueprintCallable, Category bool

ScriptedImportAssetAsync ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters
)

 Call this from blueprint or python to start an asynchronous asset import process.
Public function UFunction BlueprintCallable, Category bool

ScriptedImportSceneAsync ( const FString& ContentPath,
const UInterchangeSourceData* SourceData,
const FImportAssetParameters& ImportAssetParameters
)

 Call this to start a asynchronous scene import process.
Protected function void

SetActiveMode ( bool IsActive
)

 If we set the mode to active, we will setup the timer and add the thread that will block the GC.
Public function void

SetEditorUtilities ( UClass* EditorUtilitiesClass
)

 Set the editor utilities, those are use for editor operation like saving an asset.
Public function Static void

SetInterchangeImportEnabled ( bool bEnabled
)

 Set the CVar that enables or disables Interchange.
Public function Static void

SetReplaceExistingAlldialogAnswer ( bool bReplaceExistingAllDialogAnswer
)

 Sets the bReplaceExistingAllDialogAnswer which is responsible for: if the Import process will override or not all existing assets this Import stack tries to override.
Protected function void

StartQueuedTasks ( bool bCancelAllTasks
)

 Start tasks until we reach the taskgraph worker number.
Protected function void

WaitUntilAllTasksDone ( bool bCancel
)

 Wait synchronously until all tasks are done.
Public function bool Return false if Interchange is not actively importing or exporting.

Typedefs

Name Description
FInterchangeOnAssetPostImport Delegate type that is fired when new assets have been imported.
FInterchangeOnAssetPostReimport Delegate type that is fired when new assets have been reimported.
FInterchangeOnBatchImportComplete Delegate type that is fired when the import results in an error.

Constants

Name Description
bIsCreatingSingleton  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page