1. Epic GamesDeveloper
  3. FGraph

FGraph

TODO:

API > API/Plugins > API/Plugins/GeometryFlowCore

TODO:

  • internal FNode pointers can be unique ptr?
  • parallel evaluation at graph level (pre-pass to collect references?)
   
Name FGraph
Type class
Header File /Engine/Plugins/Experimental/GeometryFlow/Source/GeometryFlowCore/Public/GeometryFlowGraph.h
Include Path #include "GeometryFlowGraph.h"

Syntax

class FGraph

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

~FGraph()

   GeometryFlowGraph.h  

Structs

Name Remarks
FConnection  
FHandle  
FNodeInfo  

Enums

Protected

Name Remarks
ENodeAddResult  

Constants

Name Type Remarks Include Path
SerializationVersion float Version used in serialization GeometryFlowGraph.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

EGeometryFlowResult AddConnection ( FHandle FromNode,
FString FromOutput,
FHandle ToNode,
FString ToInput
)

   GeometryFlowGraph.h  

FHandle AddNodeOfType ( const FName TypeName,
const FString& Identifier,
ENodeCachingStrategy CachingStrategy
)

 Add a node of specified type to the graph. An invalid FHandle will be returned if failed (e.g. node type not registered) GeometryFlowGraph.h  

FHandle AddNodeOfType ( const FString& Identifier,
ENodeCachingStrategy CachingStrategy
)

 Add a node of specified type to the graph. An invalid FHandle will be returned if failed (e.g. node type not registered) GeometryFlowGraph.h  

EGeometryFlowResult ApplyToNode ( FHandle NodeHandle,
TFunctionRef< void(FNode&)> ApplyFunc
)

 Applies the functor to the node as FNode. GeometryFlowGraph.h  

EGeometryFlowResult ApplyToNodeOfType ( FHandle NodeHandle,
TFunctionRef< void(NodeType&)> ApplyFunc
)

 Applies the functor to the node as derived type if possible. GeometryFlowGraph.h  

EGeometryFlowResult CanAddConnection ( FHandle FromNode,
FString FromOutput,
FHandle ToNode,
FString ToInput
) const

 Returns EGeometryFlowResult::Ok if the Connection can be added, otherwise returns the reason for failure GeometryFlowGraph.h  
Return @false if the node type is not registered GeometryFlowGraph.h  

bool CanEvaluate ( FHandle Node,
FString OutputName
)

   GeometryFlowGraph.h  

void ConfigureCachingStrategy ( ENodeCachingStrategy NewStrategy
)

   GeometryFlowGraph.h  

FString DebugDumpGraph ( TFunction< bool(TSafeSharedPtr< FNode >)> IncludeNodeFn
) const

   GeometryFlowGraph.h  

EGeometryFlowResult EvaluateResult ( FHandle Node,
FString OutputName,
T& Storage,
int32 StorageTypeIdentifier,
TUniquePtr< FEvaluationInfo >& EvaluationInfo,
bool bTryTakeResult
)

   GeometryFlowGraph.h  

EGeometryFlowResult FindInputConnections ( FHandle ToNode,
TArray< FGraph::FConnection >& ConnectionsOut
) const

 Find all the input connections for the specified node. GeometryFlowGraph.h  

EGeometryFlowResult GetInputTypeForNode ( FHandle NodeHandle,
FString InputName,
int32& Type
) const

   GeometryFlowGraph.h  

TSet< FHandle > GetNodesWithNoConnectedInputs()

   GeometryFlowGraph.h  

EGeometryFlowResult GetOutputTypeForNode ( FHandle NodeHandle,
FString OutputName,
int32& Type
) const

   GeometryFlowGraph.h  

TSet< FHandle > GetSourceNodes()

   GeometryFlowGraph.h  

float GetVersionID()

   GeometryFlowGraph.h  

EGeometryFlowResult InferConnection ( FHandle FromNode,
FHandle ToNode
)

   GeometryFlowGraph.h  

bool IsDependent ( FHandle DependentNode,
FHandle IndependentNode
) const

 Returns true if DependentNode is dependent on IndependentNode in the graph. GeometryFlowGraph.h  

EGeometryFlowResult RemoveConnectionForInput ( FHandle ToNode,
FString ToInput
)

   GeometryFlowGraph.h  

void RemoveNode ( const FHandle Handle
)

 Note: once removed, any external handles to this node will be stale. GeometryFlowGraph.h  

void RemoveNodeConnections ( FHandle NodeHandle
)

 Remove all connections to the specified node. GeometryFlowGraph.h  

void RemoveNodeInputConnections ( FHandle NodeHandle
)

 Remove input connections to the specifed node GeometryFlowGraph.h  

void RemoveNodeOutputConnections ( FHandle NodeHandle
)

 Remove all output connections to the specified node. GeometryFlowGraph.h  

void Serialize ( FArchive& Ar
)

 Serialize this graph to an archive. GeometryFlowGraph.h  

EGeometryFlowResult SetNodeCachingStrategy ( FHandle NodeHandle,
ENodeCachingStrategy Strategy
)

   GeometryFlowGraph.h  

Protected

Name Remarks Include Path Unreal Specifiers

ENodeAddResult AddNodeOfType ( const FName TypeName,
const FHandle Handle,
const FString& Identifier,
ENodeCachingStrategy CachingStrategy
)

   GeometryFlowGraph.h  

bool CanAddNodeOfType ( const FName TypeName
)

   GeometryFlowGraph.h  

bool CanComputeOutput ( FHandle Node,
FString OutputName
)

 Retrun @true if all the graph connections needed for this computation exist GeometryFlowGraph.h  

TSafeSharedPtr< IData > ComputeOutputData ( FHandle Node,
FString OutputName,
TUniquePtr< FEvaluationInfo >& EvaluationInfo,
bool bStealOutputData
)

   GeometryFlowGraph.h  

int32 CountOutputConnections ( FHandle FromNode,
const FString& FromOutput
) const

   GeometryFlowGraph.h  

EGeometryFlowResult EvaluateResultInternal ( FHandle Node,
FString OutputName,
T& Storage,
int32 StorageTypeIdentifier,
TUniquePtr< FEvaluationInfo >& EvaluationInfo,
bool bTryTakeResult
)

   GeometryFlowGraph.h  

EGeometryFlowResult FindConnectionForInput ( FHandle ToNode,
FString ToInput,
FConnection& ConnectionOut
) const

   GeometryFlowGraph.h  

TSafeSharedPtr< FNode > FindNode ( FHandle Handle
) const

   GeometryFlowGraph.h  

TSafeSharedPtr< FRWLock > FindNodeLock ( FHandle Handle
) const

   GeometryFlowGraph.h  

ENodeCachingStrategy GetCachingStrategyForNode ( FHandle NodeHandle
) const

   GeometryFlowGraph.h  

bool IsInCycle ( FHandle NodeHandle
)

   GeometryFlowGraph.h  

bool VistDependencies ( FHandle NodeHandle,
TFunctionRef< bool(FGraph::FHandle)> Vistor
) const

 Visits upstream dependencies for the specified node and calls the Visitor functor (in parallel) on each. GeometryFlowGraph.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page