DataprepCore

Windows
MacOS
Linux

Filters

Classes

Name

Description

Public struct

FDataprepActionContext

Structure to pass execution context to action

Public struct UStruct experimental

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 experimental

UDataprepActionStep

Public class UClass BlueprintType experimental

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 experimental

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 experimental

UDataprepAssetInterface

Public class UClass experimental

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 experimental

UDataprepContentConsumer

Abstract class providing the minimal services required for a DataprepConsumer

Public class UClass Abstract BlueprintType experimental

UDataprepContentProducer

Abstract class to derived from to be a producer in the Dataprep asset

Public class UClass Abstract Blueprintable experimental

UDataprepEditingOperation

Todo add class wide comment.

Public class UClass Abstract Blueprintable experimental

UDataprepOperation

Todo add class wide comment.

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 experimental

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, experimental

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

Name

Description

Public enum

FDataprepAssetChangeType

Functions

Name Description

Public function Virtual

 

~UDataprepActionAsset()

Private function

void

 

AddAssetToContext

(
    UObject * NewAsset,
    const TCHAR * DesiredName
)

Add an asset to the execution context

Public function

int32

 

AddFilterWithAFetcher

(
    const TSubclassOf < UDataprepFilter ...,
    const TSubclassOf < UDataprepFetcher ...
)

Add a filter and setup it's fetcher

Public function

int32

 

AddOperation

(
    const TSubclassOf < UDataprepOperati ...
)

Add an operation to the action

Public function

int32

 

AddStep

Add a new step base on the type of step

Public function

int32

 

AddStep

(
    const UDataprepActionStep * Act...
)

Add a copy of the step to the action

Public function

int32

 

AddStep

(
    const UDataprepParameterizableObjec ...
)

Add a copy of the step object to the action

Public function

int32

 

AddSteps

(
    const TArray < const UDataprepAction ...
)

Add a copy of each step to the action

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

Execute the action on a specific set of objects

Public function

void

 

ExecuteAction

(
    const TSharedPtr < FDataprepActionCo ...,
    UDataprepActionStep * SpecificS...,
    bool bSpecificStepOnly
)

Execute the action

Private function

UObject *...

 

GetAssetOuterByClass

(
    UClass * AssetClass
)

Returns the outer to be used according to an asset's class

Public function Const

const TCHAR ...

 

GetLabel()

Getter and Setter on the UI text of the action

Public function

FOnStepAbout ...

 

GetOnStepAboutToBeRemoved()

Allow an observer to be notified when a step is about to be removed from the action

Public function

FOnStepsOrde ...

 

GetOnStepsOrderChanged()

Allow an observer to be notified when the steps order changed that also include adding and removing steps

Public function

FOnStepWasEd ...

 

GetOnStepWasEdited()

Allow an observer to be notified when a step was edited (the step himself or a sub object of it)

Public function

TWeakObjectP ...

 

GetStep

(
    int32 Index
)

Access to a step of the action Access to a step of the action

Public function Const

int32

 

GetStepsCount()

Get the number of steps of this action

Public function

bool

 

InsertStep

(
    const UDataprepActionStep * Act...,
    int32 Index
)

Insert a copy of the step into the action at the requested index

Public function

bool

 

InsertSteps

(
    const TArray < const UDataprepAction ...,
    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

 

NotifyDataprepSystemsOfRemoval()

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

 

OnAssetsModified

(
    TArray < UObject * > Assets
)

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 & Tra...
)

Private function

void

 

ProcessWorkingSetChanged()

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
)

Remove a step from the action

Public function

bool

 

RemoveSteps

(
    const TArray < int32 >& Indices
)

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

FOnStepWasEd ...

 

UDataprepActionAsset()

Variables

Name Description

Private variable

TArray < UObject ...

 

AddedObjects

Array of objects which have been added during the execution of an operation

Public variable UProperty Transient

bool

 

bExecutionInterrupted

Private variable

bool

 

bWorkingSetHasChanged

Marker to check if an operation has made any changes to the action's working set

Private variable

TSharedPtr < FDa ...

 

ContextPtr

Pointer to the context passed to the action for its execution

Public variable

FDataprepProduc ...

 

GetOnChanged

Public variable

UDataprepAssetU ...

 

GetOnChanged

Public variable

FDataprepAssetP ...

 

GetOnChanged

Public variable

FDataprepCoreUt ...

 

GetOnChanged

Public variable

enum FDataprepA ...

 

GetOnParentChanged

Private variable UProperty Category, EditAnywhere

FString

 

Label

UI label of the action

Private variable

TSet < TWeakObje ...

 

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

 

ObjectsToRemove

Array of objects requested to be removed by an operation

Private variable

FDelegateHandle

 

OnAssetDeletedHandle

Private variable

FOnStepAboutToB ...

 

OnStepsAboutToBeRemoved

Broadcast when a step is about to be removed

Private variable

FOnStepsOrderCh ...

 

OnStepsOrderChanged

Broadcasts any change to the stack of steps

Private variable

FOnStepWasEdite ...

 

OnStepWasEdited

Broacast when a subobject of a step or a step object was edited

Private variable

TSharedPtr < FDa ...

 

OperationContext

Context passed to the operation for its execution

Private variable

TWeakObjectPtr <...

 

PackageForAnimation

Package which level sequences will be added to

Private variable

TWeakObjectPtr <...

 

PackageForMaterial

Package which materials will be added to

Private variable

TWeakObjectPtr <...

 

PackageForStaticMesh

Package which static meshes will be added to

Private variable

TWeakObjectPtr <...

 

PackageForTexture

Package which textures will be added to

Private variable UProperty

TArray < UDatapr ...

 

Steps

Array of operations and/or filters constituting this action

Public variable

UDataprepAsset

 

UDataprepActionAsset

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback