1. Epic GamesDeveloper
  3. FDataflowNode

FDataflowNode

FNode Base class for node based evaluation within the Dataflow graph.

API > API/Runtime > API/Runtime/DataflowCore > API/Runtime/DataflowCore/Dataflow

Inheritance Hierarchy

References

   
Module DataflowCore
Header /Engine/Source/Runtime/Experimental/Dataflow/Core/Public/Dataflow/DataflowNode.h
Include #include "Dataflow/DataflowNode.h"

Syntax

USTRUCT ()  
struct FDataflowNode

Remarks

FNode Base class for node based evaluation within the Dataflow graph.

Note : Do NOT create mutable variables in the classes derived from FDataflowNode. The state is stored on the FContext. The Evaluate is const to allow support for multithreaded evaluation.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bActive  
Protected variable bool bPauseInvalidations  
Public variable FGuid Guid  
Public variable TMap< int, FDataflowInput * > Inputs  
Public variable UE::Dataflow::FTimestamp LastModifiedTimestamp  
Public variable FName Name  
Protected variable FOnNodeInvalidated OnNodeInvalidatedDelegate  
Public variable TMap< int, FDataflowOutput * > Outputs  
Protected variable UE::Dataflow::FTimestamp PausedModifiedTimestamp  

Constructors

  Type Name Description
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS  

Functions

  Type Name Description
Public function Virtual void  
Public function Virtual void  
Public function Virtual UE::Dataflow::FPin

AddPin ()

  
Public function Virtual TArray< UE::Dataflow::FPin >

AddPins ()

 Override this function to add the AddOptionPin functionality to the node's context menu.
Public function T *

AsType ()

  
Public function Const const T *

AsType ()

  
Public function Virtual Const bool Override this function to add the AddOptionPin functionality to the node's context menu.
Public function Virtual Const bool Override this function to add the RemoveOptionPin functionality to the node's context menu.
Public function void  
Public function void  
Public function void

CopyNodeProperties ( const TSharedPtr< FDataflowNode > CopyFromDataflowNode
)

 Copy node property values from another node
Public function Virtual Const void Evaluation
Public function FDataflowInput * This version can find array inputs if only the Reference is supplied by searching through all inputs
Public function Const const FDataflowInput *

FindInput ( FName Name
)

  
Public function Const const FDataflowInput *  
Public function FDataflowInput *

FindInput ( FName Name
)

  
Public function Const const FDataflowInput *

FindInput ( const FGuid& InGuid
)

  
Public function FDataflowInput *  
Public function Const const FDataflowInput * This version can find array inputs if only the Reference is supplied by searching through all inputs
Public function FDataflowInput &

FindOrRegisterInputArrayConnection ( const UE::Dataflow::TConnectionReference< T >& Reference,
const FName& ElementPropertyName,
const FName& ArrayPropertyName
)

  
Public function Const const FDataflowOutput *  
Public function FDataflowOutput *

FindOutput ( uint32 GuidHash
)

  
Public function Const const FDataflowOutput *

FindOutput ( const FGuid& InGuid
)

  
Public function FDataflowOutput *  
Public function FDataflowOutput *  
Public function Const const FDataflowOutput *

FindOutput ( FName Name
)

  
Public function FDataflowOutput *

FindOutput ( FName Name
)

  
Public function Const const FDataflowOutput *

FindOutput ( uint32 GuidHash
)

  
Public function Const const FDataflowOutput *  
Public function Const void ForwardInput(...)
Public function Virtual Const FName  
Public function Virtual Const FName  
Public function Const FGuid

GetGuid ()

  
Public function Const TArray< FDataflowInput * >  
Public function Const FName

GetName ()

  
Public function Const int32  
Public function FOnNodeInvalidated &  
Public function Const TArray< FDataflowOutput * >  
Public function Const FText

GetPinDisplayName ( const FName& PropertyName,
const UE::Dataflow::FPin::EDirection Direction
)

  
Public function Const TArray< FString >

GetPinMetaData ( const FName& PropertyName,
const UE::Dataflow::FPin::EDirection Direction
)

  
Public function Const TArray< UE::Dataflow::FPin >

GetPins ()

 Connections
Public function Virtual Const TArray< UE::Dataflow::FPin > Override this function to add the RemoveOptionPin functionality to the node's context menu.
Public function Const FString

GetPinToolTip ( const FName& PropertyName,
const UE::Dataflow::FPin::EDirection Direction
)

  
Public function Virtual Const UE::Dataflow::FPin  
Public function Const uint32

GetPropertyOffset ( const FName& PropertyFullName
)

 Return a property's byte offset from the dataflow base node address using the full property name (must includes its parent struct property names).
Public function Virtual Const TArray< UE::Dataflow::FRenderingParameter >  
Public function Virtual Const FString

GetTags ()

  
Public function Const UE::Dataflow::FTimestamp  
Public function Virtual Const FString  
Public function Virtual Const FName

GetType ()

  
Public function Const const T & GetValue(...)
Public function Const const T &

GetValue ( UE::Dataflow::FContext& Context,
const T* Reference,
const T& Default
)

  
Public function Const const T &

GetValue ( UE::Dataflow::FContext& Context,
const UE::Dataflow::TConnectionReference< T >& Reference,
const T& Default
)

 GetValue(...)
Public function Const TAnyType::FStorageType

GetValue ( UE::Dataflow::FContext& Context,
const TAnyType* Reference
)

  
Public function Const TAnyType::FStorageType

GetValue ( UE::Dataflow::FContext& Context,
const UE::Dataflow::TConnectionReference< TAnyType >& Reference
)

  
Public function Const const T &

GetValue ( UE::Dataflow::FContext& Context,
const T* Reference
)

  
Public function uint32  
Public function Const TFuture< const T & >

GetValueParallel ( UE::Dataflow::FContext& Context,
const T* Reference
)

  
Public function Const TFuture< const T & >  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

InputSupportsType ( FName Name,
FName Type
)

  
Public function void

Invalidate ( const UE::Dataflow::FTimestamp& ModifiedTimestamp
)

  
Public function Virtual Const bool

IsA ( FName InType
)

  
Public function Const bool

IsConnected ( const T* Reference
)

  
Public function Const bool IsConnected(...)Checks if Reference input is connected.
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual FStructOnScope *  
Public function Const TUniquePtr< const FStructOnScope >  
Public function void Only used when forcing types on connection in order to make sure the node properly refreshes the rest of its connection accordingly if there's any dependencies between their types.
Public function Const int  
Protected function Virtual bool  
Public function Virtual void  
Protected function Virtual bool  
Public function Virtual void Override this to update any bookkeeping when a pin is being removed.
Public function Const bool

OutputSupportsType ( FName Name,
FName Type
)

  
Public function void  
Public function Virtual void

PostSerialize ( const FArchive& Ar
)

 Override this method to provide custom post-serialization for this node.
Public function Virtual FDataflowInput *

RedirectSerializedInput ( const FName& MissingInputName
)

 Override this method to provide custom reconnections when a node inputs has been deprecated and removed.
Public function Virtual FDataflowOutput *

RedirectSerializedOutput ( const FName& MissingOutputName
)

 Override this method to provide custom reconnections when a node outputs has been deprecated and removed.
Public function FDataflowInput &

RegisterInputArrayConnection ( const UE::Dataflow::TConnectionReference< T >& Reference,
const FName& ElementPropertyName,
const FName& ArrayPropertyName
)

  
Protected function FDataflowInput &

RegisterInputArrayConnectionInternal ( const UE::Dataflow::FConnectionReference& Reference,
const FName& ElementPropertyName,
const FName& ArrayPropertyName
)

  
Public function FDataflowInput &

RegisterInputConnection ( const T* Reference,
const FName& PropertyName
)

  
Public function FDataflowInput &

RegisterInputConnection ( const UE::Dataflow::TConnectionReference< T >& Reference,
const FName& PropertyName
)

 Register the Input and Outputs after the creation in the factory.
Protected function FDataflowInput &  
Public function FDataflowOutput &

RegisterOutputConnection ( const T* Reference,
const T* Passthrough,
const FName& PropertyName,
const FName& PassthroughName
)

  
Public function FDataflowOutput &

RegisterOutputConnection ( const T* Reference,
const T* Passthrough,
const FName& PropertyName
)

  
Public function FDataflowOutput &

RegisterOutputConnection ( const UE::Dataflow::TConnectionReference< T >& Reference,
const UE::Dataflow::TConnectionReference< T >& Passthrough,
const FName& PropertyName
)

  
Protected function FDataflowOutput &  
Public function Virtual UE::Dataflow::FPin  
Public function void  
Public function Const void

SafeForwardInput ( UE::Dataflow::FContext& Context,
const UE::Dataflow::FConnectionReference& InputReference,
const T* Reference
)

 SafeForwardInput(...)
Public function Virtual void Override this method to provide custom serialization for this node.
Public function Virtual void Struct Support
Protected function bool Returns true if any of the types was changed successfully
Protected function bool  
Protected function bool Returns true if the input type was changed successfully
Public function void

SetName ( FName InName
)

  
Protected function bool  
Protected function bool

SetOutputConcreteType ( const UE::Dataflow::FConnectionReference& OutputReference,
FName NewType
)

 Returns true if the output type was changed successfully
Public function Const void

SetValue ( UE::Dataflow::FContext& Context,
const typename TAnyType::FStorageType& Value,
const TAnyType* Reference
)

  
Public function Const void

SetValue ( UE::Dataflow::FContext& Context,
T&& Value,
const typename TDecay< T >::Type* Reference
)

 SetValue(...)
Public function Static FName  
Public function bool Returns true if the type was changed successfully only unset datatype connection will be set a new type
Public function Virtual Const const UScriptStruct *  
Public function void Unregister the input connection if one exists matching this property, and then invalidate the graph.
Public function void

UnregisterInputConnection ( const void* Reference,
const FName& PropertyName
)

  
Public function void  
Public function void Unregister the connection if one exists matching this pin, then invalidate the graph.
Public function Virtual bool  
Public function Virtual void  

Operators

  Type Name Description
Public function FDataflowNode & Warning: FDataflowNodes aren't actually safe to copy/move yet.

Typedefs

Name Description
FOnNodeInvalidated  

Constants

Name Description
DataflowInput  
DataflowIntrinsic  
DataflowOutput  
DataflowPassthrough  
DefaultNodeBodyTintColor  
DefaultNodeTitleColor  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page