1. Epic GamesDeveloper
  3. UOptimusNodeGraph

UOptimusNodeGraph

API > API/Plugins > API/Plugins/OptimusCore

Inheritance Hierarchy

References

   
Module OptimusCore
Header /Engine/Plugins/Animation/DeformerGraph/Source/OptimusCore/Public/OptimusNodeGraph.h
Include #include "OptimusNodeGraph.h"

Syntax

UCLASS&40;BlueprintType&41;  
class UOptimusNodeGraph :  
    public UObject,  
    public IOptimusNodeGraphCollectionOwner

Variables

  Type Name Description
Protected variable UProperty bool bViewLocationSet  
Protected variable UProperty Category BlueprintReadOnly visibleanywhere EOptimusNodeGraphType GraphType The type of graph this represents.
Protected variable UProperty FVector2D ViewLocation  
Protected variable UProperty float ViewZoom  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category UOptimusNode *

AddComponentBindingGetNode ( UOptimusComponentSourceBinding* InComponentBinding,
const FVector2D& InPosition
)

  
Public function UFunction BlueprintCallable, Category UOptimusNode *

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

  
Public function UFunction BlueprintCallable, Category bool

AddLink ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

  
Protected function bool

AddLinkDirect ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

  
Public function UFunction BlueprintCallable, Category UOptimusNode *

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

 TODO: Add magic connection from a pin.
Protected function bool  
Public function UFunction BlueprintCallable, Category UOptimusNode *

AddResourceGetNode ( UOptimusResourceDescription* InResourceDesc,
const FVector2D& InPosition
)

  
Public function UFunction BlueprintCallable, Category UOptimusNode *

AddResourceNode ( UOptimusResourceDescription* InResourceDesc,
const FVector2D& InPosition
)

  
Public function UFunction BlueprintCallable, Category UOptimusNode *

AddResourceSetNode ( UOptimusResourceDescription* InResourceDesc,
const FVector2D& InPosition
)

  
Public function UFunction BlueprintCallable, Category UOptimusNode *

AddValueNode ( FOptimusDataTypeRef InDataTypeRef,
const FVector2D& InPosition
)

  
Public function UFunction BlueprintCallable, Category UOptimusNode *

AddVariableGetNode ( UOptimusVariableDescription* InVariableDesc,
const FVector2D& InPosition
)

  
Public function UFunction BlueprintCallable, Category UOptimusNode * Take a set of nodes and collapse them into a single function, replacing the given nodes with the new function node and returning it.
Public function UFunction BlueprintCallable, Category UOptimusNode * Take a set of nodes and collapse them into a subgraph, replacing the given nodes with a new subgraph node and returning it.
Public function bool Add a new pin to the target node with the type of source pin and connect the source pin to the new pin
Public function UFunction BlueprintCallable, Category UOptimusNode * Node Packaging.
Public function UFunction BlueprintCallable, Category UOptimusNode * Takes a kernel function and unpackages to a custom kernel.
Protected function UOptimusNode *

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

 Direct edit functions. Used by the actions.
Public function Const bool

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

 Check to see if connecting these two nodes will form a graph cycle.
Public function UFunction BlueprintCallable, Category UOptimusNode *

DuplicateNode ( UOptimusNode* InNode,
const FVector2D& InPosition
)

  
Public function bool

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

  
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category TArray< UOptimusNode * >

ExpandCollapsedNodes ( UOptimusNode* InFunctionNode
)

 Take a function or subgraph node and expand it in-place, replacing the given function node.
Public function Const UOptimusActionStack *  
Public function Const const TArray< UOptimusNodeLink * > &  
Public function Const const TArray< UOptimusNode * > &  
Public function Const TSet< UOptimusComponentSourceBinding * > Get all unique component bindings that lead to this pin.
Public function Const TArray< UOptimusNodePin * >

GetConnectedPins ( const UOptimusNodePin* InNodePin
)

 Returns all pins that have a direct connection to this pin.
Public function Const TArray< FOptimusRoutedNodePin > See UOptimusNodePin::GetConnectedRoutedPins for information on what this function does.
Public function Const UFunction BlueprintCallable, Category int32  
Public function Const FString  
Public function Const UFunction BlueprintCallable, Category EOptimusNodeGraphType  
Public function FOptimusGraphNotifyDelegate & Returns the modify event object that can listened to in case there are changes to the graph that need to be reacted to.
Public function Const UOptimusNodeGraph *  
Public function Const TArray< const UOptimusNodeLink * >

GetPinLinks ( const UOptimusNodePin* InNodePin
)

  
Public function Const bool

GetViewLocationAndZoom ( FVector2D& OutViewLocation,
float& OutViewZoom
)

 Returns the graph view location and zoom, if set.
Protected function Const void

GlobalNotify ( EOptimusGlobalNotifyType InNotifyType,
UObject* InSubject
)

  
Public function Const UFunction BlueprintCallable, Category bool Returns true if the node in question is a custom kernel node that can be converted to a kernel function with ConvertCustomKernelToFunction.
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool  
Public function Const UFunction BlueprintCallable, Category bool Returns true if the node in question is a function reference node that can be expanded into a group of nodes using ExpandFunctionToNodes.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the node in question is a kernel function node that can be converted to a custom kernel using ConvertFunctionToCustomKernel.
Public function Const UFunction BlueprintCallable, Category bool Returns true if the node in question is a function sub-graph node that can be expanded into a group of nodes using ExpandFunctionToNodes.
Public function Static bool

IsValidUserGraphName ( const FString& InGraphName,
FText* OutFailureReason
)

 Verify if the given name is a valid graph name.
Protected function Const void

Notify ( EOptimusGraphNotifyType InNotifyType,
UObject* InSubject
)

  
Public function UFunction BlueprintCallable, Category bool Removes all links to the given pin, whether it's an input or an output pin.
Protected function bool  
Protected function bool  
Public function UFunction BlueprintCallable, Category bool

RemoveLink ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

 Removes a single link between two nodes. FIXME: Use UOptimusNodeLink instead.
Protected function bool

RemoveLinkDirect ( UOptimusNodePin* InNodeOutputPin,
UOptimusNodePin* InNodeInputPin
)

  
Public function UFunction BlueprintCallable, Category bool

RemoveNode ( UOptimusNode* InNode
)

  
Protected function bool

RemoveNodeDirect ( UOptimusNode* InNode,
bool bFailIfLinks
)

 Remove a node directly. If a node still has connections this call will fail.
Public function UFunction BlueprintCallable, Category bool

RemoveNodes ( const TArray< UOptimusNode* >& InNodes
)

  
Public function bool

RemoveNodes ( const TArray< UOptimusNode* >& InNodes,
const FString& InActionName
)

  
Protected function Const bool

RemoveNodesToAction ( FOptimusCompoundAction* InAction,
const TArray< UOptimusNode* >& InNodes
)

  
Protected function void FIXME: Remove this.
Public function 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.

Overridden from UObject

  Type Name Description
Public function Virtual void 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.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from IOptimusNodeGraphCollectionOwner

  Type Name Description
Public function Virtual bool

AddGraph ( 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.
Public function Virtual UOptimusNodeGraph *

CreateGraph ( EOptimusNodeGraphType InType,
FName InName,
TOptional< int32 > InInsertBefore
)

 Create a new graph of a given type, with an optional name.
Public function Virtual Const IOptimusNodeGraphCollectionOwner * IOptimusNodeGraphCollectionOwner overrides.
Public function Virtual Const FString Returns the path to this graph collection owner.
Public function Virtual Const IOptimusNodeGraphCollectionOwner * Returns root collection that owns all the collections
Public function Virtual Const UFunction BlueprintCallable, Category const TArray< UOptimusNodeGraph * > & Returns all immediately owned node graphs.
Public function Virtual UFunction BlueprintCallable, Category bool

MoveGraph ( UOptimusNodeGraph* InGraph,
int32 InInsertBefore
)

 Re-order the graph relative to the other graphs.
Public function Virtual bool

RemoveGraph ( UOptimusNodeGraph* InGraph,
bool bDeleteGraph
)

 Remove the given graph.
Public function Virtual UFunction BlueprintCallable, Category bool

RenameGraph ( UOptimusNodeGraph* InGraph,
const FString& InNewName
)

 Rename the given graph, subject to validation of the name.

Constants

Name Description
LibraryRoot  
SetupGraphName Reserved names.
UpdateGraphName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page