UInterchangeManager

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInterchangeManager

References

Module

InterchangeEngine

Header

/Engine/Source/Runtime/Experimental/Interchange/Engine/Public/InterchangeManager.h

Include

#include "InterchangeManager.h"

Syntax

class UInterchangeManager : public UObject

Variables

Name Description

Public variable

FInterchangeOnA...

 

OnAssetPostImport

Public variable

FInterchangeOnA...

 

OnAssetPostReimport

Public variable

FInterchangeOnB...

 

OnBatchImportComplete

Public variable

FSimpleMulticas...

 

OnPreDestroyInterchangeManager

Called when before the application is exiting.

Functions

Name Description

Protected function

void

 

CancelAllTasks()

This function cancel all task and finish them has fast as possible.

Protected function

void

 

CancelAllTasksSynchronously()

Same has CancelAllTasks, but will wait all task are done before exiting the function

Public function Const

bool

 

CanTranslateSourceData

(
    const UInterchangeSourceData* ...
)

Look if there is a registered translator for this source data.

Public function Const

bool

 

CanTranslateSourceDataWithPayloadInterface

(
    const UInterchangeSourceData* ...,
    const UClass* PayloadInterface...
)

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

 

CreateAsyncHelper

(
    const UE::Interchange::FImportAsync...,
    const FImportAssetParameters& Impo...
)

Return an FImportAsynHelper pointer. The pointer is deleted when ReleaseAsyncHelper is call.

Public function Static

UInterchange...

 

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* >& PipelineCa...
)

Find all Pipeline candidate (c++, blueprint and python).

Public function Static

UInterchange...

 

GetInterchangeManager()

Return the interchange manager singleton.

Public function Static

UInterchange...

 

GetInterchangeManagerScripted()

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

UInterchange...

 

GetTranslatorForSourceData

(
    const UInterchangeSourceData* ...
)

Return the first translator that can translate the source data.

Public function Const

UInterchange...

 

GetTranslatorSupportingPayloadInterfaceForSourceData

(
    const UInterchangeSourceData* ...,
    const UClass* PayloadInterface...
)

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

Public function

bool

 

ImportAsset

(
    const FString& ContentPath,
    const UInterchangeSourceData* ...,
    const FImportAssetParameters& Impo...
)

Call this to start an import asset process, the caller must specify a source data.

Public function

UE::Intercha...

 

ImportAssetAsync

(
    const FString& ContentPath,
    const UInterchangeSourceData* ...,
    const FImportAssetParameters& Impo...
)

Call this to start an import asset process, the caller must specify a source data.

Protected function

TTuple< UE::...

 

ImportInternal

(
    const FString& ContentPath,
    const UInterchangeSourceData* ...,
    const FImportAssetParameters& Impo...,
    const UE::Interchange::EImportType ...
)

Called by the public Import functions

Public function

bool

 

ImportScene

(
    const FString& ContentPath,
    const UInterchangeSourceData* ...,
    const FImportAssetParameters& Impo...
)

Call this to start an import scene process, the caller must specify a source data.

Public function

TTuple< UE::...

 

ImportSceneAsync

(
    const FString& ContentPath,
    const UInterchangeSourceData* ...,
    const FImportAssetParameters& Impo...
)

Protected function Static

bool

 

IsAttended()

Return true if we can show some UI

Public function Const

bool

 

IsTranslatorClassForTextureOnly

(
    const UClass* TranslatorClass
)

Check if the translator class is registered as a texture only translator

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

void

 

RegisterTextureOnlyTranslatorClass

(
    const UClass* TranslatorClass
)

Register a translator as a texture translator only This used to implement the experimental setting to use interchange for textures only.

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

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.

Protected function

void

 

StartQueuedTasks

(
    bool bCancelAllTasks
)

Start task until we reach the taskgraph worker number.

Public function

bool

 

WarnIfInterchangeIsActive()

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