1. Epic GamesDeveloper
  3. UOptimusNode

UOptimusNode

API > API/Plugins > API/Plugins/OptimusCore

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract)  
class UOptimusNode : public UObject

Variables

  Type Name Description
Protected variable bool bSendNotifications A sentinel to indicate whether sending notifications is allowed.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function UOptimusNodePin *

AddGroupingPin ( FName InName,
EOptimusNodePinDirection InDirection,
UOptimusNodePin* InBeforePin
)

 Add a new grouping pin.
Protected function UOptimusNodePin *

AddGroupingPinDirect ( FName InName,
EOptimusNodePinDirection InDirection,
UOptimusNodePin* InBeforePin
)

  
Protected function UOptimusNodePin *

AddPin ( FName InName,
EOptimusNodePinDirection InDirection,
const FOptimusDataDomain& InDataDomain,
FOptimusDataTypeRef InDataType,
UOptimusNodePin* InBeforePin,
UOptimusNodePin* InGroupingPin
)

  
Protected function UOptimusNodePin *

AddPin ( const FOptimusParameterBinding& InBinding,
EOptimusNodePinDirection InDirection,
UOptimusNodePin* InBeforePin
)

 Add a new pin based on a parameter binding definition. Only allowed for top-level pins.
Protected function UOptimusNodePin *

AddPinDirect ( const FOptimusParameterBinding& InBinding,
EOptimusNodePinDirection InDirection,
UOptimusNodePin* InBeforePin
)

 Add a new pin based on a parameter binding definition. Only allowed for top-level pins.
Protected function UOptimusNodePin *

AddPinDirect ( FName InName,
EOptimusNodePinDirection InDirection,
const FOptimusDataDomain& InDataDomain,
FOptimusDataTypeRef InDataType,
UOptimusNodePin* InBeforePin,
UOptimusNodePin* InParentPin
)

 Create a pin and add it to the node in the location specified.
Public function Const bool

CanConnectPinToNode ( const UOptimusNodePin* InOtherPin,
EOptimusNodePinDirection InConnectionDirection,
FString* OutReason
)

 Preliminary check for whether valid connection can be made between an existing pin and a potentially existing pin on this node.
Public function Const bool

CanConnectPinToPin ( const UOptimusNodePin& InThisNodesPin,
const UOptimusNodePin& InOtherNodesPin,
FString* OutReason
)

 Preliminary check for whether valid connection can be made between two existing pins.
Public function Virtual Const bool Returns true if the node can be deleted by the user
Protected function Virtual void Called when the node is being constructed.
Protected function void  
Protected function Virtual Const void  
Public function Const UOptimusNodePin *

FindPin ( const FStringView InPinPath
)

 Find the pin associated with the given dot-separated pin path.
Public function Const UOptimusNodePin *

FindPinFromPath ( const TArray< FName >& InPinPath
)

 Find the pin from the given path array.
Public function Const UOptimusNodePin *

FindPinFromProperty ( const FProperty* InRootProperty,
const FProperty* InSubProperty
)

 Find the pin associated with the given FProperty object(s).
Protected function Const UOptimusActionStack * Return the action stack for this node.
Public function Static TArray< UClass * > Returns the class of all non-deprecated UOptimusNodeBase nodes that are defined, in no particular order.
Protected function Static FName

GetAvailablePinNameStable ( const UObject* InNodeOrPin,
FName InName
)

 Returns a unique name for pin.
Public function Const EOptimusDiagnosticLevel Returns the node's diagnostic level (e.g. error state).
Public function Virtual Const UFunction BlueprintCallable, Category FText Returns the display name to use on the graphical node in the graph editor.
Public function Const UFunction BlueprintCallable, Category FVector2D Returns the position in the graph UI where the node is shown.
Public function Virtual Const UFunction BlueprintCallable, Category FName Returns the node class category. This is used for categorizing the node for display.
Public function Const UFunction BlueprintCallable, Category FName Returns the node class name. This name is immutable for the given node class.
Public function Const FString Returns the absolute path of the node.
Public function Const UOptimusNodeGraph * Returns the owning node graph of this node.
Protected function Const bool

GetPinExpanded ( const UOptimusNodePin* InPin
)

  
Public function Const TArrayView< UOptimusNodePin *const >

GetPins ()

 Returns the list of all the pins on this node
Public function Const TArray< UOptimusNodePin * >

GetPinsByDirection ( EOptimusNodePinDirection InDirection,
bool bInRecursive
)

 Returns the list of pins on this node filtered by direction
Protected function Virtual void  
Protected function Virtual void Allows the node to initialize any transient data that can be derived from serialized properties.
Protected function bool

MovePin ( UOptimusNodePin* InPinToMove,
const UOptimusNodePin* InPinBefore
)

 Swap two sibling pins
Protected function bool

MovePinDirect ( UOptimusNodePin* InPinToMove,
const UOptimusNodePin* InPinBefore
)

  
Protected function bool  
Protected function Virtual void

OnDataTypeChanged ( FName InTypeName
)

  
Public function void Called just after the node is created, either via direct creation or deletion undo.
Public function Virtual void Derived nodes should override this function for any PostLoad fix-ups.
Protected function Virtual void

PreDuplicateRequirementActions ( const UOptimusNodeGraph* InTargetGraph,
FOptimusCompoundAction* InCompoundAction
)

 Called prior to duplicate to allow the node to add its own graph requirements to to the list of actions being performed.
Protected function bool Remove a pin.
Protected function bool Remove the pin with no undo.
Public function void Sets the node diagnostic level (e.g. error state).
Public function bool

SetDisplayName ( FText InDisplayName
)

 Set the display name for this node.
Public function UFunction BlueprintCallable, Category bool

SetGraphPosition ( const FVector2D& InPosition
)

 Sets the position in the graph UI that the node should be shown at.
Protected function bool

SetGraphPositionDirect ( const FVector2D& InPosition
)

 Set a new position of the node in the graph UI.
Protected function bool

SetPinDataDomain ( UOptimusNodePin* InPin,
const FOptimusDataDomain& InDataDomain
)

 Set the pin's resource context names.
Protected function bool  
Protected function bool Set the pin data type.
Protected function bool  
Protected function void

SetPinExpanded ( const UOptimusNodePin* InPin,
bool bInExpanded
)

  
Protected function bool

SetPinName ( UOptimusNodePin* InPin,
FName InNewName
)

 FIXME: Hoist to public.
Protected function bool

SetPinNameDirect ( UOptimusNodePin* InPin,
FName InNewName
)

  
Protected function Virtual Const bool

ValidateConnection ( const UOptimusNodePin& InThisNodesPin,
const UOptimusNodePin& InOtherNodesPin,
FString* OutReason
)

  
Protected function Virtual Const TOptional< FText > Optional: Perform local node validation for compilation.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Using "final" here to make sure all derive nodes have InitializeTransientData() automatically called on them during PostLoad(), so please use PostLoadNodeSpecificData instead for any PostLoad fix-ups
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public struct CategoryName    
Public struct PropertyMeta    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page