1. Epic GamesDeveloper
  3. SGraphNode

SGraphNode

API > API/Editor > API/Editor/GraphEditor

Inheritance Hierarchy

References

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

Syntax

class SGraphNode : public SNodePanel::SNode

Variables

  Type Name Description
Protected variable bool bProvidedComplexTooltip Is the current tooltip a complex one that should be dropped when the tooltip is no longer displayed?
Protected variable bool bRenameIsPending Is a rename operation pending.
Protected variable FVector2D CachedUnscaledPosition Caches true position of node
Protected variable FSlateColor ErrorColor Used to set the error color
Protected variable FString ErrorMsg Used to report errors on the node
Protected variable TSharedPtr< class IErrorReportingWidget > ErrorReporting Error handling widget
Protected variable FCurveHandle FadeCurve  
Protected variable UEdGraphNode * GraphNode The GraphNode being observed by this widget
Protected variable FLinearColor IconColor Cached icon color for the node
Protected variable TSharedPtr< SInlineEditableTextBlock > InlineEditableText Used to display the name of the node and allow renaming of the node
Protected variable TArray< TSharedRef< SGraphPin > > InputPins Input pin widgets on this node
Protected variable TAttribute< bool > IsEditable Is this node editable
Protected variable TSharedPtr< SVerticalBox > LeftNodeBox The area where input pins reside
Protected variable SGraphEditor::FOnDisallowedPinConnection OnDisallowedPinConnection Called when the user generates a warning tooltip because a connection was invalid
Protected variable FSingleNodeEvent OnDoubleClick  
Protected variable FOnNodeTextCommitted OnTextCommitted Called whenever the text on the node is committed interactively by the user
Protected variable FOnNodeVerifyTextCommit OnVerifyTextCommit Called whenever the text on the node is being committed interactively by the user, validates the string for commit
Protected variable TArray< TSharedRef< SGraphPin > > OutputPins Output pin widgets on this node
Protected variable TWeakPtr< SGraphPanel > OwnerGraphPanelPtr The GraphPanel within in which this node resides.
Protected variable TSharedPtr< SVerticalBox > RightNodeBox The area where output pins reside
Protected variable const UGraphEditorSettings * Settings Cached pointer to graph editor settings
Protected variable FCurveSequence SpawnAnim  
Protected variable FSlateColor VisualWarningColor Used to set the soft error color
Protected variable FString VisualWarningMsg Used to report visual warnings on the node (does not break build)
Protected variable TSharedPtr< class IErrorReportingWidget > VisualWarningReporting Visual Warning handling widget
Protected variable FCurveHandle ZoomCurve  

Constructors

  Type Name Description
Protected function    

Functions

  Type Name Description
Protected function Virtual void

AddPin ( const TSharedRef< SGraphPin >& PinToAdd
)

 Add a new pin to this graph node. The pin must be newly created.
Protected function TSharedRef< SWidget >

AddPinButtonContent ( FText PinText,
FText PinTooltipText,
bool bRightSide,
FString DocumentationExcerpt,
TSharedPtr< SToolTip > CustomTooltip
)

 Creates widget for an Add pin button, which can then be added to the node
Protected function Const EVisibility Returns visibility of AdvancedViewButton
Public function void Sets node into rename state if supported
Protected function Static bool

CanAllowInteractionUsingDragDropOp ( const UEdGraphNode* GraphNodePtr,
const TSharedPtr< FActorDragDropOp >& DragDropOp
)

 Check whether drag and drop functionality is permitted on the given node
Protected function void Create button to show/hide advanced pinsCreate widget to show/hide advanced pins
Protected function Virtual void Override this to add widgets below the pins but above advanced view arrow.
Protected function Virtual void Override this to add widgets below the node and pins.
Protected function Virtual void Override this to create a button to add pins on the input side of the node
Protected function Virtual TSharedRef< SWidget > Create the inner node content area, including the left/right pin boxes
Protected function Virtual void Override this to create a button to add pins on the output side of the node
Protected function Virtual Const TSharedPtr< SGraphPin > Hook that allows derived classes to supply their own SGraphPin derivatives for any pin.
Public function Virtual void Create the widgets for pins on the node
Public function Virtual void Create a single pin widget
Protected function Virtual TSharedRef< SWidget > Optionally create a widget to dock to the right in the title bar of the node.
Protected function Virtual TSharedRef< SWidget >  
Public function Const TSharedPtr< SGraphPin >  
Protected function Const const FSlateBrush * Up when shown, down when hidden
Public function Const FLinearColor  
Protected function Virtual Const FSlateColor Return the desired comment bubble color
Protected function Virtual TSharedPtr< SToolTip > Override this to provide support for an 'expensive' tooltip widget that is only built on demand
Public function Const FVector2D  
Public function Const EGraphRenderingLOD::Type Returns the current Node LOD or Highest LOD if unable to query
Public function Const FString  
Public function Const FText  
Protected function TSharedPtr< SWidget > Returns the widget to use for the enabled state of the node
Protected function Const FSlateColor Helper function to set the error color for the node
Protected function Const FString Helper function to get any error text for the node
Protected function Const FText Function to get error description string
Public function Virtual Const TSharedPtr< SGraphPin >

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

 Find the pin that is hovered.
Public function Virtual Const const FSlateBrush *  
Public function Const FSlateColor  
Public function Const FSlateColor  
Public function Const UEdGraphNode *  
Public function Const FSlateColor  
Public function Const FSlateColor  
Public function Const FLinearColor  
Public function Const FText  
Public function Virtual TSharedRef< SGraphNode >

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

  
Public function Const TSharedPtr< SGraphPanel >  
Public function Const FLinearColor  
Public function Const void

GetPins ( TArray< TSharedRef< SWidget > >& AllPins
)

 Get all the pins found on this node.
Public function Const void

GetPins ( TSet< TSharedRef< SWidget > >& AllPins
)

 Get all the pins found on this node.
Public function Virtual Const FSlateRect Return rect of the title area
Public function Const FVector2D Gets the unscaled position of the node from the last tick
Protected function Const FSlateColor Helper function to set the error color for the node
Protected function Const FText Function to get a visual warning description string(visual warnings does not break the build)
Public function void Called when ed graph data is cleared, indicating this widget can no longer safely access GraphNode - forwards call to owned pins:
Protected function Virtual Const EVisibility Checks whether Add pin button should currently be visible
Protected function Const ECheckBoxState Hidden == unchecked, shown == checked
Public function Virtual Const bool Returns true if the node is hiding its pins
Protected function Virtual Const bool Helper function to check if node can be renamed
Public function Virtual Const bool Returns if widget is editable, additionally considers if the owning graph is read only
Public function Const bool Returns true if a rename is pending on this node
Protected function Const bool Checks if the node is the only node selected
Public function Const FVector2D

NodeCoordToGraphCoord ( const FVector2D& PanelSpaceCoordinate
)

 Given a coordinate in SGraphNode space, return the same coordinate in graph space while taking zoom and panning of the parent graph into account
Public function Const void Called from drag drop code when a disallowed connection is hovered
Protected function Virtual FReply Callback function executed when Add pin button is clicked
Protected function Virtual void

OnAdvancedViewChanged ( const ECheckBoxState NewCheckedState
)

 Show/hide advanced view
Public function Virtual void

OnCommentBubbleToggled ( bool bInCommentBubbleVisible
)

 Called when the node's comment bubble is toggled
Public function Virtual void

OnCommentTextCommitted ( const FText& NewComment,
ETextCommit::Type CommitInfo
)

 Called to replace this nodes comment text
Protected function void

OnNameTextCommited ( const FText& InText,
ETextCommit::Type CommitInfo
)

 Called when text is committed on the node
Protected function bool

OnVerifyNameTextChanged ( const FText& InText,
FText& OutErrorMessage
)

 Called when text is being committed to check for validity
Public function void  
Protected function Virtual Const void Populate a meta data tag with information about this graph node
Protected function Const void

PositionThisNodeBetweenOtherNodes ( const TMap< UObject*, TSharedRef< SNode > >& NodeToWidgetLookup,
TSet< UEdGraphNode* >& PreviousNodes,
TSet< UEdGraphNode* >& NextNodes,
float HeightAboveWire
)

  
Protected function Const void

PositionThisNodeBetweenOtherNodes ( const FVector2D& PrevPos,
const FVector2D& NextPos,
float HeightAboveWire
)

  
Protected function Const void

PositionThisNodeBetweenOtherNodes ( const TMap< UObject*, TSharedRef< SNode > >& NodeToWidgetLookup,
UEdGraphNode* PreviousNode,
UEdGraphNode* NextNode,
float HeightAboveWire
)

  
Public function Virtual void Called when GraphNode changes its error information, may be called when no change has actually occurred:
Public function void Flags node as rename pending if supported
Public function Virtual void Requests a rename when the node was initially spawned
Protected function Virtual void

SetDefaultTitleAreaWidget ( TSharedRef< SOverlay > DefaultTitleAreaWidget
)

  
Public function void Set event when the user generates a warning tooltip because a connection was invalid
Public function void

SetDoubleClickEvent ( FSingleNodeEvent InDoubleClickEvent
)

 Set event when node is double clicked
Public function void

SetIsEditable ( TAttribute< bool > InIsEditable
)

 Set attribute for determining if widget is editable
Public function Virtual void

SetOwner ( const TSharedRef< SGraphPanel >& OwnerPanel
)

  
Public function void

SetTextCommittedEvent ( FOnNodeTextCommitted InDelegate
)

 Set event when text is committed on the node
Protected function void Set-up the error reporting widget for the node
Public function void

SetVerifyTextCommitEvent ( FOnNodeVerifyTextCommit InOnVerifyTextCommit
)

 Set event when text is committed on the node
Protected function Const bool

ShouldPinBeHidden ( const UEdGraphPin* InPin
)

 Returns TRUE if the input pin should be hidden from view
Protected function Virtual void Called to set error text on the node
Public function Virtual void Update this GraphNode to match the data that it is observing
Protected function Virtual Const bool Should we use low-detail node titles?
Public function Virtual Const bool Should we use low-detail pin names?
Protected function Const EVisibility Controls wether to show or not the visual warning message

Overridden from SNode

  Type Name Description
Public function Virtual Const FString  
Public function Virtual Const UObject *  
Public function Virtual Const FVector2D  
Public function Virtual void

MoveTo ( const FVector2D& NewPosition,
FNodeSet& NodeFilter,
bool bMarkDirty
)

  

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

OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when a mouse button is double clicked. Override this in derived classes.
Public function Virtual FReply

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

 The system calls this method to notify the widget that a mouse button was pressed within it.
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 Called when a tooltip displayed from this widget is being closed
Public function Virtual void

Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

 Ticks this widget with Geometry.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page