1. Epic GamesDeveloper
  3. DataprepCore

DataprepCore

API > API/Plugins

   
Name DataprepCore
Type Editor
Part of Plugins Dataprep Editor
Location /Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/
Module Build Rules DataprepCore.Build.cs

Classes

Name Remarks
FDataprepCoreUtils  
FDataprepOperationCategories  
FDataprepParameterizationUtils  
FDataprepWorkReporter Helper class to encapsulate the IDataprepProgressReporter interface
FOnStepAboutToBeRemoved  
FOnStepsOrderChanged  
FOnStepWasEdited  
TDataprepBindingCommandChange  
TSubclassOf  
UDataprepActionAppearance Persists graphical state of the node associated with this action asset.
UDataprepActionStep  
UDataprepAsset A DataprepAsset is an implementation of the DataprepAssetInterface using a Blueprint as the recipe pipeline.
UDataprepAssetFactory LevelFactory.
UDataprepAssetInstance A DataprepAssetInstance is an implementation of the DataprepAssetInterface sharing its recipe pipeline with an existing Dataprep asset or another DataprepAssetInstance.
UDataprepAssetInstanceFactory  
UDataprepAssetInterface  
UDataprepAssetProducers A UDataprepAssetProducers is a utility class to manage the set of producers constituting the inputs of a DataprepAssetInterface.
UDataprepAssetUserData A DataprepAssetUserData is used to mark assets or actors created through a Dataprep pipeline
UDataprepBoolFetcher The bool fetcher is a specialized type of fetcher for the booleans
UDataprepBoolFilter  
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
UDataprepContentConsumer Abstract class providing the minimal services required for a DataprepConsumer
UDataprepContentProducer Abstract class to derived from to be a producer in the Dataprep asset
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
UDataprepFetcher The Dataprep fetcher is a base class for Dataprep Selection system.
UDataprepFilter The Dataprep Filter a base class for the Dataprep selection system It's main responsibility is to filter a array of object and to return the selected objects
UDataprepFilterNoFetcher The Dataprep Filter a base class for the Dataprep selection system It's main responsibility is to filter a array of object and to return the selected objects
UDataprepFloatFetcher The float fetcher is a specialized type of fetcher for the float
UDataprepFloatFilter  
UDataprepIntegerFetcher The integer fetcher is a specialized type of fetcher for the integer
UDataprepIntegerFilter  
UDataprepObjectSelectionFilter  
UDataprepOperation Base class for all Dataprep operations Dataprep operations act on a set of input obejcts and can modify their properties: f.e.
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
UDataprepRecipeInterface A DataprepAssetInterface is composed of a set of producers, inputs, a consumer, output, and a recipe, set of actions.
UDataprepRecursiveSelectionTransform  
UDataprepSelectionTransform  
UDataprepStringFetcher The string fetcher is a specialized type of fetcher for the string
UDataprepStringFilter  
UDataprepStringFilterMatchingArray  
UDataprepStringsArrayFetcher  
UDataprepStringsArrayFilter  
UDEPRECATED_DataprepRecipe  
UK2Node_DataprepActionCore  

Structs

Name Remarks
FDataprepActionContext Structure to pass execution context to action
FDataprepAssetProducer Structure to hold on a producer and its configuration
FDataprepConsumerContext  
FDataprepContext Experimental struct. Todo add struct wide comment
FDataprepOperationContext Contains all data regarding the context in which an operation will be executed
FDataprepParameterizationContext A small context that help when constructing the widgets for the parameterization
FDataprepProducerContext Structure to pass execution context to producer
FDataprepPropertyLink  
FDataprepSelectionInfo A struct to cache the result of a filter with some additional info
TIsFilterDataDisplayable Those template must be keep in sync with the variant. Those are the data types that the filter preview can display the data in the columns (scene preview and asset preview)

Interfaces

Name Remarks
IDataprepLogger This is the interface that a logger must implement to work with the Dataprep core functionalities
IDataprepProgressReporter This is the interface that a progress reporter must implement to work with FDataprepWorkReporter

Typedefs

Name Type Remarks Include Path
FActionsContextChangedFunc TFunction< void(const UDataprepActionAsset *, bool, bool, const TArray< TWeakObjectPtr< UObject > > &)> Callback used to report a global change to the content it is working on DataprepActionAsset.h
FCanExecuteNextStepFunc TFunction< bool(UDataprepActionAsset *)> Callback function used to confirm continuation after executing an operation or a filter DataprepActionAsset.h
FDataprepAddAsset TBaseDelegate_TwoParams< UObject *, const UObject *, const TCHAR * > Delegate used by a Dataprep operation to add a copy of an asset to the Dataprep's working set DataprepOperation.h
FDataprepAssetsModified TBaseDelegate_OneParam< void, TArray< UObject * > > Delegate used by a Dataprep operation to indicates an asset has been modified DataprepOperation.h
FDataprepCreateActor TBaseDelegate_TwoParams< class AActor *, UClass *, const TCHAR * > Delegate used by a Dataprep operation to add an actor to the Dataprep's working set DataprepOperation.h
FDataprepCreateAsset TBaseDelegate_TwoParams< UObject *, UClass *, const TCHAR * > Delegate used by a Dataprep operation to create and add an asset to the Dataprep's working set DataprepOperation.h
FDataprepDeleteObjects TBaseDelegate_OneParam< void, TArray< UObject * > > Delegate used by a Dataprep operation to remove and delete an array of objects from the Dataprep's working set. DataprepOperation.h
FDataprepRemoveObject TBaseDelegate_TwoParams< void, UObject *, bool > 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 DataprepOperation.h
FFilterVariantData TVariant< FEmptyVariantState, int32, float, FString > This type is the variant used by the dataprep filter preview system to store a fetched data and then displaying it latter. SelectionSystem/DataprepSelectionSystemStructs.h

Enums

Public

Name Remarks
EDataprepFloatMatchType  
EDataprepIntegerMatchType  
EDataprepStringMatchType  
EParametrizationState  
FDataprepAssetChangeType  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExecutionInterrupted bool   DataprepActionAsset.h
  • Transient
bIsEnabled bool   DataprepActionAsset.h  
FetcherClass const TSubclassOf< UDataprepFetcher > &   DataprepActionAsset.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual ~UDataprepActionAsset()

   DataprepActionAsset.h  
Add a new step base on the type of step DataprepActionAsset.h  

int32 AddStep ( const UDataprepActionStep* ActionStep
)

 Add a copy of the step to the action DataprepActionAsset.h  

int32 AddStep ( const UDataprepParameterizableObject* StepObject
)

 Add a copy of the step object to the action DataprepActionAsset.h  

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

 Add a copy of each step to the action DataprepActionAsset.h  

void EnableStep ( int32 Index,
bool bEnable
)

 Allow to set the enabled state of a step DataprepActionAsset.h  

void Execute ( const TArray< UObject* >& InObjects
)

 Execute the action on a specific set of objects DataprepActionAsset.h
  • BlueprintCallable
  • Category="Execution"

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

 Execute the action DataprepActionAsset.h  

UDataprepActionAppearance * GetAppearance()

   DataprepActionAsset.h  

const TCHAR * GetLabel()

 Getter and Setter on the UI text of the action DataprepActionAsset.h  

FOnStepAboutToBeRemoved & GetOnStepAboutToBeRemoved()

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

FOnStepsOrderChanged & GetOnStepsOrderChanged()

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

FOnStepWasEdited & GetOnStepWasEdited()

 Allow an observer to be notified when a step was edited (the step itself or a sub object of it) DataprepActionAsset.h  

TWeakObjectPtr< UDataprepActionStep > GetStep ( int32 Index
)

 Access to a step of the action Access to a step of the action DataprepActionAsset.h  

int32 GetStepsCount()

 Get the number of steps of this action DataprepActionAsset.h  

uint32 GetTypeHash ( const FDataprepPropertyLink& PropertyLink
)

   Parameterization/DataprepParameterizationUtils.h  

bool InsertStep ( const UDataprepActionStep* ActionStep,
int32 Index
)

 Insert a copy of the step into the action at the requested index DataprepActionAsset.h  

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

 Insert a copy of each step into the action at the requested index DataprepActionAsset.h  

bool IsStepEnabled ( int32 Index
) const

 Get enabled status of an operation DataprepActionAsset.h  

bool MoveStep ( int32 StepIndex,
int32 DestinationIndex
)

 Move a step to another spot in the order of steps This operation take O(n) time. DataprepActionAsset.h  

void NotifyDataprepSystemsOfRemoval()

 Do the necessary notification so that the Dataprep system can react properly to removal of this action DataprepActionAsset.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   DataprepActionAsset.h  

bool RemoveStep ( int32 Index,
bool bDiscardParametrization
)

 Remove a step from the action DataprepActionAsset.h  

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

 Remove an array of steps from the action DataprepActionAsset.h  

void SetLabel ( const TCHAR* InLabel
)

   DataprepActionAsset.h  

bool SwapSteps ( int32 FirstIndex,
int32 SecondIndex
)

 Swap the steps DataprepActionAsset.h  

FOnStepWasEdited TBaseMulticastDelegate_TwoParams UDataprepActionAsset()

   DataprepActionAsset.h  

UE_DEPRECATED (

  1. 26,
    "Please use the function add step and simply pass the OperationClass"
    ) const
 Add an operation to the action DataprepActionAsset.h  

UE_DEPRECATED (

  1. 26,
    "Please use the function add step and simply pass the FetcherClass"
    ) const
 Add a filter and setup it's fetcher DataprepActionAsset.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page