SGraphPin

Represents a pin on a node in the GraphEditor

Unreal Engine C++ API Reference > Editor > GraphEditor

Inheritance Hierarchy

References

   
Module GraphEditor
Header /Engine/Source/Editor/GraphEditor/Public/SGraphPin.h
Include #include "SGraphPin.h"

Syntax

class SGraphPin : public [SBorder](API\Runtime\Slate\Widgets\Layout\SBorder)  

Remarks

Represents a pin on a node in the GraphEditor

Variables

Type Name Description
bool bDragAndDropEnabled TRUE if the pin should allow any drag and drop
bool bFadeConnections TRUE if the connections from this pin should be drawn at a lower opacity
bool bGraphDataInvalid Flag indicating that graph data has been deleted by the user
bool bIsDiffHighlighted True if this pin is being diffed and it's currently selected in the diff view. Highlights this pin
bool bIsMovingLinks True when we're moving links between pins.
bool bOnlyShowDefaultValue If we should draw the label on this pin
bool bShowLabel If we should draw the label on this pin
bool bUsePinColorForText TRUE if the pin should use the Pin's color for the text
const FSlateBru... CachedImg_ArrayPin_Connected  
const FSlateBru... CachedImg_ArrayPin_Disconnected  
const FSlateBru... CachedImg_DelegatePin_Connected  
const FSlateBru... CachedImg_DelegatePin_Disconnected  
const FSlateBru... CachedImg_MapPinKey  
const FSlateBru... CachedImg_MapPinValue  
const FSlateBru... CachedImg_Pin_Background  
const FSlateBru... CachedImg_Pin_BackgroundHovered  
const FSlateBru... CachedImg_Pin_Connected  
const FSlateBru... CachedImg_Pin_DiffOutline  
const FSlateBru... CachedImg_Pin_Disconnected  
const FSlateBru... CachedImg_PosePin_Connected  
const FSlateBru... CachedImg_PosePin_Disconnected  
const FSlateBru... CachedImg_RefPin_Connected  
const FSlateBru... CachedImg_RefPin_Disconnected  
const FSlateBru... CachedImg_SetPin  
FVector2D CachedNodeOffset Cached offset from owning node to approximate position of culled pins
const FSlateBru... Custom_Brush_Connected  
const FSlateBru... Custom_Brush_Disconnected  
TWeakPtr< SHori... FullPinHorizontalRowWidget Horizontal box that holds the full detail pin widget, useful for outsiders to inject widgets into the pin
UEdGraphPin ... GraphPinObj The GraphPin that this widget represents.
TSet< FEdGraphP... HoverPinSet Set of pins that are currently being hovered
TAttribute< boo... IsEditable Is this pin editable
TSharedPtr< SWr... LabelAndValue Label and value
TWeakPtr< SGrap... OwnerNodePtr The GraphNode that owns this pin
FLinearColor PinColorModifier Color modifier for use by the connection drawing policy
TOptional< FLin... PinDiffColor If set, this will change the color of the pin's background highlight
TSharedPtr< SWi... PinImage Image of pin
TWeakPtr< FPinV... ValueInspectorTooltip Value inspector tooltip while debugging
TSharedPtr< SWi... ValueWidget Value widget for the pin, created with GetDefaultValueWidget()

Constructors

Type Name Description
  SGraphPin ()  

Destructors

Type Name Description
  ~SGraphPin ()  

Functions

Type Name Description
bool AreConnectionsFaded ()  
FReply ClickedOnPinStatusIcon () Toggle the watch pinning
void Construct ( const FArguments& InArgs, UEdGraphPin* InPin ) Construct this widget
bool DoesWidgetHandleSettingEditingEnabled () If true the graph pin subclass is responsible for setting the IsEnabled delegates for the aspects it cares about.
void EnableDragAndDrop ( bool bEnable ) Enables or disables drag and drop on the pin
bool GetDefaultValueIsEditable () True if the pin's default value can be edited, false if it is read only
EVisibility GetDefaultValueVisibility ()  
TSharedRef< ... GetDefaultValueWidget () Build the widget we should put into the 'default value' space, shown when nothing connected
EEdGraphPinD... GetDirection ()  
TWeakPtr< SH... GetFullPinHorizontalRowWidget () Retrieves the full horizontal box that contains the pin's row content
FSlateColor GetHighlightColor ()  
void GetInteractiveTooltipLocation ( FVector2D& InOutDesiredLocation ) Gets the window location (in screen coords) for an interactive tooltip (e.g. pin value inspector)
bool GetIsConnectable () Returns whether or not this pin is currently connectable
TSharedRef< ... GetLabelAndValue () Get the label/value part of the pin widget
TSharedRef< ... GetLabelWidget ( const FName& InPinLabelStyle ) Get the widget we should put in the label space, which displays the name of the pin.
FVector2D GetNodeOffset () Gets Node Offset
const FSlate... GetPinBorder ()  
FSlateColor GetPinColor ()  
TOptional< E... GetPinCursor ()  
FSlateColor GetPinDiffColor ()  
const FSlate... GetPinIcon ()  
TSharedPtr< ... GetPinImageWidget () Returns the current pin image widget that is being used
FText GetPinLabel ()  
EVisibility GetPinLabelVisibility () If we should show the label on this pin
UEdGraphPin ... GetPinObj ()  
const FSlate... GetPinStatusIcon ()  
EVisibility GetPinStatusIconVisibility ()  
FSlateColor GetPinTextColor ()  
EVisibility GetPinVisiblity () Determines the pin's visibility based on the LOD factor, when it is low LOD, no hit test will occur
FSlateColor GetSecondaryPinColor ()  
const FSlate... GetSecondaryPinIcon ()  
FText GetTooltipText ()  
TSharedRef< ... GetValueWidget () Get the widget created by GetDefaultValueWidget()
bool HasInteractiveTooltip ()  
void InvalidateGraphData () Called when ed graph data is cleared, indicating this widget can no longer safely access GraphPinObj Typically an SGraphPin is destroyed before the ed graph data is actually deleted but because SWidget is reference counted we have had problems in the past with the SGraphPin (or Node) living unexpectedly long.
bool IsArray ()  
bool IsByMutableRef ()  
bool IsConnected ()  
bool IsDelegate ()  
bool IsEditingEnabled () True if pin can be edited
bool IsMap ()  
EVisibility IsPinVisibleAsAdvanced () If pin in node is visible at all
bool IsSet ()  
FReply OnPinMouseDown ( const FGeometry& SenderGeometry, const FPointerEvent& MouseEvent ) Handle clicking on the pin
FReply OnPinNameMouseDown ( const FGeometry& SenderGeometry, const FPointerEvent& MouseEvent ) Handle clicking on the pin name
void SetCustomPinIcon ( const FSlateBrush* InConnected..., const FSlateBrush* InDisconnec... ) Override the visual look of the pin by providing two custom brushes
void SetDiffHighlighted ( bool bHighlighted )  
void SetFadeConnections ( bool bInFadeConnections ) Makes Pin Connection Wires transparent
void SetIsEditable ( TAttribute< bool > InIsEditable ) Set attribute for determining if pin is editable
void SetOnlyShowDefaultValue ( bool bNewOnlyShowDefaultValue ) Set this pin to only be used to display default value
void SetOwner ( const TSharedRef< SGraphNode > Owne... )  
void SetPinColorModifier ( FLinearColor InColor ) Allows the connection drawing policy to control the pin color
void SetPinDiffColor ( TOptional< FLinearColor > InColor ) Allows Diff to highlight pins
void SetPinImageWidget ( TSharedRef< SWidget > NewWidget ) Sets the pin widget for this pin
void SetPinObj ( UEdGraphPin* PinObj )  
void SetShowLabel ( bool bNewDrawLabel ) Control whether we draw the label on this pin
TSharedRef< ... SpawnPinDragEvent ( const TSharedRef< class SGraphPanel..., const TArray< TSharedRef< SGraphPin... ) Spawns a FDragConnection or similar class for the pin drag event
bool TryHandlePinConnection ( SGraphPin& OtherSPin ) Tries to handle making a connection to another pin, depending on the schema and the pins it may do:
bool UseLowDetailPinNames () Should we use low-detail pin names?

Overridden from SWidget

Type Name Description
TSharedPtr< ... GetToolTip ()  
void OnDragEnter ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... ) DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
void OnDragLeave ( const FDragDropEvent& DragDropEven... ) Called during drag and drop when the drag leaves a widget.
FReply OnDragOver ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... ) Called during drag and drop when the the mouse is being dragged over a widget.
FReply OnDrop ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... ) Called when the user is dropping something onto a widget; terminates drag and drop.
FReply OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) The system calls this method to notify the widget that a mouse button was release within it.
void OnMouseEnter ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) The system will use this event to notify a widget that the cursor has entered it.
void OnMouseLeave ( const FPointerEvent& MouseEvent ) The system will use this event to notify a widget that the cursor has left it.
FReply OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) The system calls this method to notify the widget that a mouse moved within it.
void Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) Ticks this widget with Geometry.

Classes

Type Name Description
Public struct FArguments  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library