1. Epic GamesDeveloper
  3. UInterchangePipelineBase

UInterchangePipelineBase

API > API/Runtime > API/Runtime/InterchangeCore

Inheritance Hierarchy

References

   
Module InterchangeCore
Header /Engine/Source/Runtime/Interchange/Core/Public/InterchangePipelineBase.h
Include #include "InterchangePipelineBase.h"

Syntax

class UInterchangePipelineBase : public UObject

Variables

  Type Name Description
Protected variable bool bAllowPropertyStatesEdition If true, the property editor for this pipeline instance will allow properties states edition.
Protected variable bool bIsReimportContext If true, this pipeline instance is use for reimport.
Protected variable EInterchangePipelineContext CachePipelineContext  
Protected variable TMap< FName, FInterchangePipelinePropertyStates > CachePropertiesStates  
Protected variable TWeakObjectPtr< UObject > CacheReimportObject  
Protected variable TMap< FName, FInterchangePipelinePropertyStates > PropertiesStates Map of property path and lock status.
Protected variable TObjectPtr< UInterchangeResultsContainer > Results  

Functions

  Type Name Description
Public function Const void  
Public function Const T * This function is used to add the given message object directly into the results for this operation.
Public function Virtual void

AdjustSettingsForContext ( EInterchangePipelineContext ReimportType,
TObjectPtr< UObject > ReimportAsset
)

 This function is call when before we show the pipeline dialog.
Public function Virtual void  
Public function bool  
Protected function Virtual bool

CanExecuteOnAnyThread ( EInterchangePipelineTask PipelineTask
)

 This function tell the interchange manager if we can execute this pipeline in async mode.
Public function Const bool

DoesPropertyStatesExist ( const FName PropertyPath
)

 Return true if the property has valid states, false if no states was set for the property
Protected function Virtual void This function can modify the BaseNodeContainer to create a pipeline that will set/validate the graph nodes hierarchy and options.
Protected function Virtual void

ExecutePipeline ( UInterchangeBaseNodeContainer* BaseNodeContainer,
const TArray< UInterchangeSourceData* >& SourceDatas
)

 This function is called after the translation is done.
Protected function Virtual void

ExecutePostFactoryPipeline ( const UInterchangeBaseNodeContainer* BaseNodeContainer,
const FString& NodeKey,
UObject* CreatedAsset,
bool bIsAReimport
)

 This function is called after the factory create an asset, but before PostEditChange is called.
Protected function Virtual void

ExecutePostImportPipeline ( const UInterchangeBaseNodeContainer* BaseNodeContainer,
const FString& NodeKey,
UObject* CreatedAsset,
bool bIsAReimport
)

 This function is called after the unreal asset is completely import and PostEditChange was called.
Public function FInterchangePipelinePropertyStates &

FindOrAddPropertyStates ( const FName PropertyPath
)

 Return a mutable property states Reference. Add the property states if it doesnt exist.
Protected function Const UInterchangePipelineBase *  
Public function FInterchangePipelinePropertyStates *

GetMutablePropertyStates ( const FName PropertyPath
)

 Return a mutable property states pointer. Return nullptr if the property do not exist
Public function Static FName Return the property name of the properties states map
Public function Virtual bool

GetPropertyPossibleValues ( const FName PropertyPath,
TArray< FString >& PossibleValues
)

 FName or FString properties can have a dynamic set of possible values.
Public function Const const FInterchangePipelinePropertyStates *

GetPropertyStates ( const FName PropertyPath
)

 Return a const property states pointer. Return nullptr if the property do not exist
Public function Static FName  
Protected function Static void

HidePropertiesOfCategory ( UInterchangePipelineBase* OuterMostPipeline,
UInterchangePipelineBase* Pipeline,
const FString& HideCategoryName,
bool bDoTransientSubPipeline
)

  
Protected function Static void

HidePropertiesOfSubCategory ( UInterchangePipelineBase* OuterMostPipeline,
UInterchangePipelineBase* Pipeline,
const FString& HideSubCategoryName,
bool bDoTransientSubPipeline
)

  
Protected function Static void

InternalToggleVisibilityPropertiesOfMetaDataValue ( UInterchangePipelineBase* OuterMostPipeline,
UInterchangePipelineBase* Pipeline,
bool bDoTransientSubPipeline,
const FString& MetaDataKey,
const FString& MetaDataValue,
const bool bVisibilityState
)

  
Public function bool  
Public function Virtual bool Non scripted class should return false here, we have the default to true because scripted class cannot override this function since it can be call in a asynchronous thread, which python cannot be executed.
Public function Virtual Const bool

IsSettingsAreValid ( TOptional< FText >& OutInvalidReason
)

 This function should return true if all the pipeline settings are in a valid state to start the import.
Public function bool Return true if the pipeline is not a sub pipeline.
Public function void

LoadSettings ( const FName PipelineStackName
)

  
Protected function void

LoadSettingsInternal ( const FName PipelineStackName,
const FString& ConfigFilename,
TMap< FName, FInterchangePipelinePropertyStates >& ParentPropertiesStates
)

  
Public function Virtual void

PreDialogCleanup ( const FName PipelineStackName
)

 This function is called before showing the import dialog it is not called doing a re-import.
Public function void

SaveSettings ( const FName PipelineStackName
)

  
Protected function void

SaveSettingsInternal ( const FName PipelineStackName,
const FString& ConfigFilename
)

  
Public function bool

ScriptedCanExecuteOnAnyThread ( EInterchangePipelineTask PipelineTask
)

 Non virtual helper to allow blueprint to implement event base function let the interchange know if it can run asynchronously.
Public function bool

ScriptedCanExecuteOnAnyThread_Implementation ( EInterchangePipelineTask PipelineTask
)

 The default implementation (call if the blueprint do not have any implementation) will call the virtual CanExecuteAsync
Public function void Non virtual helper to allow blueprint to implement event base function let the interchange know if it can run asynchronously.
Public function void The default implementation (call if the blueprint do not have any implementation) will call the virtual ExecuteExportPipeline
Public function void ScriptedExecutePipeline, is call after the translation and before we parse the graph to call the factory.
Public function void The default implementation (call if the blueprint do not have any implementation) will call the virtual ExecutePipeline
Public function void

ScriptedExecutePostFactoryPipeline ( const UInterchangeBaseNodeContainer* BaseNodeContainer,
const FString& FactoryNodeKey,
UObject* CreatedAsset,
bool bIsAReimport
)

 ScriptedExecutePostFactoryPipeline is call after the factory create the unreal asset but before calling PostEditChange.
Public function void

ScriptedExecutePostFactoryPipeline_Implementation ( const UInterchangeBaseNodeContainer* BaseNodeContainer,
const FString& FactoryNodeKey,
UObject* CreatedAsset,
bool bIsAReimport
)

 The default implementation (call if the blueprint do not have any implementation) will call the virtual ExecutePostFactoryPipeline
Public function void

ScriptedExecutePostImportPipeline ( const UInterchangeBaseNodeContainer* BaseNodeContainer,
const FString& FactoryNodeKey,
UObject* CreatedAsset,
bool bIsAReimport
)

  
Public function void

ScriptedExecutePostImportPipeline_Implementation ( const UInterchangeBaseNodeContainer* BaseNodeContainer,
const FString& FactoryNodeKey,
UObject* CreatedAsset,
bool bIsAReimport
)

 The default implementation (call if the blueprint do not have any implementation) will call the virtual ExecutePostImportPipeline
Public function void

ScriptedSetReimportSourceIndex ( UClass* ReimportObjectClass,
const int32 SourceFileIndex
)

 Non virtual helper to allow blueprint to implement event base function.
Public function void

ScriptedSetReimportSourceIndex_Implementation ( UClass* ReimportObjectClass,
const int32 SourceFileIndex
)

 The default implementation (call if the blueprint do not have any implementation) will call the virtual SetReimportContentFromSourceIndex
Protected function Virtual void

SetReimportSourceIndex ( UClass* ReimportObjectClass,
const int32 SourceFileIndex
)

  
Public function void  
Public function Virtual Const bool End UObject overrides If it return true it mean we want to save this pipeline in the asset import data.
Public function void Transfer the source pipeline adjust settings to this pipeline.
Public function void Update/Re-set the TWeakObjectPtrs to point to their original TObjectPtr Works based on Variable naming.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Begin UObject overrides

Deprecated Functions

  Type Name Description
Protected function Virtual void This function is replace by ExecutePipeline.
Public function void This function is replace by ScriptedExecutePipeline.
Public function void This internal public function is deprecated and not replace by any.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page