| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepEditorScriptingUtilities/Public/EditorDataprepAssetLibrary.h |
Include |
#include "EditorDataprepAssetLibrary.h" |
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, BlueprintType, Meta=(DisplayName="Dataprep Core Blueprint Library"))
class UEditorDataprepAssetLibrary : public UBlueprintFunctionLibrary
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 | Description | ||
---|---|---|---|
|
UDataprepAct... |
AddAction ( |
Add an action to a dataprep asset |
|
UDataprepAct... |
AddActionByDuplication ( |
Add an action to a dataprep asset |
|
UDataprepCon... |
AddProducer ( |
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) |
|
UDataprepCon... |
AddProducerAutomated ( |
Add a producer to a dataprep asset |
|
UDataprepPar... |
AddStep ( |
Add a step to a dataprep action |
|
UDataprepPar... |
AddStepByDuplication ( |
Add a step to a dataprep action by duplicating the step object |
|
ExecuteDataprep ( |
Runs the Dataprep asset's producers, execute its recipe and finally runs the consumer to output the results. |
|
|
UDataprepAct... |
GetAction ( |
Get an action from a dataprep asset. |
|
GetActionCount ( |
Get number of actions of a dataprep asset |
|
|
UDataprepCon... |
GetConsumer ( |
Access the consumer of a dataprep asset |
|
UDataprepCon... |
GetProducer ( |
Get a producer from a dataprep asset. |
|
GetProducersCount ( |
Get number of the producer of a dataprep asset |
|
|
UDataprepPar... |
GetStepObject ( |
Return the object of a step from the dataprep action |
|
GetStepsCount ( |
Get the number of steps for a dataprep action |
|
|
MoveStep ( |
Move a step of the dataprep action |
|
|
RemoveAction ( |
Remove an action from a dataprep asset |
|
|
RemoveProducer ( |
Remove a producer from a dataprep asset |
|
|
RemoveStep ( |
Remove a step from the action |
|
|
SwapActions ( |
Swap the actions of a dataprep asset |
|
|
SwapSteps ( |
Swap the steps of a dataprep action |