Navigation
API > API/Plugins > API/Plugins/DataprepCore
Abstract class to derived from to be a producer in the Dataprep asset
| Name | UDataprepContentProducer |
| Type | class |
| Header File | /Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/Public/DataprepContentProducer.h |
| Include Path | #include "DataprepContentProducer.h" |
Syntax
UCLASS (Abstract, BlueprintType)
class UDataprepContentProducer : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDataprepContentProducer
Classes
| Name | Remarks |
|---|---|
| FDataprepProducerChanged | Allow an observer to be notified when one of the properties of the producer changes |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAddToProducersArray
(
bool bIsAutomated |
Allow a producer to pop a ui after being created. | DataprepContentProducer.h | |
virtual const FText & GetDescription () |
Text briefly describing what the producer is doing to populate the world and assets. | DataprepContentProducer.h | |
virtual const FText & GetLabel() |
Name used by the UI to be displayed. | DataprepContentProducer.h | |
virtual FString GetNamespace () |
Text briefly describing what the producer is doing to populate the world and assets. | DataprepContentProducer.h | |
UDataprepContentProducer::FDataprepProducerChanged TBaseMulticastDelegate_OneParam GetOnChanged() |
DataprepContentProducer.h | ||
virtual bool IsActive() |
Allow a producer to pop a ui after being created. | DataprepContentProducer.h | |
bool IsCancelled() |
Returns true if the producer was cancelled during execution | DataprepContentProducer.h | |
bool Produce
(
const FDataprepProducerContext& InContext, |
Successively calls the Initialize, Execute and Reset methods Additionally, to avoid naming collision, rename the newly created actors to include the producer's namespace. | DataprepContentProducer.h | |
virtual bool Supersede
(
const UDataprepContentProducer* OtherProducer |
A producer supersede another if its produces the same content or a super-set of the other's content | DataprepContentProducer.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Execute
(
TArray< TWeakObjectPtr< UObject > >& OutAssets |
Populates the world and fill up the array of assets. | DataprepContentProducer.h | |
virtual bool Initialize() |
Initialize the producer to be ready for a call to the Execute method. | DataprepContentProducer.h | |
bool IsValid() |
DataprepContentProducer.h | ||
void LogError
(
const FText& Message |
DataprepContentProducer.h | ||
void LogInfo
(
const FText& Message |
Start of helper functions to log messages and report progress. | DataprepContentProducer.h | |
void LogWarning
(
const FText& Message |
DataprepContentProducer.h | ||
virtual void Reset () |
Clean up the objects used by the producer. | DataprepContentProducer.h |