You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
196cf342b5
#TTP 312311 - ROCKET: TASK: Add a "Documentation Node" #Branch UE4 #Proj BlueprintGraph, EdGraph, Kismet, KismetCompiler, GraphEditor, Documentation, EditorStyle #Change Updated UEdGraphSchema to include an interface call to retrieve an FEdGraphSchemaAction to create documentation nodes. At this point only the K2 interfaces implement this. #Change Updated UEdGraphSchema_K2 to include a call to retrieve an FEdGraphSchemaAction to create documentation nodes. This is used to add the actions to the blueprint palette and context menus. #Add Added FEdGraphSchemaAction_K2AddDocumentation in EdGraphSchema_K2_Actions.h/cpp to implement the calls in UEdGraphSchema to create documenation nodes from palette and context menus. #Change Modified FK2ActionMenuBuilder to provide a static call to create a documentation action in the same style as the comment. Additionally added calls to FK2ActionMenuBuilder::GetPaletteActions and FK2ActionMenuBuilder::GetContextAllowedNodeTypes to call this to add entries in the palette and context menus. #Add Added a new Brush GraphEditor.Documentation_16x, for the context menu icon in SlateEditorStyle.cpp. #Change Modified GetPaletteItemIcon in SBlueprintPalette.cpp to return the new icon for the DocumentationNode #Change Modified FKismetCompilerContext::IsNodePure to include the Documentaton node in the drop through ensure test to prevent asserts on compling if a documentation node is present. #Change Added an entry for Documentation node in FNodeFactory::CreateNodeWidget. #Change Modified IDocumentationPage interface to provide the ability to provide a TextWrapAt Attribute so this can be set before creating excerpt content if desired. #Change Modified the UDNParser to control text wrap at values in the created widgets using a float Attribute WrapAt, Added a set call in the DocumentationPage and made the default behaviour mimic the code it replaced. #Add Added the class UEdGraphNode_Documentation implemented in EdGraphNode_Documentation.h and UEdGraph.cpp, this is the UObject implementation for the documentation nodes. #Add Added the class SGraphNodeDocumentation as the GraphPanel implementation of the EdGraphNode_Documentation. #Change Moved the resizable code from SGraphNodeComment into a SGraphNodeResizable and changed SGraphNodeComment and SGraphNodeDocumentation inherit from it to avoid duplicating code. #Change Added a documentation specific details customisation so the excerpts can be displayed as combo button. #Change Added FBlueprintDocumentationDetails into BlueprintDetailsCustomization.h/cpp to handle the user interaction with the documentation node in the BP Editor. ReviewedBy Chris.Wood, Mike.Beach [CL 2247425 by Ben Cosh in Main branch]
65 lines
2.4 KiB
C++
65 lines
2.4 KiB
C++
// Copyright 1998-2013 Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
class IDocumentationPage;
|
|
|
|
class SGraphNodeDocumentation : public SGraphNodeResizable
|
|
{
|
|
public:
|
|
SLATE_BEGIN_ARGS(SGraphNodeDocumentation){}
|
|
SLATE_END_ARGS()
|
|
|
|
// Begin SPanel Interface
|
|
virtual FVector2D ComputeDesiredSize() const override;
|
|
// End SPanel interface
|
|
|
|
// Begin SWidget Interface
|
|
void Construct( const FArguments& InArgs, UEdGraphNode* InNode );
|
|
virtual FReply OnMouseWheel( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent );
|
|
virtual bool OnHitTest( const FGeometry& MyGeometry, FVector2D InAbsoluteCursorPosition ) override;
|
|
virtual void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
|
|
// End SWidget Interface
|
|
|
|
// Begin SGraphNodeResizable Interface
|
|
virtual FVector2D GetNodeMinimumSize() const override;
|
|
virtual FVector2D GetNodeMaximumSize() const override;
|
|
virtual float GetTitleBarHeight() const override;
|
|
virtual FSlateRect GetHitTestingBorder( float InverseZoomFactor ) const override;
|
|
// End SGraphNodeResizable Interface
|
|
|
|
protected:
|
|
|
|
// Begin SGraphNode Interface
|
|
virtual void UpdateGraphNode() override;
|
|
virtual bool IsNameReadOnly () const override { return false; }
|
|
// End SGraphNode Interface
|
|
|
|
/** Create documentation page from link and excerpt */
|
|
TSharedPtr<SWidget> CreateDocumentationPage();
|
|
/** Returns the width the documentation content must adhere to, used as a delegate in child widgets */
|
|
FOptionalSize GetContentWidth() const;
|
|
/** Returns the height the documentation content must adhere to, used as a delegate in child widgets */
|
|
FOptionalSize GetContentHeight() const;
|
|
/** Returns the child widget text wrapat size, used as a delegate during creation of documentation page */
|
|
float GetDocumentationWrapWidth() const;
|
|
/** Returns the current child widgets visibility for hit testing */
|
|
EVisibility GetWidgetVisibility() const;
|
|
|
|
private:
|
|
|
|
/** Node Title Bar */
|
|
TSharedPtr<SWidget> TitleBar;
|
|
/** Documentation excerpt maximum page size */
|
|
FVector2D DocumentationSize;
|
|
/** Content Widget with the desired size being managed */
|
|
TSharedPtr<SWidget> ContentWidget;
|
|
/** Tracks if child widgets are availble to hit test against */
|
|
EVisibility ChildWidgetVisibility;
|
|
/** Cached Documentation Link */
|
|
FString CachedDocumentationLink;
|
|
/** Cached Documentation Excerpt */
|
|
FString CachedDocumentationExcerpt;
|
|
|
|
};
|