UDataflow

[UDataflow](API\Runtime\DataflowEngine\UDataflow) ([UObject](API\Runtime\CoreUObject\UObject))

API > API/Runtime > API/Runtime/DataflowEngine

UDataflow (UObject)

UObject wrapper for the UE::Dataflow::FGraph

   
Name UDataflow
Type class
Header File /Engine/Source/Runtime/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

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
  • Meta=(DeprecatedProperty, DeprecationMessage="bActive property is deprecated as it is no longer used")
Dataflow TSharedPtr< UE::Dataflow::FGraph, ESPMode::ThreadSafe >   Dataflow/DataflowObject.h  
LastModifiedRenderTarget UE::Dataflow::FTimestamp   Dataflow/DataflowObject.h  
Material TObjectPtr< UMaterial >   Dataflow/DataflowObject.h
  • EditAnywhere
  • Category="Render"
PreviewBlueprintClass TSubclassOf< AActor > Caching blueprint actor class to spawn Dataflow/DataflowObject.h
  • DuplicateTransient
  • AssetRegistrySearchable
PreviewBlueprintTransform FTransform Caching blueprint actor transform to spawn Dataflow/DataflowObject.h
  • DuplicateTransient
  • AssetRegistrySearchable
PreviewCacheAsset TSoftObjectPtr< UObject > Cache asset used in this asset Dataflow/DataflowObject.h
  • DuplicateTransient
  • AssetRegistrySearchable
PreviewCacheParams FDataflowPreviewCacheParams The following PreviewScene properties are modeled after PreviewSkeletalMesh in USkeleton Dataflow/DataflowObject.h
  • DuplicateTransient
  • AssetRegistrySearchable
PreviewEmbeddedSkeletalMesh TSoftObjectPtr< UObject > SkeletalMesh interpolated from simulation Dataflow/DataflowObject.h
  • DuplicateTransient
  • AssetRegistrySearchable
PreviewEmbeddedStaticMesh TSoftObjectPtr< UObject > Static Mesh interpolated from simulation Dataflow/DataflowObject.h
  • DuplicateTransient
  • AssetRegistrySearchable
PreviewGeometryCacheAsset TSoftObjectPtr< UObject > Geometry cache asset used to extract skeletal mesh results from simulation Dataflow/DataflowObject.h
  • DuplicateTransient
  • AssetRegistrySearchable
ReferenceAsset TObjectPtr< UObject > Reference asset to use for this Dataflow The reference asset is used when opening the dataflow asset editor If the dataflow is shared among multiple assets, and the reference asset is set, only this asset will be able to change the dataflow (for the other the dataflow graph will be read-only and only evaluation and overrides will be available) Dataflow/DataflowObject.h
  • EditAnywhere
  • Category=Reference
RenderTargets TArray< TObjectPtr< const UDataflowEdNode > >   Dataflow/DataflowObject.h  
Targets TArray< TObjectPtr< UObject > >   Dataflow/DataflowObject.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Targets property is deprecated as it is no longer used")
Type EDataflowType   Dataflow/DataflowObject.h
  • EditAnywhere
  • Category="Evaluation"
  • Meta=(EditConditionHides)
Variables FInstancedPropertyBag Dataflow variables Variables are used by the graph to parametrized the graph They can can default values and can be overriden on a per asset basis ( see Dataflow Instance ) 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  
CompiledGraphs TMap< const UObject *, TSharedRef< UE::Dataflow::FCompiledGraph > > Contained the most recent compiled dataflow graph (see GetGraphTopologyGuid ) 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  
LastCompiledTopologyGUID FGuid Stores the topology GUID used fro the most recent compilation (see CompiledGraphs) 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  

TSharedPtr< const UE::Dataflow::FCompiledGraph > CompileGraphIfNeeded()

 Compile the dataflow graph if it has not been compiled since last change to the graph returns a shared pointer to the compiled graph Dataflow/DataflowObject.h  

FDataflowAssetEdit EditDataflow()

 Editing the collection should only be through the edit object. Dataflow/DataflowObject.h  

void EvaluateTerminalNodeByName ( FName NodeName,
UObject* Asset
)

 Find all the node of a speific type and evaluate them using a specific UObject Dataflow/DataflowObject.h  
  Dataflow/DataflowObject.h  
  Dataflow/DataflowObject.h  

const UDataflowSubGraph * FindSubGraphByGuid ( const FGuid& SubGraphGuid
) const

 Find a SubGraph by its guid Dataflow/DataflowObject.h  

UDataflowSubGraph * FindSubGraphByGuid ( const FGuid& SubGraphGuid
)

   Dataflow/DataflowObject.h  

const UDataflowSubGraph * FindSubGraphByName ( FName Name
) const

 Find a SubGraph by name Dataflow/DataflowObject.h  
  Dataflow/DataflowObject.h  
Accessors for internal geometry collection Dataflow/DataflowObject.h  
  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  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Dataflow/DataflowObject.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Dataflow/DataflowObject.h  

virtual bool IsEditorOnly()

   Dataflow/DataflowObject.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Dataflow/DataflowObject.h  

virtual void PostEditUndo()

   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,
FReferenceCollector& Collector
)

 UObject Interface Dataflow/DataflowObject.h  

static const UDataflow * GetDataflowAssetFromEdGraph ( const UEdGraph* EdGraph
)

   Dataflow/DataflowObject.h  
Find the Dataflow asset from a sepcific graph/subgraph Dataflow/DataflowObject.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page