Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > GraphEditor > SGraphPin

Light Theme

Dark Theme

SGraphPin

Represents a pin on a node in the GraphEditor

Windows

MacOS

Linux

Inheritance Hierarchy

References

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

Syntax

class SGraphPin : public SBorder

Remarks

Represents a pin on a node in the GraphEditor

Variables

	Name	Description
bool	bGraphDataInvalid	Flag indicating that graph data has been deleted by the user
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_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
TSharedPtr< SWi...	PinImage	Image of pin
TSharedPtr< SWi...	ValueWidget	Value widget for the pin, created with GetDefaultValueWidget()

Constructors

	Name	Description
	SGraphPin()

Functions

	Name	Description
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.
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
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()
const FSlate...	GetPinIcon()
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()
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	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	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

	Name	Description
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

	Name	Description
	FArguments

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss