SGraphNodeComment

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

GraphEditor

Header

/Engine/Source/Editor/GraphEditor/Public/SGraphNodeComment.h

Include

#include "SGraphNodeComment.h"

Syntax

class SGraphNodeComment : public SGraphNodeResizable

Variables

Name Description

Protected variable

FString

 

CachedCommentTitle

Cached comment title

Functions

Name Description

Public function

void

 

Construct

(
    const FArguments& InArgs,
    UEdGraphNode_Comment* InNode
)

Protected function Const

void

 

HandleSelection

(
    bool bIsSelected,
    bool bUpdateNodesUnderComment
)

Helper method to update selection state of comment and any nodes 'contained' within it

Protected function Virtual Const

bool

 

IsNodeUnderComment

(
    UEdGraphNode_Comment* InCommen...,
    const TSharedRef< SGraphNode > InNo...
)

Helper function to determine if a node is under this comment widget or not

Overridden from SGraphNodeResizable

Name Description

Protected function Virtual Const

FSlateRect

 

GetHitTestingBorder()

Protected function Virtual Const

FVector2D

 

GetNodeMaximumSize()

Return largest desired node size

Protected function Virtual Const

float

 

GetTitleBarHeight()

Get the current titlebar size

Overridden from SGraphNode

Name Description

Public function Virtual Const

FSlateColor

 

GetCommentColor()

Return the desired comment bubble color

Public function Virtual Const

FSlateRect

 

GetTitleRect()

Return rect of the title bar

Public function Virtual Const

bool

 

IsNameReadOnly()

Helper function to check if node can be renamed

Protected function Virtual Const

void

 

PopulateMetaTag

(
    FGraphNodeMetaData* TagMeta
)

Populate a meta data tag with information about this graph node

Protected function Virtual

void

 

UpdateGraphNode()

Update this GraphNode to match the data that it is observing

Overridden from SNode

Name Description

Public function Virtual Const

bool

 

CanBeSelected

(
    const FVector2D& MousePositionInNo...
)

Return if the node can be selected, by pointing given location

Public function Virtual Const

void

 

EndUserInteraction()

Called when user interaction has completed

Public function Virtual Const

FVector2D

 

GetDesiredSizeForMarquee()

Return size of the title bar

Public function Virtual Const

FString

 

GetNodeComment()

Public function Virtual Const

void

 

GetOverlayBrushes

(
    bool bSelected,
    const FVector2D WidgetSize,
    TArray< FOverlayBrushInfo >& Brush...
)

Populate the brushes array with any overlay brushes to render

Public function Virtual Const

const FSlate...

 

GetShadowBrush

(
    bool bSelected
)

Public function Virtual Const

int32

 

GetSortDepth()

Returns node sort depth, defaults to and is generally 0 for most nodes.

Protected function Virtual

void

 

MoveTo

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

Called when user is moving the comment node

Public function Virtual Const

bool

 

ShouldAllowCulling()

Return false if this node should not be culled.

Overridden from SWidget

Name Description

Public function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float
)

A Panel's desired size in the space required to arrange of its children on the screen while respecting all of the children's desired sizes and any layout-related options specified by the user.

Public function Virtual

void

 

OnDragEnter

(
    const FGeometry& MyGeometry,
    const FDragDropEvent& DragDropEven...
)

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

Public function Virtual

FReply

 

OnDrop

(
    const FGeometry& MyGeometry,
    const FDragDropEvent& DragDropEven...
)

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

 

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

 

Tick

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

Ticks this widget with Geometry.

Classes

Name

Description

Public struct

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