Navigation
API > API/Editor > API/Editor/GraphEditor
| Name | SGraphNodeDocumentation |
| Type | class |
| Header File | /Engine/Source/Editor/GraphEditor/Public/SGraphNodeDocumentation.h |
| Include Path | #include "SGraphNodeDocumentation.h" |
Syntax
class SGraphNodeDocumentation : public SGraphNodeResizable
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SPanel → SNodePanel::SNode → SGraphNode → SGraphNodeResizable → SGraphNodeDocumentation
- FSlateControlledConstruction → SWidget → SPanel → SNodePanel::SNode → SGraphNode → SGraphNodeResizable → SGraphNodeDocumentation
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedDocumentationExcerpt | FString | Cached Documentation Excerpt | SGraphNodeDocumentation.h | |
| CachedDocumentationLink | FString | Cached Documentation Link | SGraphNodeDocumentation.h | |
| ChildWidgetVisibility | EVisibility | Tracks if child widgets are availble to hit test against | SGraphNodeDocumentation.h | |
| ContentWidget | TSharedPtr< SWidget > | Content Widget with the desired size being managed | SGraphNodeDocumentation.h | |
| DocumentationSize | FVector2f | Documentation excerpt maximum page size | SGraphNodeDocumentation.h | |
| TitleBar | TSharedPtr< SWidget > | Node Title Bar | SGraphNodeDocumentation.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs, |
SGraphNodeDocumentation.h | ||
virtual FReply OnMouseWheel
(
const FGeometry& MyGeometry, |
SGraphNodeDocumentation.h |
Overridden from SGraphNodeResizable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FSlateRect GetHitTestingBorder() |
SGraphNodeDocumentation.h | ||
virtual FVector2f GetNodeMaximumSize2f() |
SGraphNodeDocumentation.h | ||
virtual FVector2f GetNodeMinimumSize2f() |
SGraphNodeDocumentation.h | ||
virtual float GetTitleBarHeight() |
Get the current titlebar size | SGraphNodeDocumentation.h |
Overridden from SGraphNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Tick
(
const FGeometry& AllottedGeometry, |
SGraphNodeDocumentation.h |
Overridden from SNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
SGraphNodeDocumentation.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< SWidget > CreateDocumentationPage() |
Create documentation page from link and excerpt | SGraphNodeDocumentation.h | |
FOptionalSize GetContentHeight() |
Returns the height the documentation content must adhere to, used as a delegate in child widgets | SGraphNodeDocumentation.h | |
FOptionalSize GetContentWidth() |
Returns the width the documentation content must adhere to, used as a delegate in child widgets | SGraphNodeDocumentation.h | |
FText GetDocumentationTitle() |
Retrieves the current documentation title based on the chosen excerpt | SGraphNodeDocumentation.h | |
float GetDocumentationWrapWidth() |
Returns the child widget text wrapat size, used as a delegate during creation of documentation page | SGraphNodeDocumentation.h | |
FLinearColor GetPageGradientEndColor() |
Color of the page gradient end | SGraphNodeDocumentation.h | |
FLinearColor GetPageGradientStartColor() |
Color of the page gradient start | SGraphNodeDocumentation.h | |
EVisibility GetWidgetVisibility() |
Returns the current child widgets visibility for hit testing | SGraphNodeDocumentation.h |
Overridden from SGraphNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsNameReadOnly() |
Helper function to check if node can be renamed | SGraphNodeDocumentation.h | |
virtual void UpdateGraphNode() |
Update this GraphNode to match the data that it is observing | SGraphNodeDocumentation.h |