1. Epic GamesDeveloper
  3. UOptimusNodeGraph

UOptimusNodeGraph

API > API/Plugins > API/Plugins/OptimusCore

   
Name UOptimusNodeGraph
Type class
Header File /Engine/Plugins/Animation/DeformerGraph/Source/OptimusCore/Public/OptimusNodeGraph.h
Include Path #include "OptimusNodeGraph.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UOptimusNodeGraph :  
    public UObject ,  
    public IOptimusNodeGraphCollectionOwner

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constants

Name Type Remarks Include Path
DefaultSubGraphName const FName   OptimusNodeGraph.h
DefaultSubGraphRefNodeName const FName   OptimusNodeGraph.h
LibraryRoot const TCHAR *   OptimusNodeGraph.h
SetupGraphName const FName Reserved names. OptimusNodeGraph.h
UpdateGraphName const FName   OptimusNodeGraph.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
GraphNotifyDelegate FOptimusGraphNotifyDelegate   OptimusNodeGraph.h  
Links TArray< TObjectPtr< UOptimusNodeLink > > FIXME: Use a map. OptimusNodeGraph.h
  • NonTransactional
NodePairs TArray< TObjectPtr< UOptimusNodePair > >   OptimusNodeGraph.h
  • NonTransactional
Nodes TArray< TObjectPtr< UOptimusNode > >   OptimusNodeGraph.h
  • NonTransactional
SubGraphs TArray< TObjectPtr< UOptimusNodeGraph > >   OptimusNodeGraph.h
  • NonTransactional

Functions

Public

Name Remarks Include Path Unreal Specifiers

UOptimusNode * AddCommentNode ( const FVector2D& InPosition,
const FVector2D& InSize,
const FLinearColor& InColor
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddCommentNode ( const FVector2D& InPosition,
const FVector2D& InSize,
const FLinearColor& InColor,
bool bCreatedFromUI
)

   OptimusNodeGraph.h  

UOptimusNode * AddComponentBindingGetNode ( UOptimusComponentSourceBinding* InComponentBinding,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddDataInterfaceNode ( const TSubclassOf< UOptimusComputeDataInterface > InDataInterfaceClass,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddFunctionReferenceNode ( UOptimusFunctionNodeGraph* InFunctionGraph,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool AddLink ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

TArray< UOptimusNode * > AddLoopTerminalNodes ( const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddNode ( const TSubclassOf< UOptimusNode > InNodeClass,
const FVector2D& InPosition
)

 TODO: Add magic connection from a pin. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddResourceGetNode ( UOptimusResourceDescription* InResourceDesc,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddResourceNode ( UOptimusResourceDescription* InResourceDesc,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddResourceSetNode ( UOptimusResourceDescription* InResourceDesc,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddValueNode ( FOptimusDataTypeRef InDataTypeRef,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * AddVariableGetNode ( UOptimusVariableDescription* InVariableDesc,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph
Take a set of nodes and collapse them into a single function, replacing the given nodes with the new function node and returning it. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusNode * CollapseNodesToSubGraph ( const TArray< UOptimusNode* >& InNodes
)

 Take a set of nodes and collapse them into a subgraph, replacing the given nodes with a new subgraph node and returning it. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool ConnectAdderPin ( IOptimusNodeAdderPinProvider* InTargetNode,
const IOptimusNodeAdderPinProvider::FAdderPinAction& InSelectedAction,
UOptimusNodePin* InSourcePin
)

 Add a new pin to the target node with the type of source pin and connect the source pin to the new pin OptimusNodeGraph.h  
Node Packaging. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph
Takes a kernel function and unpackages to a custom kernel. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool ConvertToFunction ( UOptimusNode* InSubGraphNode
)

 Take a subgraph node convert it to a function in-place OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool ConvertToSubGraph ( UOptimusNode* InFunctionNode
)

 Take a function node convert it to a subgraph node in-place OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool DoesLinkFormCycle ( const UOptimusNode* InOutputNode,
const UOptimusNode* InInputNode
) const

 Check to see if connecting these two nodes will form a graph cycle. OptimusNodeGraph.h  

bool DoesNodeHaveMutableInput ( const UOptimusNode* InNode,
const FOptimusPinTraversalContext& InContext
) const

 Check if a Node has mutable input pins OptimusNodeGraph.h  

UOptimusNode * DuplicateNode ( UOptimusNode* InNode,
const FVector2D& InPosition
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool DuplicateNodes ( const TArray< UOptimusNode* >& InNodes,
const FVector2D& InPosition
)

 Duplicate a collection of nodes from the same graph, using the InPosition position to be the top-left origin of the pasted nodes. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool DuplicateNodes ( const TArray< UOptimusNode* >& InNodes,
const FVector2D& InPosition,
const FString& InActionName
)

   OptimusNodeGraph.h  

TArray< UOptimusNode * > ExpandCollapsedNodes ( UOptimusNode* InGraphReferenceNode
)

 Take a function or subgraph node and expand it in-place, replacing the given function node. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

UOptimusActionStack * GetActionStack()

   OptimusNodeGraph.h  

const TArray< UOptimusNodeLink * > & GetAllLinks()

   OptimusNodeGraph.h  

const TArray< UOptimusNodePair * > & GetAllNodePairs()

   OptimusNodeGraph.h  

const TArray< UOptimusNode * > & GetAllNodes()

   OptimusNodeGraph.h  
Get all unique component bindings that lead to this pin. OptimusNodeGraph.h  

TArray< UOptimusNodePin * > GetConnectedPins ( const UOptimusNodePin* InNodePin
) const

 Returns all pins that have a direct connection to this pin. OptimusNodeGraph.h  
  OptimusNodeGraph.h  
See UOptimusNodePin::GetConnectedRoutedPins for information on what this function does. OptimusNodeGraph.h  

int32 GetGraphIndex()

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

EOptimusNodeGraphType GetGraphType()

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

TSet< FOptimusRoutedConstNode > GetLoopEntryTerminalForNode ( const UOptimusNode* InNode,
const FOptimusPinTraversalContext& InContext
) const

 Gather connected loop entry terminals OptimusNodeGraph.h  

TSet< FOptimusRoutedConstNode > GetLoopEntryTerminalForPin ( const UOptimusNodePin* InNodePin,
const FOptimusPinTraversalContext& InContext
) const

 Gather connected loop entry terminals OptimusNodeGraph.h  

UOptimusNode * GetNodeCounterpart ( const UOptimusNode* InNode
) const

 Returns the paired node for the given IOptimusNodePairProvider OptimusNodeGraph.h  

UOptimusNodePair * GetNodePair ( const UOptimusNode* InNode
) const

 Returns the node pair given a IOptimusNodePairProvider OptimusNodeGraph.h  

FOptimusGraphNotifyDelegate & GetNotifyDelegate()

 Returns the modify event object that can listened to in case there are changes to the graph that need to be reacted to. OptimusNodeGraph.h  

UOptimusNodeGraph * GetParentGraph()

   OptimusNodeGraph.h  

TArray< const UOptimusNodeLink * > GetPinLinks ( const UOptimusNodePin* InNodePin
) const

   OptimusNodeGraph.h  

bool GetViewLocationAndZoom ( FVector2D& OutViewLocation,
float& OutViewZoom
) const

 Returns the graph view location and zoom, if set. OptimusNodeGraph.h  

bool IsCustomKernel ( UOptimusNode* InNode
) const

 Returns true if the node in question is a custom kernel node that can be converted to a kernel function with ConvertCustomKernelToFunction. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool IsExecutionGraph()

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool IsFunctionGraph()

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool IsFunctionReference ( UOptimusNode* InNode
) const

 Returns true if the node in question is a function reference node that can be expanded into a group of nodes using ExpandFunctionToNodes. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool IsKernelFunction ( UOptimusNode* InNode
) const

 Returns true if the node in question is a kernel function node that can be converted to a custom kernel using ConvertFunctionToCustomKernel. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool IsPinMutable ( const UOptimusNodePin* InNodePin,
const FOptimusPinTraversalContext& InContext
) const

 Check if a pin represents time varying data OptimusNodeGraph.h  

bool IsReadOnly()

   OptimusNodeGraph.h  

bool IsSubGraphReference ( UOptimusNode* InNode
) const

 Returns true if the node in question is a function sub-graph node that can be expanded into a group of nodes using ExpandFunctionToNodes. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool RemoveAllLinks ( UOptimusNodePin* InNodePin
)

 Removes all links to the given pin, whether it's an input or an output pin. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool RemoveLink ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

 Removes a single link between two nodes. FIXME: Use UOptimusNodeLink instead. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool RemoveNode ( UOptimusNode* InNode
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

bool RemoveNodes ( const TArray< UOptimusNode* >& InNodes
)

   OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

int32 RemoveNodesAndCount ( const TArray< UOptimusNode* >& InNodes
)

   OptimusNodeGraph.h  

void SetViewLocationAndZoom ( const FVector2D& InViewLocation,
float InViewZoom
)

 Set the graph view location and zoom, to ensure that the view location is stored between sessions and graph switching. OptimusNodeGraph.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

 Check if the duplication took place at the asset level if so, we have to recreate all constant/attribute nodes such that their class pointers don't point to classes in the source asset. OptimusNodeGraph.h  

virtual void PostLoad()

   OptimusNodeGraph.h  

Overridden from IOptimusNodeGraphCollectionOwner

Name Remarks Include Path Unreal Specifiers

virtual bool AddGraphDirect ( UOptimusNodeGraph* InGraph,
int32 InInsertBefore
)

 Takes an existing graph and adds it to this graph collection. If the graph cannot be added, the object remains unchanged and this function returns false. OptimusNodeGraph.h  

virtual UOptimusNodeGraph * CreateGraphDirect ( EOptimusNodeGraphType InType,
FName InName,
TOptional< int32 > InInsertBefore
)

 Create a new graph of a given type, with an optional name. OptimusNodeGraph.h  

virtual UOptimusNodeGraph * FindGraphByName ( FName InGraphName
) const

   OptimusNodeGraph.h  

virtual IOptimusNodeGraphCollectionOwner * GetCollectionOwner()

 IOptimusNodeGraphCollectionOwner overrides. OptimusNodeGraph.h  

virtual FString GetCollectionPath()

 Returns the path to this graph collection owner. OptimusNodeGraph.h  

virtual IOptimusNodeGraphCollectionOwner * GetCollectionRoot()

 Returns root collection that owns all the collections OptimusNodeGraph.h  

virtual const TArray< UOptimusNodeGraph * > & GetGraphs()

 Returns all immediately owned node graphs. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

virtual bool MoveGraphDirect ( UOptimusNodeGraph* InGraph,
int32 InInsertBefore
)

 Re-order the graph relative to the other graphs. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

virtual bool RemoveGraphDirect ( UOptimusNodeGraph* InGraph,
bool bDeleteGraph
)

 Remove the given graph. OptimusNodeGraph.h  

virtual bool RenameGraph ( UOptimusNodeGraph* InGraph,
const FString& InNewName
)

 Rename the given graph, subject to validation of the name. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

virtual bool RenameGraphDirect ( UOptimusNodeGraph* InGraph,
const FString& InNewName
)

 Rename the given graph, subject to validation of the name. OptimusNodeGraph.h
  • BlueprintCallable
  • Category=OptimusNodeGraph

Protected

Name Remarks Include Path Unreal Specifiers

bool AddLinkDirect ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

   OptimusNodeGraph.h  

bool AddNodeDirect ( UOptimusNode* InNode
)

   OptimusNodeGraph.h  

bool AddNodePairDirect ( UOptimusNode* InFirstNode,
UOptimusNode* InSecondNode
)

   OptimusNodeGraph.h  

UOptimusNode * CreateNodeDirect ( const UClass* InNodeClass,
FName InName,
TFunction< bool(UOptimusNode*)> InConfigureNodeFunc
)

 Direct edit functions. Used by the actions. OptimusNodeGraph.h  

void GlobalNotify ( EOptimusGlobalNotifyType InNotifyType,
UObject* InSubject
) const

   OptimusNodeGraph.h  

void Notify ( EOptimusGraphNotifyType InNotifyType,
UObject* InSubject
) const

   OptimusNodeGraph.h  

bool RemoveAllLinksToNodeDirect ( UOptimusNode* InNode
)

   OptimusNodeGraph.h  

bool RemoveAllLinksToPinDirect ( UOptimusNodePin* InNodePin
)

   OptimusNodeGraph.h  

void RemoveGraph ( UOptimusNodeGraph* InNodeGraph
)

   OptimusNodeGraph.h  

bool RemoveLinkDirect ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

   OptimusNodeGraph.h  

bool RemoveNodeDirect ( UOptimusNode* InNode,
bool bFailIfLinks
)

 Remove a node directly. If a node still has connections this call will fail. OptimusNodeGraph.h  

bool RemoveNodePairDirect ( UOptimusNode* InFirstNode,
UOptimusNode* InSecondNode
)

   OptimusNodeGraph.h  

void SetGraphType ( EOptimusNodeGraphType InType
)

 FIXME: Remove this. OptimusNodeGraph.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString ConstructPath ( const FString& GraphPath,
const FString& NodeName,
const FString& PinPath
)

   OptimusNodeGraph.h  

static FString ConstructSubGraphPath ( const FString& InGraphOwnerPath,
const FString& InSubGraphName
)

   OptimusNodeGraph.h  

static bool DuplicateSubGraph ( UOptimusActionStack* InActionStack,
const FString& InGraphOwnerPath,
UOptimusNodeSubGraph* InSourceSubGraph,
FName InNewGraphName
)

   OptimusNodeGraph.h  

static void GatherRelatedObjects ( const TArray< UOptimusNode* >& InNodes,
TArray< UOptimusNode* >& OutNodes,
TArray< UOptimusNodePair* >& OutNodePairs,
TArray< UOptimusNodeSubGraph* >& OutSubGraphs
)

   OptimusNodeGraph.h  

static FString GetFunctionGraphCollectionPath ( const FString& InFunctionName
)

 Function Graphs are addressed in a special way. OptimusNodeGraph.h  

static bool IsValidUserGraphName ( const FString& InGraphName,
FText* OutFailureReason
)

 Verify if the given name is a valid graph name. OptimusNodeGraph.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page