2014-12-07 19:09:38 -05:00
|
|
|
// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
Added a new documentation node to the blueprints to display udn documentation excerpts in the grapheditor.
#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]
2014-08-07 15:33:55 -04:00
|
|
|
class SGraphNodeComment : public SGraphNodeResizable
|
2014-03-14 14:13:41 -04:00
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
SLATE_BEGIN_ARGS(SGraphNodeComment){}
|
|
|
|
|
SLATE_END_ARGS()
|
|
|
|
|
|
|
|
|
|
// Begin SWidget Interface
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual FReply OnMouseButtonDoubleClick( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent ) override;
|
2014-12-05 05:33:22 -05:00
|
|
|
virtual FReply OnMouseButtonUp( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual void Tick(const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override;
|
|
|
|
|
virtual FReply OnDrop( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
|
|
|
|
|
virtual void OnDragEnter( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
|
2014-03-14 14:13:41 -04:00
|
|
|
// End SWidget Interface
|
|
|
|
|
|
|
|
|
|
// Begin SNodePanel::SNode interface
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual const FSlateBrush* GetShadowBrush(bool bSelected) const override;
|
2015-04-01 07:20:55 -04:00
|
|
|
virtual void GetOverlayBrushes(bool bSelected, const FVector2D WidgetSize, TArray<FOverlayBrushInfo>& Brushes) const override;
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual bool ShouldAllowCulling() const override { return false; }
|
2014-12-05 05:33:22 -05:00
|
|
|
virtual int32 GetSortDepth() const override;
|
2015-01-05 08:54:17 -05:00
|
|
|
virtual void EndUserInteraction() const override;
|
2015-04-28 04:58:34 -04:00
|
|
|
virtual FString GetNodeComment() const override;
|
2014-03-14 14:13:41 -04:00
|
|
|
// End SNodePanel::SNode interface
|
|
|
|
|
|
|
|
|
|
// Begin SPanel Interface
|
2015-01-14 19:04:45 -05:00
|
|
|
virtual FVector2D ComputeDesiredSize(float) const override;
|
2014-03-14 14:13:41 -04:00
|
|
|
// End SPanel interface
|
|
|
|
|
|
|
|
|
|
// Begin SGraphNode Interface
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual bool IsNameReadOnly() const override;
|
2014-11-03 10:40:57 -05:00
|
|
|
virtual FSlateColor GetCommentColor() const override { return GetCommentBodyColor(); }
|
|
|
|
|
// End SGraphNode Interface
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
void Construct( const FArguments& InArgs, UEdGraphNode* InNode );
|
|
|
|
|
|
|
|
|
|
/** return if the node can be selected, by pointing given location */
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual bool CanBeSelected( const FVector2D& MousePositionInNode ) const override;
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
/** return size of the title bar */
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual FVector2D GetDesiredSizeForMarquee() const override;
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
/** return rect of the title bar */
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual FSlateRect GetTitleRect() const override;
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
// SGraphNode Interface
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual void UpdateGraphNode() override;
|
2014-09-05 07:39:52 -04:00
|
|
|
virtual void PopulateMetaTag(class FGraphNodeMetaData* TagMeta) const override;
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Helper method to update selection state of comment and any nodes 'contained' within it
|
|
|
|
|
* @param bSelected If true comment is being selected, false otherwise
|
|
|
|
|
* @param bUpdateNodesUnderComment If true then force the rebuild of the list of nodes under the comment
|
|
|
|
|
*/
|
|
|
|
|
void HandleSelection(bool bIsSelected, bool bUpdateNodesUnderComment = false) const;
|
|
|
|
|
|
|
|
|
|
/** called when user is moving the comment node */
|
2014-06-13 06:14:46 -04:00
|
|
|
virtual void MoveTo(const FVector2D& NewPosition, FNodeSet& NodeFilter ) override;
|
2014-03-14 14:13:41 -04:00
|
|
|
|
Added a new documentation node to the blueprints to display udn documentation excerpts in the grapheditor.
#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]
2014-08-07 15:33:55 -04:00
|
|
|
// SGraphNodeResizable Interface
|
|
|
|
|
virtual float GetTitleBarHeight() const override;
|
|
|
|
|
virtual FSlateRect GetHitTestingBorder( float InverseZoomFactor ) const override;
|
|
|
|
|
virtual FVector2D GetNodeMaximumSize() const override;
|
|
|
|
|
// SGraphNodeResizable Interface
|
|
|
|
|
|
2014-03-14 14:13:41 -04:00
|
|
|
private:
|
|
|
|
|
|
|
|
|
|
/** @return the color to tint the comment body */
|
|
|
|
|
FSlateColor GetCommentBodyColor() const;
|
|
|
|
|
|
|
|
|
|
/** @return the color to tint the title bar */
|
|
|
|
|
FSlateColor GetCommentTitleBarColor() const;
|
|
|
|
|
|
2015-04-27 06:45:26 -04:00
|
|
|
/** @return the color to tint the comment bubble */
|
|
|
|
|
FSlateColor GetCommentBubbleColor() const;
|
|
|
|
|
|
2014-03-14 14:13:41 -04:00
|
|
|
/** Returns the width to wrap the text of the comment at */
|
|
|
|
|
float GetWrapAt() const;
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
|
|
/** The current selection state of the comment */
|
|
|
|
|
mutable bool bIsSelected;
|
|
|
|
|
|
|
|
|
|
/** the title bar, needed to obtain it's height */
|
|
|
|
|
TSharedPtr<SBorder> TitleBar;
|
|
|
|
|
|
|
|
|
|
/** cached comment title */
|
|
|
|
|
FString CachedCommentTitle;
|
|
|
|
|
|
|
|
|
|
/** cached comment title */
|
|
|
|
|
int32 CachedWidth;
|
|
|
|
|
};
|