Navigation
API > API/Runtime > API/Runtime/DataflowEngine
UObject wrapper for the UE::Dataflow::FGraph
| Name | UDataflow |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Dataflow/Engine/Public/Dataflow/DataflowObject.h |
| Include Path | #include "Dataflow/DataflowObject.h" |
Syntax
UCLASS (BlueprintType, CustomConstructor, MinimalAPI)
class UDataflow :
public UEdGraph ,
public IMeshDeformerProducer ,
public IDataflowGraphInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UEdGraph → UDataflow
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDataflow
(
const FObjectInitializer& ObjectInitializer |
Dataflow/DataflowObject.h | ||
UDataflow
(
const FObjectInitializer& ObjectInitializer |
Dataflow/DataflowObject.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| SimulationTag | const FString | Simulation tag to use in the node registry | Dataflow/DataflowObject.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bActive | bool | Dataflow/DataflowObject.h |
|
|
| Dataflow | TSharedPtr< UE::Dataflow::FGraph, ESPMode::ThreadSafe > | Dataflow/DataflowObject.h | ||
| LastModifiedRenderTarget | UE::Dataflow::FTimestamp | Dataflow/DataflowObject.h | ||
| Material | TObjectPtr< UMaterial > | Dataflow/DataflowObject.h |
|
|
| PreviewBlueprintClass | TSubclassOf< AActor > | Caching blueprint actor class to spawn | Dataflow/DataflowObject.h |
|
| PreviewBlueprintTransform | FTransform | Caching blueprint actor transform to spawn | Dataflow/DataflowObject.h |
|
| PreviewCacheAsset | TSoftObjectPtr< UObject > | Cache asset used in this asset | Dataflow/DataflowObject.h |
|
| PreviewCacheParams | FDataflowPreviewCacheParams | The following PreviewScene properties are modeled after PreviewSkeletalMesh in USkeleton | Dataflow/DataflowObject.h |
|
| PreviewEmbeddedSkeletalMesh | TSoftObjectPtr< UObject > | SkeletalMesh interpolated from simulation | Dataflow/DataflowObject.h |
|
| PreviewEmbeddedStaticMesh | TSoftObjectPtr< UObject > | Static Mesh interpolated from simulation | Dataflow/DataflowObject.h |
|
| PreviewGeometryCacheAsset | TSoftObjectPtr< UObject > | Geometry cache asset used to extract skeletal mesh results from simulation | Dataflow/DataflowObject.h |
|
| RenderTargets | TArray< TObjectPtr< const UDataflowEdNode > > | Dataflow/DataflowObject.h | ||
| Targets | TArray< TObjectPtr< UObject > > | Dataflow/DataflowObject.h |
|
|
| Type | EDataflowType | Dataflow/DataflowObject.h |
|
|
| Variables | FInstancedPropertyBag | Dataflow/DataflowObject.h | ||
| WireframeRenderTargets | TArray< TObjectPtr< const UDataflowEdNode > > | Dataflow/DataflowObject.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BeginDestroyEvent | FMeshDeformerBeginDestroyEvent | Broadcasts a notification just before the dataflow is destroyed. | Dataflow/DataflowObject.h | |
| bEnablePerNodeTransactionSerialization | bool | Used to disable per-node serialization when serializing a transaction | Dataflow/DataflowObject.h | |
| DataflowSubGraphs | TArray< TObjectPtr< UDataflowSubGraph > > | List of Dataflow SubGraphs In editor they also exists in the SubGraphs parent class property | Dataflow/DataflowObject.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddRenderTarget
(
TObjectPtr< const UDataflowEdNode > |
Render Targets | Dataflow/DataflowObject.h | |
void AddSubGraph
(
UDataflowSubGraph* SubGraph |
Add a SubGraph to the asset | Dataflow/DataflowObject.h | |
void AddWireframeRenderTarget
(
TObjectPtr< const UDataflowEdNode > |
Dataflow/DataflowObject.h | ||
FDataflowAssetEdit EditDataflow() |
Editing the collection should only be through the edit object. | Dataflow/DataflowObject.h | |
| Find all the node of a speific type and evaluate them using a specific UObject | Dataflow/DataflowObject.h | ||
TObjectPtr< const UDataflowEdNode > FindEdNodeByDataflowNodeGuid
(
const FGuid& Guid |
Dataflow/DataflowObject.h | ||
TObjectPtr< UDataflowEdNode > FindEdNodeByDataflowNodeGuid
(
const FGuid& Guid |
Dataflow/DataflowObject.h | ||
UDataflowSubGraph * FindSubGraphByGuid
(
const FGuid& SubGraphGuid |
Dataflow/DataflowObject.h | ||
const UDataflowSubGraph * FindSubGraphByGuid
(
const FGuid& SubGraphGuid |
Find a SubGraph by its guid | Dataflow/DataflowObject.h | |
UDataflowSubGraph * FindSubGraphByName
(
FName Name |
Dataflow/DataflowObject.h | ||
const UDataflowSubGraph * FindSubGraphByName
(
FName Name |
Find a SubGraph by name | Dataflow/DataflowObject.h | |
| Dataflow/DataflowObject.h | |||
TSharedPtr< const UE::Dataflow::FGraph, ESPMode::ThreadSafe > GetDataflow () |
Accessors for internal geometry collection | Dataflow/DataflowObject.h | |
const UE::Dataflow::FTimestamp & GetRenderingTimestamp() |
Dataflow/DataflowObject.h | ||
const TArray< TObjectPtr< const UDataflowEdNode > > & GetRenderTargets() |
Dataflow/DataflowObject.h | ||
const TArray< TObjectPtr< UDataflowSubGraph > > & GetSubGraphs() |
Dataflow/DataflowObject.h | ||
const TArray< TObjectPtr< const UDataflowEdNode > > & GetWireframeRenderTargets() |
Dataflow/DataflowObject.h | ||
bool IsPerNodeTransactionSerializationEnabled() |
Used to disable per-node serialization when serializing a transaction | Dataflow/DataflowObject.h | |
void PostEditCallback() |
Dataflow/DataflowObject.h | ||
void RefreshEdNode
(
TObjectPtr< UDataflowEdNode > EdNode |
Make sure EdNode gets refreshed from its dataflow node This is useful when connections are changed | Dataflow/DataflowObject.h | |
void RefreshEdNodeByGuid
(
const FGuid NodeGuid |
Dataflow/DataflowObject.h | ||
void RemoveRenderTarget
(
TObjectPtr< const UDataflowEdNode > |
Dataflow/DataflowObject.h | ||
void RemoveSubGraph
(
UDataflowSubGraph* SubGraph |
Dataflow/DataflowObject.h | ||
void RemoveWireframeRenderTarget
(
TObjectPtr< const UDataflowEdNode > |
Dataflow/DataflowObject.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Dataflow/DataflowObject.h | ||
virtual bool CanEditChange
(
const FProperty* InProperty |
Dataflow/DataflowObject.h | ||
virtual bool IsEditorOnly() |
Dataflow/DataflowObject.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Dataflow/DataflowObject.h | ||
virtual void PostLoad() |
Dataflow/DataflowObject.h | ||
virtual void Serialize
(
FArchive& Ar |
End UObject Interface | Dataflow/DataflowObject.h |
Overridden from IMeshDeformerProducer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FMeshDeformerBeginDestroyEvent & OnBeginDestroy() |
Dataflow/DataflowObject.h |
Overridden from IDataflowGraphInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< UE::Dataflow::FGraph > GetDataflowGraph() |
Dataflow/DataflowObject.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddReferencedObjects
(
UObject* InThis, |
UObject Interface | Dataflow/DataflowObject.h | |
static const UDataflow * GetDataflowAssetFromEdGraph
(
const UEdGraph* EdGraph |
Dataflow/DataflowObject.h | ||
static UDataflow * GetDataflowAssetFromEdGraph
(
UEdGraph* EdGraph |
Find the Dataflow asset from a sepcific graph/subgraph | Dataflow/DataflowObject.h |