1. Epic GamesDeveloper
  3. DataprepCore

DataprepCore

Unreal Engine C++ API Reference > Plugins

Filters

Classes

  Type Name Description
Public struct FDataprepActionContext Structure to pass execution context to action  
Public struct UStruct FDataprepAssetProducer Structure to hold on a producer and its configuration  
Public struct FDataprepConsumerContext    
Public struct UStruct BlueprintType FDataprepContext Experimental struct. Todo add struct wide comment  
Public class FDataprepCoreUtils    
Public class FDataprepOperationCategories    
Public struct FDataprepOperationContext Contains all data regarding the context in which an operation will be executed  
Public struct FDataprepProducerContext Structure to pass execution context to producer  
Public class FDataprepWorkReporter Helper class to encapsulate the IDataprepProgressReporter interface  
Public class FOnStepAboutToBeRemoved    
Public class FOnStepsOrderChanged    
Public class FOnStepWasEdited    
Public class IDataprepLogger This is the interface that a logger must implement to work with the Dataprep core functionalities  
Public class IDataprepProgressReporter This is the interface that a progress reporter must implement to work with FDataprepWorkReporter  
Public class TDataprepBindingCommandChange    
Public class UClass UDataprepActionAppearance Persists graphical state of the node associated with this action asset.  
Public class UClass UDataprepActionStep    
Public class UClass BlueprintType UDataprepAsset A DataprepAsset is an implementation of the DataprepAssetInterface using a Blueprint as the recipe pipeline.  
Public class UClass MinimalAPI BlueprintType UDataprepAssetFactory LevelFactory.  
Public class UClass BlueprintType UDataprepAssetInstance A DataprepAssetInstance is an implementation of the DataprepAssetInterface sharing its recipe pipeline with an existing Dataprep asset or another DataprepAssetInstance.  
Public class UClass MinimalAPI BlueprintType UDataprepAssetInstanceFactory    
Public class UClass Abstract BlueprintType UDataprepAssetInterface    
Public class UClass UDataprepAssetProducers A UDataprepAssetProducers is a utility class to manage the set of producers constituting the inputs of a DataprepAssetInterface.  
Public class UClass BlueprintType Meta UDataprepAssetUserData A DataprepAssetUserData is used to mark assets or actors created through a Dataprep pipeline  
Public class UClass BlueprintType Meta UDataprepConsumerUserData A UDataprepConsumerUserData is used to mark an asset or an actor to be respectively moved to a sub-folder or sub-level A DataprepContentConsumer is not obligated to honor this marker  
Public class UClass Abstract BlueprintType Config UDataprepContentConsumer Abstract class providing the minimal services required for a DataprepConsumer  
Public class UClass Abstract BlueprintType UDataprepContentProducer Abstract class to derived from to be a producer in the Dataprep asset  
Public class UClass Abstract Blueprintable UDataprepEditingOperation Base class for all Dataprep editing operations Dataprep editing operations act on a set of input obejcts and can modify their properties, but also can create new objects or delete existing ones (like assets and actors), based on the information they receive as an input  
Public class UClass Abstract Blueprintable UDataprepOperation Base class for all Dataprep operations Dataprep operations act on a set of input obejcts and can modify their properties: f.e.  
Public class UClass UDataprepParameterizableObject The base class of all the object that can interact with the dataprep parameterization This include all the parameterizable object and the parameterization object itself Also all the object that can be place in a dataprep action derive from it  
Public class UClass Abstract BlueprintType UDataprepRecipeInterface A DataprepAssetInterface is composed of a set of producers, inputs, a consumer, output, and a recipe, set of actions.  
Public class UClass Blueprintable, BlueprintType Meta deprecated UDEPRECATED_DataprepRecipe    

Typedefs

Name Description
FActionsContextChangedFunc Callback used to report a global change to the content it is working on
FCanExecuteNextStepFunc Callback function used to confirm continuation after executing an operation or a filter
FDataprepAddAsset Delegate used by a Dataprep operation to add a copy of an asset to the Dataprep's working set
FDataprepAssetsModified Delegate used by a Dataprep operation to indicates an asset has been modified
FDataprepCreateActor Delegate used by a Dataprep operation to add an actor to the Dataprep's working set
FDataprepCreateAsset Delegate used by a Dataprep operation to create and add an asset to the Dataprep's working set
FDataprepDeleteObjects Delegate used by a Dataprep operation to remove and delete an array of objects from the Dataprep's working set.
FDataprepRemoveObject Delegate used by a Dataprep operation to remove an object If bLocalContext is true, the object is removed from the working set of the action owning the operation Otherwise, the object is removed from the Dataprep's working set

Enums

  Type Name Description
Public enum FDataprepAssetChangeType    

Functions

  Type Name Description
Public function Virtual    
Private function void

AddAssetToContext ( UObject* NewAsset,
const TCHAR* DesiredName
)

 Add an asset to the execution context
Public function int32

AddFilterWithAFetcher ( const TSubclassOf< UDataprepFilter >& FilterClass,
const TSubclassOf< UDataprepFetcher >& FetcherClass
)

 Add a filter and setup it's fetcher
Public function int32

AddOperation ( const TSubclassOf< UDataprepOperation >& OperationClass
)

 Add an operation to the action
Public function int32 Add a new step base on the type of step
Public function int32

AddStep ( const UDataprepActionStep* ActionStep
)

 Add a copy of the step to the action
Public function int32

AddStep ( const UDataprepParameterizableObject* StepObject
)

 Add a copy of the step object to the action
Public function int32

AddSteps ( const TArray< const UDataprepActionStep* >& ActionSteps
)

 Add a copy of each step to the action
Private function UDataprepActionStep *

DuplicateStep ( const UDataprepActionStep* InActionStep
)

 Creates a copy af action step, including its parameterization
Public function void

EnableStep ( int32 Index,
bool bEnable
)

 Allow to set the enabled state of a step
Public function UFunction BlueprintCallable, Category void

Execute ( const TArray< UObject* >& InObjects
)

 Execute the action on a specific set of objects
Public function void

ExecuteAction ( const TSharedPtr< FDataprepActionContext >& InActionsContext,
UDataprepActionStep* SpecificStep,
bool bSpecificStepOnly
)

 Execute the action
Public function UDataprepActionAppearance *  
Private function UObject *

GetAssetOuterByClass ( UClass* AssetClass
)

 Returns the outer to be used according to an asset's class
Public function Const const TCHAR * Getter and Setter on the UI text of the action
Public function FOnStepAboutToBeRemoved & Allow an observer to be notified when a step is about to be removed from the action
Public function FOnStepsOrderChanged & Allow an observer to be notified when the steps order changed that also include adding and removing steps
Public function FOnStepWasEdited & Allow an observer to be notified when a step was edited (the step itself or a sub object of it)
Public function TWeakObjectPtr< UDataprepActionStep >

GetStep ( int32 Index
)

 Access to a step of the action Access to a step of the action
Public function Const int32 Get the number of steps of this action
Public function bool

InsertStep ( const UDataprepActionStep* ActionStep,
int32 Index
)

 Insert a copy of the step into the action at the requested index
Public function bool

InsertSteps ( const TArray< const UDataprepActionStep* >& ActionSteps,
int32 Index
)

 Insert a copy of each step into the action at the requested index
Public function Const bool

IsStepEnabled ( int32 Index
)

 Get enabled status of an operation
Public function bool

MoveStep ( int32 StepIndex,
int32 DestinationIndex
)

 Move a step to another spot in the order of steps This operation take O(n) time.
Public function void Do the necessary notification so that the Dataprep system can react properly to removal of this action
Private function UObject *

OnAddAsset ( const UObject* Asset,
const TCHAR* AssetName
)

 Duplicate and add an asset to the Dataprep's and action's working set
Private function void Add an array of assets to the list of modified assets
Private function AActor *

OnCreateActor ( UClass* ActorClass,
const TCHAR* ActorName
)

 Add an actor to the Dataprep's transient world and action's working set
Private function UObject *

OnCreateAsset ( UClass* AssetClass,
const TCHAR* AssetName
)

 Create and add an asset to the Dataprep's and action's working set
Private function void

OnDeleteObjects ( TArray< UObject* > Objects
)

 Delete an array of objects from the Dataprep's and action's working set
Private function void

OnRemoveObject ( UObject* Object,
bool bLocalContext
)

 Remove an object from the Dataprep's and/or action's working set
Public function Virtual void

PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

  
Private function void Executes the deletion and removal requested by an operation after its execution Notifies any observer about what has changed
Public function bool

RemoveStep ( int32 Index,
bool bDiscardParametrization
)

 Remove a step from the action
Public function bool

RemoveSteps ( const TArray< int32 >& Indices,
bool bDiscardParametrization
)

 Remove an array of steps from the action
Public function void

SetLabel ( const TCHAR* InLabel
)

  
Public function bool

SwapSteps ( int32 FirstIndex,
int32 SecondIndex
)

 Swap the steps
Public function FOnStepWasEdited TBaseMulticastDelegate_TwoParams  

Variables

  Type Name Description
Private variable TArray< UObject * > AddedObjects Array of objects which have been added during the execution of an operation
Private variable UProperty TObjectPtr< UDataprepActionAppearance > Appearance  
Public variable UProperty Transient bool bExecutionInterrupted  
Public variable UProperty bool bIsEnabled  
Private variable bool bWorkingSetHasChanged Marker to check if an operation has made any changes to the action's working set
Private variable TSharedPtr< FDataprepActionContext > ContextPtr Pointer to the context passed to the action for its execution
Public variable FDataprepProducerContext & GetOnChanged  
Public variable UDataprepAssetUserData & GetOnChanged  
Public variable FDataprepAssetProducer & GetOnChanged  
Public variable FDataprepCoreUtils & GetOnChanged  
Public variable enum FDataprepAssetChangeType & GetOnParentChanged  
Private variable UProperty Category, EditAnywhere FString Label UI label of the action
Private variable TSet< TWeakObjectPtr< UObject > > ModifiedAssets Set of objects which have been modified during the execution of an operation
Private variable TArray< UObject * > ObjectsToDelete Array of objects requested to be deleted by an operation
Private variable TArray< TPair< UObject *, bool > > ObjectsToRemove Array of objects requested to be removed by an operation
Private variable FDelegateHandle OnAssetDeletedHandle  
Private variable FOnStepAboutToBeRemoved OnStepsAboutToBeRemoved Broadcast when a step is about to be removed
Private variable FOnStepsOrderChanged OnStepsOrderChanged Broadcasts any change to the stack of steps
Private variable FOnStepWasEdited OnStepWasEdited Broacast when a subobject of a step or a step object was edited
Private variable TSharedPtr< FDataprepOperationContext > OperationContext Context passed to the operation for its execution
Private variable TWeakObjectPtr< UPackage > PackageForAnimation Package which level sequences will be added to
Private variable TWeakObjectPtr< UPackage > PackageForMaterial Package which materials will be added to
Private variable TWeakObjectPtr< UPackage > PackageForStaticMesh Package which static meshes will be added to
Private variable TWeakObjectPtr< UPackage > PackageForTexture Package which textures will be added to
Private variable UProperty TArray< TObjectPtr< UDataprepActionStep > > Steps Array of operations and/or filters constituting this action
Public variable UDataprepAsset UDataprepActionAsset  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page