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

Light Theme

Dark Theme

SGraphNodeDocumentation

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SPanel

SNodePanel::SNode

SGraphNode

SGraphNodeResizable

SGraphNodeDocumentation

References

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

Syntax

class SGraphNodeDocumentation : public SGraphNodeResizable

Functions

	Name	Description
void	Construct ( const FArguments& InArgs, UEdGraphNode* InNode )
TSharedPtr< ...	CreateDocumentationPage()	Create documentation page from link and excerpt
FOptionalSiz...	GetContentHeight()	Returns the height the documentation content must adhere to, used as a delegate in child widgets
FOptionalSiz...	GetContentWidth()	Returns the width the documentation content must adhere to, used as a delegate in child widgets
FText	GetDocumentationTitle()	Retrives the current documentation title based on the chosen excerpt
float	GetDocumentationWrapWidth()	Returns the child widget text wrapat size, used as a delegate during creation of documentation page
FLinearColor	GetPageGradientEndColor()	Color of the page gradient end
FLinearColor	GetPageGradientStartColor()	Color of the page gradient start
EVisibility	GetWidgetVisibility()	Returns the current child widgets visibility for hit testing

Overridden from SGraphNodeResizable

	Name	Description
FSlateRect	GetHitTestingBorder()
FVector2D	GetNodeMaximumSize()	Return largest desired node size
FVector2D	GetNodeMinimumSize()	Return smallest desired node size
float	GetTitleBarHeight()	Get the current titlebar size

Overridden from SGraphNode

		Name	Description
	bool	IsNameReadOnly()	Helper function to check if node can be renamed
	void	UpdateGraphNode()	Update this GraphNode to match the data that it is observing

Overridden from SWidget

	Name	Description
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.
FReply	OnMouseWheel ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	Called when the mouse wheel is spun. This event is bubbled.
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