Navigation
API > API/Plugins > API/Plugins/OptimusCore
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UOptimusNodePin
References
| Module | OptimusCore |
| Header | /Engine/Plugins/Animation/DeformerGraph/Source/OptimusCore/Public/OptimusNodePin.h |
| Include | #include "OptimusNodePin.h" |
Syntax
UCLASS (BlueprintType)
class UOptimusNodePin : public UObject
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddSubPin
(
UOptimusNodePin* InSubPin, |
||
| bool | CanCannect
(
const UOptimusNodePin* InOtherPin, |
Ask this pin if it allows a connection from the other pin. | |
| void | ClearSubPins () |
||
| TSet< UOptimusComponentSourceBinding * > | GetComponentSourceBindings
(
const FOptimusPinTraversalContext& InContext |
Return all component source bindings that flow into pin. | |
| TSet< UOptimusComponentSourceBinding * > | GetComponentSourceBindingsRecursively
(
const FOptimusPinTraversalContext& InContext |
Return all component source bindings that flow into this input pin and its sub-pins. | |
| TArray< UOptimusNodePin * > | Returns all pins that have a direct connection to this pin. | ||
| TArray< FOptimusRoutedNodePin > | GetConnectedPinsWithRouting
(
const FOptimusPinTraversalContext& InContext |
Returns all pins that are connected to working nodes, traversing fully through any router nodes. | |
| const FOptimusDataDomain & | Returns the data domain that this pin is expected to cover | ||
| FOptimusDataTypeHandle | GetDataType () |
Return the registered Optimus data type associated with this pin | |
| EOptimusNodePinDirection | GetDirection () |
Returns whether this pin is an input or output connection. | |
| FText | Returns a user-friendly display name for this pin | ||
| bool | Returns the stored expansion state | ||
| const UOptimusNodePin * | GetNextPin () |
||
| UOptimusNodePin * | GetNextPin () |
Returns the next sibling of this pin, or nullptr if it is the last pin of its siblings. | |
| UOptimusNode * | Returns the owning node of this pin and all its ancestors and children. | ||
| const UOptimusNodePin * | GetParentPin () |
||
| UOptimusNodePin * | GetParentPin () |
Returns the parent pin of this pin, or nullptr if it is the top-most pin. | |
| TArray< FName > | Returns the array of pin names from the root pin to this pin. | ||
| TArray< FName > | GetPinNamePathFromString
(
const FStringView InPinPathString |
Returns a pin path from a string. Returns an empty array if string is invalid or empty. | |
| FString | GetPinPath () |
Returns the path of the pin from the graph collection owner root. | |
| FProperty * | Returns the FProperty object for this pin. | ||
| const UOptimusNodePin * | GetRootPin () |
||
| UOptimusNodePin * | GetRootPin () |
Returns the root pin of this pin hierarchy. | |
| TArrayView< const TObjectPtr< UOptimusNodePin > > | GetSubPins () |
Returns the sub-pins of this pin. | |
| TArray< UOptimusNodePin * > | GetSubPinsRecursively
(
bool bInIncludeThisPin |
Returns all sub-pins of this pin, recursively. | |
| FText | Returns a tooltip to use when hovering over the pin in the graph | ||
| FName | Returns a unique name for this pin within the namespace of the owning node. E.g: Direction.X | ||
| FString | Returns the current value of this pin, including sub-values if necessary, as a string. | ||
| void | InitializeWithData
(
EOptimusNodePinDirection InDirection, |
Initialize the pin data from the given direction and property. | |
| void | InitializeWithGrouping
(
EOptimusNodePinDirection InDirection |
||
| bool | Returns `true_ if this pin is a grouping pin. | ||
| bool | IsMutable
(
const FOptimusPinTraversalContext& InContext |
Whether the data presented by the pin can change over time | |
| void | Notify
(
EOptimusGraphNotifyType InNotifyType |
||
| bool | SetDataType
(
FOptimusDataTypeRef InDataType |
||
| void | SetIsExpanded
(
bool bInIsExpanded |
Set the expansion state of this pin. | |
| bool | |||
| bool | SetValueFromString
(
const FString& InStringValue |
Sets the value of this pin from a value string in an undoable fashion. | |
| 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
| Type | Name | Description | |
|---|---|---|---|
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |