1. Epic GamesDeveloper
  3. UDataprepContentProducer

UDataprepContentProducer

Abstract class to derived from to be a producer in the Dataprep asset

API > API/Plugins > API/Plugins/DataprepCore

Inheritance Hierarchy

References

   
Module DataprepCore
Header /Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/Public/DataprepContentProducer.h
Include #include "DataprepContentProducer.h"

Syntax

UCLASS (Abstract, BlueprintType)  
class UDataprepContentProducer : public UObject

Remarks

Abstract class to derived from to be a producer in the Dataprep asset

Variables

  Type Name Description
Protected variable FDataprepProducerContext Context Context which the producer will run with
Protected variable TSharedPtr< FFeedbackContext > FeedbackContext The feedback context in use to check for user cancellation
Protected variable FDataprepProducerChanged OnChanged Delegate to broadcast changes to the producer

Functions

  Type Name Description
Public function Virtual bool

CanAddToProducersArray ( bool bIsAutomated
)

 Allow a producer to pop a ui after being created.
Protected function Virtual bool

Execute ( TArray< TWeakObjectPtr< UObject > >& OutAssets
)

 Populates the world and fill up the array of assets.
Public function Virtual Const const FText & Text briefly describing what the producer is doing to populate the world and assets.
Public function Virtual Const const FText & Name used by the UI to be displayed.
Public function Virtual Const FString Text briefly describing what the producer is doing to populate the world and assets.
Public function UDataprepContentProducer::FDataprepProducerChanged TBaseMulticastDelegate_OneParam  
Protected function Virtual bool Initialize the producer to be ready for a call to the Execute method.
Public function Virtual bool Allow a producer to pop a ui after being created.
Public function bool Returns true if the producer was cancelled during execution
Protected function bool

IsValid ()

  
Protected function void

LogError ( const FText& Message
)

  
Protected function void

LogInfo ( const FText& Message
)

 Start of helper functions to log messages and report progress.
Protected function void

LogWarning ( const FText& Message
)

  
Public function bool

Produce ( const FDataprepProducerContext& InContext,
TArray< TWeakObjectPtr< UObject > >& OutAssets
)

 Successively calls the Initialize, Execute and Reset methods Additionally, to avoid naming collision, rename the newly created actors to include the producer's namespace.
Protected function Virtual void

Reset ()

 Clean up the objects used by the producer.
Public function Virtual Const bool

Supersede ( const UDataprepContentProducer* OtherProducer
)

 A producer supersede another if its produces the same content or a super-set of the other's content

Classes

  Type Name Description
Public class FDataprepProducerChanged Allow an observer to be notified when one of the properties of the producer changes  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page