1. Epic GamesDeveloper
  3. SBlueprintDiff

SBlueprintDiff

Visual Diff between two Blueprints

API > API/Editor > API/Editor/Kismet

Inheritance Hierarchy

References

   
Module Kismet
Header /Engine/Source/Editor/Kismet/Public/SBlueprintDiff.h
Include #include "SBlueprintDiff.h"

Syntax

class SBlueprintDiff : public SCompoundWidget

Remarks

Visual Diff between two Blueprints

Variables

  Type Name Description
Protected variable FDelegateHandle AssetEditorCloseDelegate  
Protected variable bool bLockViews If the two views should be locked
Protected variable bool bVerticalSplitGraphMode If the view on Graph Mode should be divided vertically
Protected variable FName CurrentMode  
Protected variable TSharedPtr< STreeView< TSharedPtr< FBlueprintDifferenceTreeEntry > > > DifferencesTreeView Tree view that displays the differences, cached for the buttons that iterate the differences:
Protected variable TSharedPtr< SSplitter > DiffGraphSplitter  
Protected variable TArray< TSharedPtr< FGraphToDiff > > Graphs List of graphs to diff, are added to panel last
Protected variable TSharedPtr< SSplitter > GraphToolBarWidget  
Protected variable TSharedPtr< SBox > ModeContents Contents widget that we swap when mode changes (defaults, components, etc)
Protected variable TMap< FName, FDiffControl > ModePanels Stored references to widgets used to display various parts of a blueprint, from the mode name
Protected variable FDiffPanel PanelNew  
Protected variable FDiffPanel PanelOld The two panels used to show the old & new revision
Protected variable TArray< TSharedPtr< class FBlueprintDifferenceTreeEntry > > PrimaryDifferencesList Tree of differences collected across all panels:
Protected variable TArray< TSharedPtr< class FBlueprintDifferenceTreeEntry > > RealDifferences List of all differences, cached so that we can iterate only the differences and not labels, etc:
Protected variable TSharedPtr< FTabManager > TabManager We can't use the global tab manager because we need to instance the diff control, so we have our own tab manager:
Protected variable TSharedPtr< SSplitter > TopRevisionInfoWidget  
Protected variable TWeakPtr< SWindow > WeakParentWindow A pointer to the window holding this

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

Construct ( const FArguments& InArgs
)

  
Public function Static TSharedPtr< SWindow >

CreateDiffWindow ( FText WindowTitle,
const UBlueprint* OldBlueprint,
const UBlueprint* NewBlueprint,
const FRevisionInfo& OldRevision,
const FRevisionInfo& NewRevision
)

 Helper function to create a window that holds a diff widget
Public function Static TSharedPtr< SWindow >

CreateDiffWindow ( const UBlueprint* OldBlueprint,
const UBlueprint* NewBlueprint,
const FRevisionInfo& OldRevision,
const FRevisionInfo& NewRevision,
const UClass* BlueprintClass
)

 Helper function to create a window that holds a diff widget that defaults a window title
Protected function void

CreateGraphEntry ( UEdGraph* GraphOld,
UEdGraph* GraphNew
)

 Create a list item entry graph that exists in at least one of the blueprints
Public function Static TSharedRef< SWidget > Helper function for generating an empty widget
Protected function void Disable the focus on a particular pin
Protected function FGraphToDiff *

FindGraphToDiffEntry ( const FString& GraphPath
)

 Find the FGraphToDiff that displays the graph with GraphPath relative path
Protected function void

FocusOnGraphRevisions ( FGraphToDiff* Diff
)

 Bring these revisions of graph into focus on main display
Protected function FDiffControl  
Protected function FDiffControl  
Protected function FDiffControl  
Protected function FDiffControl  
Protected function void Function used to generate the list of differences and the widgets needed to calculate that list
Protected function FDiffControl  
Protected function FDiffControl  
Protected function Const TSharedRef< SOverlay >  
Protected function FDiffControl  
Protected function Const TSharedRef< SBox >

GenerateRevisionInfoWidgetForPanel ( TSharedPtr< SWidget >& OutGeneratedWidget,
const FText& InRevisionText
)

  
Protected function Const FName  
Protected function FDiffPanel & Get Graph editor associated with this Graph
Protected function Const FSlateIcon Get the image to show for the toggle lock option
Protected function Const FSlateIcon Get the image to show for the toggle split view mode option
Protected function void

HandleGraphChanged ( const FString& GraphPath
)

 Event handler that updates the graph view when user selects a new graph
Protected function Const bool Called to determine whether we have a list of differences to cycle through
Protected function Const bool  
Protected function Const bool Checks if a graph is valid for diffing
Protected function void Called when user clicks button to go to next difference
Public function void

OnBlueprintChanged ( UBlueprint* InBlueprint
)

 Called when blueprint is modified
Protected function void

OnCloseAssetEditor ( UObject* Asset,
EAssetEditorCloseReason CloseReason
)

 Called when editor may need to be closed
Public function void Called when user clicks on an entry in the listview of differences
Public function void

OnGraphChanged ( FGraphToDiff* Diff
)

 Called when a new Graph is clicked on by user
Public function void

OnGraphSelectionChanged ( TSharedPtr< FGraphToDiff > Item,
ESelectInfo::Type SelectionType
)

 Called when user clicks on a new graph list item
Protected function Const void

OnModeChanged ( const FName& InNewViewMode
)

  
Protected function void User toggles the option to lock the views between the two blueprints
Protected function void User toggles the option to change the split view mode betwwen vertical and horizontal
Protected function void Called when user clicks button to go to prev difference
Protected function void Reset the graph editor, called when user switches graphs to display
Protected function void

SetCurrentMode ( FName NewMode
)

 Accessor and event handler for toggling between diff view modes (defaults, components, graph view, interface, macro):
Protected function Const void

UpdateTopSectionVisibility ( const FName& InNewViewMode
)

  

Overridden from SWidget

  Type Name Description
Public function Virtual void

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

 Ticks this widget with Geometry.

Classes

  Type Name Description
Public struct FArguments    
Protected struct FDiffControl    

Typedefs

Name Description
FOpenInDefaults  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page