UOptimusNodePin

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

OptimusDeveloper

Header

/Engine/Plugins/Experimental/Optimus/Source/OptimusDeveloper/Public/OptimusNodePin.h

Include

#include "OptimusNodePin.h"

Syntax

UCLASS(BlueprintType)
class UOptimusNodePin : public UObject

Constructors

Name Description

Public function

UOptimusNodePin()

Functions

Name Description

Protected function

void

 

AddSubPin

(
    UOptimusNodePin* InSubPin,
    UOptimusNodePin* InBeforePin
)

Public function Const

bool

 

CanCannect

(
    const UOptimusNodePin* InOther...,
    FString* OutReason
)

Ask this pin if it allows a connection from the other pin.

Protected function

void

 

ClearSubPins()

Public function Const

TArray< UOpt...

 

GetConnectedPins()

Returns all pins that have a direct connection to this pin.

Public function Const

TArray< FOpt...

 

GetConnectedPinsWithRouting

(
    const FOptimusPinTraversalContext&...
)

Returns all pins that are connected to working nodes, traversing fully through any router nodes.

Public function Const

TArray< FNam...

 

GetDataDomainLevelNames()

Returns the data domain level names for this pin, if a resource pin, otherwise returns an empty array

Public function Const

FOptimusData...

 

GetDataType()

Return the registered Optimus data type associated with this pin

Public function Const

EOptimusNode...

 

GetDirection()

Returns whether this pin is an input or output connection.

Public function Const

FText

 

GetDisplayName()

Returns a user-friendly display name for this pin

Public function Const

bool

 

GetIsExpanded()

Returns the stored expansion state

Public function Const

UOptimusNode...

 

GetOwningNode()

Returns the owning node of this pin and all its ancestors and children.

Public function Const

const UOptim...

 

GetParentPin()

Returns the parent pin of this pin, or nullptr if it is the top-most pin.

Public function

UOptimusNode...

 

GetParentPin()

Returns the parent pin of this pin, or nullptr if it is the top-most pin.

Public function Const

TArray< FNam...

 

GetPinNamePath()

Returns the array of pin names from the root pin to this pin.

Public function Static

TArray< FNam...

 

GetPinNamePathFromString

(
    const FStringView InPinPathString
)

Returns a pin path from a string. Returns an empty array if string is invalid or empty.

Public function Const

FString

 

GetPinPath()

Returns the path of the pin from the graph collection owner root.

Public function Const

FProperty &#...

 

GetPropertyFromPin()

Returns the FProperty object for this pin.

Public function Const

const UOptim...

 

GetRootPin()

Returns the root pin of this pin hierarchy.

Public function

UOptimusNode...

 

GetRootPin()

Returns the root pin of this pin hierarchy.

Public function Const

EOptimusNode...

 

GetStorageType()

Returns the storage type for this pin, either a value or a bound resource

Public function Const

const TArray...

 

GetSubPins()

Returns the sub-pins of this pin.

Public function Const

TArray< UOpt...

 

GetSubPinsRecursively()

Returns all sub-pins of this pin, recursively.

Public function Const

FText

 

GetTooltipText()

Returns a tooltip to use when hovering over the pin in the graph

Public function Const

FName

 

GetUniqueName()

Returns a unique name for this pin within the namespace of the owning node. E.g: Direction.X

Public function Const

FString

 

GetValueAsString()

Returns the current value of this pin, including sub-values if necessary, as a string.

Protected function

void

 

Initialize

(
    EOptimusNodePinDirection InDirectio...,
    FOptimusNodePinStorageConfig InStor...,
    FOptimusDataTypeRef InDataTypeRef
)

Initialize the pin data from the given direction and property.

Protected function

void

 

Notify

(
    EOptimusGraphNotifyType InNotifyTyp...
)

Protected function

bool

 

SetDataType

(
    FOptimusDataTypeRef InDataType
)

Public function

void

 

SetIsExpanded

(
    bool bInIsExpanded
)

Set the expansion state of this pin.

Protected function

bool

 

SetName

(
    FName InName
)

Public function

bool

 

SetValueFromString

(
    const FString& InStringValue
)

Sets the value of this pin from a value string in an undoable fashion.

Public function

bool

 

SetValueFromStringDirect

(
    const FString& InStringValue
)

Sets the value of this pin from a value string with no undo (although if a transaction bracket is open, it will receive the modification).

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

UObject overloads.