Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → UEditorDataprepAssetLibrary
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 |
|
static UDataprepActionAsset * AddActionByDuplication
(
UDataprepAsset* DataprepAsset, |
Add an action to a dataprep asset the action is added at the end of the action list | EditorDataprepAssetLibrary.h |
|
static UDataprepContentProducer * AddProducer
(
UDataprepAssetInterface* DataprepAssetInterface, |
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 |
|
static UDataprepContentProducer * AddProducerAutomated
(
UDataprepAssetInterface* DataprepAssetInterface, |
Add a producer to a dataprep asset | EditorDataprepAssetLibrary.h |
|
static UDataprepParameterizableObject * AddStep
(
UDataprepActionAsset* DataprepAction, |
Add a step to a dataprep action | EditorDataprepAssetLibrary.h |
|
static UDataprepParameterizableObject * AddStepByDuplication
(
UDataprepActionAsset* DataprepAction, |
Add a step to a dataprep action by duplicating the step object | EditorDataprepAssetLibrary.h |
|
static bool ExecuteDataprep
(
UDataprepAssetInterface* DataprepAssetInterface, |
Runs the Dataprep asset's producers, execute its recipe and finally runs the consumer to output the results. | EditorDataprepAssetLibrary.h |
|
static UDataprepActionAsset * GetAction
(
UDataprepAsset* DataprepAsset, |
Get an action from a dataprep asset. | EditorDataprepAssetLibrary.h |
|
static int32 GetActionCount
(
UDataprepAsset* DataprepAsset |
Get number of actions of a dataprep asset | EditorDataprepAssetLibrary.h |
|
static UDataprepContentConsumer * GetConsumer
(
UDataprepAssetInterface* DataprepAssetInterface |
Access the consumer of a dataprep asset | EditorDataprepAssetLibrary.h |
|
static UDataprepContentProducer * GetProducer
(
UDataprepAssetInterface* DataprepAssetInterface, |
Get a producer from a dataprep asset. | EditorDataprepAssetLibrary.h |
|
static int32 GetProducersCount
(
const UDataprepAssetInterface* DataprepAssetInterface |
Get number of the producer of a dataprep asset | EditorDataprepAssetLibrary.h |
|
static UDataprepParameterizableObject * GetStepObject
(
UDataprepActionAsset* DataprepAction, |
Return the object of a step from the dataprep action | EditorDataprepAssetLibrary.h |
|
static int32 GetStepsCount
(
UDataprepActionAsset* DataprepAction |
Get the number of steps for a dataprep action | EditorDataprepAssetLibrary.h |
|
static void MoveStep
(
UDataprepActionAsset* DataprepAction, |
Move a step of the dataprep action | EditorDataprepAssetLibrary.h |
|
static void RemoveAction
(
UDataprepAsset* DataprepAsset, |
Remove an action from a dataprep asset | EditorDataprepAssetLibrary.h |
|
static void RemoveProducer
(
UDataprepAssetInterface* DataprepAssetInterface, |
Remove a producer from a dataprep asset | EditorDataprepAssetLibrary.h |
|
static void RemoveStep
(
UDataprepActionAsset* DataprepAction, |
Remove a step from the action | EditorDataprepAssetLibrary.h |
|
static void SwapActions
(
UDataprepAsset* DataprepAsset, |
Swap the actions of a dataprep asset | EditorDataprepAssetLibrary.h |
|
static void SwapSteps
(
UDataprepActionAsset* DataprepAction, |
Swap the steps of a dataprep action | EditorDataprepAssetLibrary.h |
|