UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDataflowInput Struct Reference

#include <DataflowInputOutput.h>

+ Inheritance diagram for FDataflowInput:

Public Member Functions

DATAFLOWCORE_API FDataflowInput (const UE::Dataflow::FInputParameters &Param, FGuid InGuid)
 
DATAFLOWCORE_API FDataflowInput (const UE::Dataflow::FInputParameters &Param={})
 
virtual bool IsConnected () const override
 
virtual bool AddConnection (FDataflowConnection *InOutput) override
 
virtual bool RemoveConnection (FDataflowConnection *InOutput) override
 
virtual void GetConnections (TArray< FDataflowConnection * > &OutConnections) const override
 
FDataflowOutputGetConnection ()
 
const FDataflowOutputGetConnection () const
 
bool HasAnyConnections () const
 
virtual TArray< FDataflowOutput * > GetConnectedOutputs ()
 
virtual const TArray< const FDataflowOutput * > GetConnectedOutputs () const
 
template<class T >
const T & GetValue (UE::Dataflow::FContext &Context, const T &Default) const
 
template<typename TAnyType UE_REQUIRES>
TAnyType::FStorageType GetValueFromAnyType (UE::Dataflow::FContext &Context, const typename TAnyType::FStorageType &Default) const
 
template<typename TAnyType UE_REQUIRES>
UE::Dataflow::FContextValue GetValueFromAnyType (UE::Dataflow::FContext &Context) const
 
DATAFLOWCORE_API void PullValue (UE::Dataflow::FContext &Context) const
 
template<class T >
TFuture< const T & > GetValueParallel (UE::Dataflow::FContext &Context, const T &Default) const
 
virtual void Invalidate (const UE::Dataflow::FTimestamp &ModifiedTimestamp=UE::Dataflow::FTimestamp::Current()) override
 
bool IsRequired () const
 
void SetIsRequired (const bool bInIsRequired)
 
- Public Member Functions inherited from FDataflowConnection
 FDataflowConnection ()
 
DATAFLOWCORE_API FDataflowConnection (UE::Dataflow::FPin::EDirection Direction, FName InType, FName InName, FDataflowNode *OwningNode=nullptr, const FProperty *InProperty=nullptr, FGuid InGuid=FGuid::NewGuid())
 
DATAFLOWCORE_API FDataflowConnection (UE::Dataflow::FPin::EDirection Direction, const UE::Dataflow::FConnectionParameters &Params)
 
virtual ~FDataflowConnection ()
 
FDataflowNodeGetOwningNode ()
 
const FDataflowNodeGetOwningNode () const
 
DATAFLOWCORE_API FGuid GetOwningNodeGuid () const
 
DATAFLOWCORE_API uint32 GetOwningNodeValueHash () const
 
DATAFLOWCORE_API UE::Dataflow::FTimestamp GetOwningNodeTimestamp () const
 
const FPropertyGetProperty () const
 
DATAFLOWCORE_API FString GetPropertyTooltip () const
 
DATAFLOWCORE_API FString GetPropertyTypeNameTooltip () const
 
UE::Dataflow::FPin::EDirection GetDirection () const
 
uint32 GetOffset () const
 
virtual int32 GetContainerIndex () const
 
virtual uint32 GetContainerElementOffset () const
 
UE::Dataflow::FConnectionKey GetConnectionKey () const
 
DATAFLOWCORE_API bool SetConcreteType (FName InType)
 
void LockType ()
 
void UnlockType ()
 
bool IsTypeLocked () const
 
FName GetType () const
 
FName GetOriginalType () const
 
template<typename T >
bool IsType () const
 
FGuid GetGuid () const
 
void SetGuid (FGuid InGuid)
 
FName GetName () const
 
void SetName (FName InName)
 
virtual voidRealAddress () const
 
UE::Dataflow::FContextCacheKey CacheKey () const
 
DATAFLOWCORE_API bool IsSafeToTryChangingType () const
 
bool IsAnyType () const
 
bool HasConcreteType () const
 
DATAFLOWCORE_API void SetTypePolicy (IDataflowTypePolicy *InTypePolicy)
 
DATAFLOWCORE_API bool SupportsType (FName InType) const
 
DATAFLOWCORE_API FDataflowConnectionSetTypeDependencyGroup (FName DependencyGroupName)
 
FName GetTypeDependencyGroup () const
 
DATAFLOWCORE_API bool IsAnytypeDependencyConnected () const
 
template<class T >
bool IsA (const T *InVar) const
 
bool GetCanHidePin () const
 
bool GetPinIsHidden () const
 
FDataflowConnectionSetCanHidePin (bool bInCanHidePin)
 
FDataflowConnectionSetPinIsHidden (bool bInPinIsHidden)
 

Public Attributes

FDataflowOutputConnection = nullptr
 

Static Public Attributes

static FDataflowInput NoOpInput = FDataflowInput()
 

Protected Member Functions

virtual void FixAndPropagateType (FName InType) override
 
- Protected Member Functions inherited from FDataflowConnection
DATAFLOWCORE_API void SetTypeInternal (FName NewType)
 
DATAFLOWCORE_API bool IsOwningNodeEnabled () const
 
DATAFLOWCORE_API void SetAsAnyType (bool bAnyType, const FName &ConcreteType)
 
DATAFLOWCORE_API void ForceSimpleType (FName InType)
 
DATAFLOWCORE_API void FixAndPropagateType ()
 
DATAFLOWCORE_API bool IsExtendedType (FName InType) const
 
DATAFLOWCORE_API bool ResetToOriginalType ()
 
DATAFLOWCORE_API void Rename (FName NewName)
 
DATAFLOWCORE_API void ForceTypeDependencyGroup (FName InTypeDependencyGroup)
 

Friends

struct FDataflowConnection
 
struct FDataflowOutput
 

Additional Inherited Members

- Static Public Member Functions inherited from FDataflowConnection
static DATAFLOWCORE_API bool IsAnyType (const FName &InType)
 
static DATAFLOWCORE_API FName GetTypeNameFromProperty (const FProperty *Property)
 
- Protected Attributes inherited from FDataflowConnection
FDataflowNodeOwningNode = nullptr
 
const FPropertyProperty = nullptr
 
FGuid Guid
 
IDataflowTypePolicyTypePolicy = nullptr
 
uint32 Offset
 
UE::Dataflow::FPin::EDirection Direction
 
bool bIsAnyType:1 = false
 
bool bHasConcreteType: 1 = false
 
bool bCanHidePin:1 = false
 
bool bPinIsHidden:1 = false
 

Constructor & Destructor Documentation

◆ FDataflowInput() [1/2]

FDataflowInput::FDataflowInput ( const UE::Dataflow::FInputParameters Param,
FGuid  InGuid 
)

◆ FDataflowInput() [2/2]

FDataflowInput::FDataflowInput ( const UE::Dataflow::FInputParameters Param = {})

Member Function Documentation

◆ AddConnection()

bool FDataflowInput::AddConnection ( FDataflowConnection InOutput)
overridevirtual

Reimplemented from FDataflowConnection.

◆ FixAndPropagateType()

void FDataflowInput::FixAndPropagateType ( FName  InType)
overrideprotectedvirtual

Reimplemented from FDataflowConnection.

◆ GetConnectedOutputs() [1/2]

TArray< FDataflowOutput * > FDataflowInput::GetConnectedOutputs ( )
virtual

◆ GetConnectedOutputs() [2/2]

const TArray< const FDataflowOutput * > FDataflowInput::GetConnectedOutputs ( ) const
virtual

◆ GetConnection() [1/2]

FDataflowOutput * FDataflowInput::GetConnection ( )
inline

◆ GetConnection() [2/2]

const FDataflowOutput * FDataflowInput::GetConnection ( ) const
inline

◆ GetConnections()

void FDataflowInput::GetConnections ( TArray< FDataflowConnection * > &  OutConnections) const
overridevirtual

Reimplemented from FDataflowConnection.

◆ GetValue()

template<typename T >
const T & FDataflowInput::GetValue ( UE::Dataflow::FContext Context,
const T &  Default 
) const

Get the value of this input by evaluating the value of the connected output

Returns
the typed value of the input

◆ GetValueFromAnyType() [1/2]

template<typename TAnyType UE_REQUIRES>
UE::Dataflow::FContextValue FDataflowInput::GetValueFromAnyType ( UE::Dataflow::FContext Context) const

◆ GetValueFromAnyType() [2/2]

template<typename TAnyType UE_REQUIRES>
TAnyType::FStorageType FDataflowInput::GetValueFromAnyType ( UE::Dataflow::FContext Context,
const typename TAnyType::FStorageType &  Default 
) const

◆ GetValueParallel()

template<class T >
TFuture< const T & > FDataflowInput::GetValueParallel ( UE::Dataflow::FContext Context,
const T &  Default 
) const

◆ HasAnyConnections()

bool FDataflowInput::HasAnyConnections ( ) const
inline

◆ Invalidate()

void FDataflowInput::Invalidate ( const UE::Dataflow::FTimestamp ModifiedTimestamp = UE::Dataflow::FTimestamp::Current())
overridevirtual

Reimplemented from FDataflowConnection.

◆ IsConnected()

bool FDataflowInput::IsConnected ( ) const
overridevirtual

Reimplemented from FDataflowConnection.

◆ IsRequired()

bool FDataflowInput::IsRequired ( ) const
inline

◆ PullValue()

void FDataflowInput::PullValue ( UE::Dataflow::FContext Context) const

pull the value from the upstream connections the upstream graph is evaluated if necessary and values are cached along the way

◆ RemoveConnection()

bool FDataflowInput::RemoveConnection ( FDataflowConnection InOutput)
overridevirtual

Reimplemented from FDataflowConnection.

◆ SetIsRequired()

void FDataflowInput::SetIsRequired ( const bool  bInIsRequired)
inline

Friends And Related Symbol Documentation

◆ FDataflowConnection

◆ FDataflowOutput

Member Data Documentation

◆ Connection

FDataflowOutput* FDataflowInput::Connection = nullptr

◆ NoOpInput

FDataflowInput FDataflowInput::NoOpInput = FDataflowInput()
static

The documentation for this struct was generated from the following files: