Navigation
API > API/Runtime > API/Runtime/InterchangeCore
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UInterchangeFactoryBase
- UInterchangeActorFactory
- UInterchangeCameraActorFactory
- UInterchangeCineCameraActorFactory
- UInterchangeDatasmithAreaLightFactory
- UInterchangeLightActorFactory
- UInterchangeSkeletalMeshActorFactory
- UInterchangeStaticMeshActorFactory
- UInterchangeAnimationTrackSetFactory
- UInterchangeAnimSequenceFactory
- UInterchangeDatasmithSceneFactory
- UInterchangeMaterialFactory
- UInterchangeMaterialFunctionFactory
- UInterchangePhysicsAssetFactory
- UInterchangeSceneImportAssetFactory
- UInterchangeSceneVariantSetsFactory
- UInterchangeSkeletalMeshFactory
- UInterchangeSkeletonFactory
- UInterchangeStaticMeshFactory
- UInterchangeTextureFactory
References
| Module | InterchangeCore |
| Header | /Engine/Source/Runtime/Interchange/Core/Public/InterchangeFactoryBase.h |
| Include | #include "InterchangeFactoryBase.h" |
Syntax
class UInterchangeFactoryBase : public UObject
Remarks
Asset factory implementation:
The first 3 steps use the interchange factory node to import/re-import the UObject
BeginImportAsset_GameThread - Create the asset UObject. You can also import source data (retrieve payloads) and setup properties on the game thread.
ImportAsset_Async - Import source data (retrieve payloads) and setup properties asynchronously on any thread.
EndImportAsset_GameThread - Anything you need to do on the game thread to finalize the import source data and setup properties. (Conflict resolution that need UI)
The last two steps are helpful to change the imported/re-imported UObject before and after the PostEditChange (render data build) is call on the asset.
SetupObject_GameThread - Do any UObject setup required before the build (before PostEditChange), the UObject dependencies should exist and have all the source data and properties imported.
FinalizeObject_GameThread - Do any final UObject setup after the build (after PostEditChange). Note that the build of an asset can be asynchronous and not finish yet.
Scene factory implementation
ImportSceneObject_GameThread - Create an actor in a level.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TObjectPtr< UInterchangeResultsContainer > | Results |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddMessage
(
UInterchangeResult* Item |
|
 |
T * | AddMessage () |
This function is used to add the given message object directly into the results for this operation. |
  |
FImportAssetResult | BeginImportAsset_GameThread
(
const FImportAssetObjectParams& Arguments |
Override it to import/re-import source data and configure the properties synchronously. |
  |
void | Cancel () |
Call when the user cancel the operation. |
  |
FImportAssetResult | EndImportAsset_GameThread
(
const FImportAssetObjectParams& Arguments |
Override it to end import/re-import on the game thread. |
  |
void | FinalizeObject_GameThread
(
const FSetupObjectParams& Arguments |
Do any final UObject setup after the build (after PostEditChange) |
  |
EInterchangeFactoryAssetType | Return the asset type this factory can create. | |
   |
UClass * | Return the UClass this factory can create. | |
   |
bool | GetSourceFilenames
(
const UObject* Object, |
Fills the OutSourceFilenames array with the list of source files contained in the asset source data. |
  |
FImportAssetResult | ImportAsset_Async
(
const FImportAssetObjectParams& Arguments |
Override it to import/re-import the UObject source data and configure the properties asynchronously. |
  |
UObject * | ImportSceneObject_GameThread
(
const FImportSceneObjectsParams& Arguments |
Creates the scene object from a Scene Node data. |
   |
bool | SetReimportSourceIndex
(
const UObject* Object, |
Set the object's reimport source at the specified index value. |
 |
void | SetResultsContainer
(
UInterchangeResultsContainer* InResults |
|
   |
bool | SetSourceFilename
(
const UObject* Object, |
Sets the object's source at the specified index to the given SourceFileName |
  |
void | SetupObject_GameThread
(
const FSetupObjectParams& Arguments |
Do any UObject setup required before the build (before PostEditChange) and after all dependency UObject have been imported. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FImportAssetObjectParams | Parameters to pass to CreateAsset function | |
 |
FImportAssetResult | ||
 |
FImportSceneObjectsParams | Parameters to pass to SpawnActor function | |
 |
FSetupObjectParams | Parameters to pass to CreateAsset function |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
UObject * | ImportAssetObject_Async
(
const FImportAssetObjectParams& Arguments |
This function is replaced by ImportAsset_Async. |
  |
UObject * | ImportAssetObject_GameThread
(
const FImportAssetObjectParams& Arguments |
This function is replaced by BeginImportAsset_GameThread. |