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