1. Epic GamesDeveloper
  3. SGraphPin

SGraphPin

Represents a pin on a node in the GraphEditor

API > API/Editor > API/Editor/GraphEditor

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

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool  
Protected function Virtual FReply Toggle the watch pinning
Public function void

Construct ( const FArguments& InArgs,
UEdGraphPin* InPin
)

 Construct this widget
Protected function Virtual Const bool If true the graph pin subclass is responsible for setting the IsEnabled delegates for the aspects it cares about.
Public function void

EnableDragAndDrop ( bool bEnable
)

 Enables or disables drag and drop on the pin
Public function Const bool True if the pin's default value can be edited, false if it is read only
Public function Virtual Const EVisibility  
Public function Virtual TSharedRef< SWidget > Build the widget we should put into the 'default value' space, shown when nothing connected
Public function Const EEdGraphPinDirection  
Public function TWeakPtr< SHorizontalBox > Retrieves the full horizontal box that contains the pin's row content
Protected function Virtual Const FSlateColor  
Protected function Const void

GetInteractiveTooltipLocation ( FVector2D& InOutDesiredLocation
)

 Gets the window location (in screen coords) for an interactive tooltip (e.g. pin value inspector)
Public function Const bool Returns whether or not this pin is currently connectable
Public function Const TSharedRef< SWrapBox > Get the label/value part of the pin widget
Protected function Virtual TSharedRef< SWidget >

GetLabelWidget ( const FName& InPinLabelStyle
)

 Get the widget we should put in the label space, which displays the name of the pin.
Public function Const FVector2D Gets Node Offset
Protected function Const const FSlateBrush *  
Protected function Virtual Const FSlateColor  
Protected function Const TOptional< EMouseCursor::Type >  
Protected function Virtual Const FSlateColor  
Protected function Virtual Const const FSlateBrush *  
Public function Const TSharedPtr< SWidget > Returns the current pin image widget that is being used
Protected function Const FText  
Protected function Const EVisibility If we should show the label on this pin
Public function Const UEdGraphPin *  
Protected function Virtual Const const FSlateBrush *  
Protected function Virtual Const EVisibility  
Protected function Virtual Const FSlateColor  
Protected function Const EVisibility Determines the pin's visibility based on the LOD factor, when it is low LOD, no hit test will occur
Protected function Const FSlateColor  
Protected function Const const FSlateBrush *  
Protected function Const FText  
Public function Const TSharedRef< SWidget > Get the widget created by GetDefaultValueWidget()
Public function Const bool  
Public function void 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.
Public function Const bool

IsArray ()

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool True if pin can be edited
Public function Const bool

IsMap ()

  
Public function Const EVisibility If pin in node is visible at all
Public function Const bool

IsSet ()

  
Public function Virtual FReply

OnPinMouseDown ( const FGeometry& SenderGeometry,
const FPointerEvent& MouseEvent
)

 Handle clicking on the pin
Public function FReply

OnPinNameMouseDown ( const FGeometry& SenderGeometry,
const FPointerEvent& MouseEvent
)

 Handle clicking on the pin name
Public function void

SetCustomPinIcon ( const FSlateBrush* InConnectedBrush,
const FSlateBrush* InDisconnectedBrush
)

 Override the visual look of the pin by providing two custom brushes
Public function void

SetDiffHighlighted ( bool bHighlighted
)

  
Public function void

SetFadeConnections ( bool bInFadeConnections
)

 Makes Pin Connection Wires transparent
Public function void

SetIsEditable ( TAttribute< bool > InIsEditable
)

 Set attribute for determining if pin is editable
Public function void

SetOnlyShowDefaultValue ( bool bNewOnlyShowDefaultValue
)

 Set this pin to only be used to display default value
Public function void

SetOwner ( const TSharedRef< SGraphNode > OwnerNode
)

  
Public function void Allows the connection drawing policy to control the pin color
Public function void Allows Diff to highlight pins
Public function void Sets the pin widget for this pin
Public function void

SetPinObj ( UEdGraphPin* PinObj
)

  
Public function void

SetShowLabel ( bool bNewDrawLabel
)

 Control whether we draw the label on this pin
Protected function Virtual TSharedRef< FDragDropOperation >

SpawnPinDragEvent ( const TSharedRef< class SGraphPanel >& InGraphPanel,
const TArray< TSharedRef< SGraphPin > >& InStartingPins
)

 Spawns a FDragConnection or similar class for the pin drag event
Public function Virtual bool Tries to handle making a connection to another pin, depending on the schema and the pins it may do:
Protected function Virtual Const bool Should we use low-detail pin names?

Overridden from SWidget

  Type Name Description
Public function Virtual TSharedPtr< IToolTip >  
Public function Virtual void

OnDragEnter ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
Public function Virtual void

OnDragLeave ( const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the drag leaves a widget.
Public function Virtual FReply

OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the the mouse is being dragged over a widget.
Public function Virtual FReply

OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual 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.
Public function Virtual void

OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has entered it.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.
Public function Virtual FReply

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual 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

On this page