1. Epic GamesDeveloper
  3. UInterchangeManager

UInterchangeManager

API > API/Runtime > API/Runtime/InterchangeEngine

Inheritance Hierarchy

References

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

Syntax

class UInterchangeManager : public UObject

Variables

  Type Name Description
Public variable FInterchangeOnAssetPostImport OnAssetPostImport  
Public variable FInterchangeOnAssetPostReimport OnAssetPostReimport  
Public variable FInterchangeOnBatchImportComplete OnBatchImportComplete  
Public variable FSimpleMulticastDelegate OnPreDestroyInterchangeManager Called when before the application is exiting.

Functions

  Type Name Description
Protected function void This function cancel all task and finish them has fast as possible.
Public function Const bool

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

 Returns true if Interchange can create that type of assets and is able to translate its source file.
Public function Const bool Look if there is a registered translator for this source data.
Public function Const bool

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

 Look if there is a translator registered that can translate the source data with the specified PayloadInterface SourceData - The source data input we want to translate to Uod
Public function TSharedRef< UE::Interchange::FImportAsyncHelper, ESPMode::ThreadSafe > Return an FImportAsynHelper pointer. The pointer is deleted when ReleaseAsyncHelper is call.
Public function Static UInterchangeSourceData *

CreateSourceData ( const FString& InFileName
)

 Script helper to create a source data object pointing on a file on disk InFilename: Specify a file on disk
Public function bool

ExportAsset ( const UObject* Asset,
bool bIsAutomated
)

 Call this to start an export asset process, the caller must specify a source data.
Public function bool

ExportScene ( const UObject* World,
bool bIsAutomated
)

 Call this to start an export scene process, the caller must specify a source data This import process can import many different asset and there transform (USceneComponent) and store the result in a blueprint and add the blueprint to the level.
Protected function void

FindPipelineCandidate ( TArray< UClass* >& PipelineCandidates
)

 Find all Pipeline candidate (c++, blueprint and python).
Public function Static UInterchangeManager & Return the interchange manager singleton.
Public function Static UInterchangeManager * Return the interchange manager singleton pointer.
Public function Const const UClass *

GetRegisteredFactoryClass ( const UClass* ClassToMake
)

 Script helper to get a registered factory for a specified class FactoryClass: The class we search a registerd factory
Public function Const TArray< FString >

GetSupportedAssetTypeFormats ( const EInterchangeTranslatorAssetType ForTranslatorAssetType
)

 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 > Returns the list of supported formats for a given Object.
Public function Const UInterchangeTranslatorBase * 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 an import asset process, the caller must specify a source data.
Public function UE::Interchange::FAssetImportResultRef

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

 Call this to start an import asset process, the caller must specify a source data.
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 bool

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

 Call this to start an import scene process, the caller must specify a source data.
Public function TTuple< UE::Interchange::FAssetImportResultRef, UE::Interchange::FSceneImportResultRef >

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

  
Protected function Static bool Return true if we can show some UI
Public function bool Return true if the Interchange is active (importing or exporting), return false otherwise.
Public function Static bool Return the CVar which make interchange enable or not.
Public function Const bool Return true if the object is being imported, return false otherwise.
Public function bool

RegisterFactory ( const UClass* Factory
)

 Any factory must register to the manager Factory - The UClass of the factory you want to register
Public function bool

RegisterTranslator ( const UClass* TranslatorClass
)

 Any translator must register to the manager Translator - The UClass of the translator you want to register
Public function bool

RegisterWriter ( const UClass* Writer
)

 Any writer must register to the manager 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.
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 Static void

SetInterchangeImportEnabled ( bool bEnabled
)

 Set the CVar which make interchange enable or not.
Protected function void

StartQueuedTasks ( bool bCancelAllTasks
)

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

WaitUntilAllTasksDone ( bool bCancel
)

 Wait synchronously that all tasks are done
Public function bool Return false if the Interchange is not active (importing or exporting).

Typedefs

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page