1. Epic GamesDeveloper
  3. UEditorDataprepAssetLibrary

UEditorDataprepAssetLibrary

Utility class to do most expose most of the common functionalities of the dataprep editor plugin (Visual Dataprep).

API > API/Plugins > API/Plugins/DataprepEditorScriptingUtilities

Utility class to do most expose most of the common functionalities of the dataprep editor plugin (Visual Dataprep).

A Dataprep asset is composed of tree main parts: a array of producers, a recipe and a consumer.

The producers are the objects that manage the logistic of importing the data into the dataprep context For example, a DatasmithFileProducer is an object that can import the data from a file using the datasmith importer

The recipe is a series of DataprepActions. Each action is generally compose of a filter(s) and an operation(s) We refer those as the steps of action. The typical action consist in filtering the dataprep context to get a subset objects and passing those to some operations. Each action receive the full context from the scene and the asset loaded into the dataprep environment.

The consumer is the object that receive the dataprep environment and turns it into something useful and not transient. Currently, the only type of consumer supported is the DatasmithConsumer. It take the dataprep environment and import it into the engine in similar fashion to a standard datasmith import.

More on the dataprep action asset: Each step of dataprep action are a descendant of the type UDataprepParameterizableObject. When setting the value of variables on those objects prefer using the SetEditorProperty utility function as the parameterization of the dataprep asset depends on certain editor calls to stay in sync with the recipe.

   
Name UEditorDataprepAssetLibrary
Type class
Header File /Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepEditorScriptingUtilities/Public/EditorDataprepAssetLibrary.h
Include Path #include "EditorDataprepAssetLibrary.h"

Syntax

UCLASS (Blueprintable, BlueprintType, Meta=(DisplayName="Dataprep Core Blueprint Library"))  
class UEditorDataprepAssetLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static UDataprepActionAsset * AddAction ( UDataprepAsset* DataprepAsset
)

 Add an action to a dataprep asset the action is added at the end of the action list EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static UDataprepActionAsset * AddActionByDuplication ( UDataprepAsset* DataprepAsset,
UDataprepActionAsset* ActionToDuplicate
)

 Add an action to a dataprep asset the action is added at the end of the action list EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static UDataprepContentProducer * AddProducer ( UDataprepAssetInterface* DataprepAssetInterface,
TSubclassOf< UDataprepContentProducer > ProducerClass
)

 Add a producer to a dataprep asset (The producer will act as if was call from the dataprep editor, use the automated version if you don't want any ui) EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Producers"
  • Meta=(DeterminesOutputType="ProducerClass")

static UDataprepContentProducer * AddProducerAutomated ( UDataprepAssetInterface* DataprepAssetInterface,
TSubclassOf< UDataprepContentProducer > ProducerClass
)

 Add a producer to a dataprep asset EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Producers"
  • Meta=(DeterminesOutputType="ProducerClass")

static UDataprepParameterizableObject * AddStep ( UDataprepActionAsset* DataprepAction,
TSubclassOf< UDataprepParameterizableObject > StepType
)

 Add a step to a dataprep action EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static UDataprepParameterizableObject * AddStepByDuplication ( UDataprepActionAsset* DataprepAction,
UDataprepParameterizableObject* StepObject
)

 Add a step to a dataprep action by duplicating the step object EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static bool ExecuteDataprep ( UDataprepAssetInterface* DataprepAssetInterface,
EDataprepReportMethod LogReportingMethod,
EDataprepReportMethod ProgressReportingMethod
)

 Runs the Dataprep asset's producers, execute its recipe and finally runs the consumer to output the results. EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset"

static UDataprepActionAsset * GetAction ( UDataprepAsset* DataprepAsset,
int32 Index
)

 Get an action from a dataprep asset. EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static int32 GetActionCount ( UDataprepAsset* DataprepAsset
)

 Get number of actions of a dataprep asset EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static UDataprepContentConsumer * GetConsumer ( UDataprepAssetInterface* DataprepAssetInterface
)

 Access the consumer of a dataprep asset EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Consumer"

static UDataprepContentProducer * GetProducer ( UDataprepAssetInterface* DataprepAssetInterface,
int32 Index
)

 Get a producer from a dataprep asset. EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Producers"

static int32 GetProducersCount ( const UDataprepAssetInterface* DataprepAssetInterface
)

 Get number of the producer of a dataprep asset EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Producers"

static UDataprepParameterizableObject * GetStepObject ( UDataprepActionAsset* DataprepAction,
int32 Index
)

 Return the object of a step from the dataprep action EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static int32 GetStepsCount ( UDataprepActionAsset* DataprepAction
)

 Get the number of steps for a dataprep action EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static void MoveStep ( UDataprepActionAsset* DataprepAction,
int32 StepIndex,
int32 DestinationIndex
)

 Move a step of the dataprep action EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static void RemoveAction ( UDataprepAsset* DataprepAsset,
int32 Index
)

 Remove an action from a dataprep asset EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static void RemoveProducer ( UDataprepAssetInterface* DataprepAssetInterface,
int32 Index
)

 Remove a producer from a dataprep asset EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Producers"

static void RemoveStep ( UDataprepActionAsset* DataprepAction,
int32 Index
)

 Remove a step from the action EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static void SwapActions ( UDataprepAsset* DataprepAsset,
int32 FirstActionIndex,
int32 SecondActionIndex
)

 Swap the actions of a dataprep asset EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

static void SwapSteps ( UDataprepActionAsset* DataprepAction,
int32 FirstIndex,
int32 SecondIndex
)

 Swap the steps of a dataprep action EditorDataprepAssetLibrary.h
  • BlueprintCallable
  • Category="Editor Scripting | Dataprep Asset | Actions"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page