1. Epic GamesDeveloper
  3. SDetailsDiff

SDetailsDiff

Visual Diff between two Assets

API > API/Editor > API/Editor/Kismet

Inheritance Hierarchy

References

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

Syntax

class SDetailsDiff : public SCompoundWidget

Remarks

Visual Diff between two Assets

Variables

  Type Name Description
Protected variable FDelegateHandle AssetEditorCloseDelegate  
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< 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 an object, from the mode name
Protected variable FOnSetOutputObjectEvent OnOutputObjectSetEvent  
Public variable FOnWindowClosedEvent OnWindowClosedEvent  
Protected variable UObject * OutputObjectModified  
Protected variable const UObject * OutputObjectUnmodified If set, actions like "Choose Left" and "Choose Right" will be enabled and modify the OutputObject
Protected variable FDetailsDiffPanel PanelNew  
Protected variable FDetailsDiffPanel 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 TSharedRef< SDetailsDiff >

CreateDiffWindow ( FText WindowTitle,
const UObject* OldObject,
const UObject* NewObject,
const FRevisionInfo& OldRevision,
const FRevisionInfo& NewRevision
)

 Helper function to create a window that holds a diff widget
Public function Static TSharedRef< SDetailsDiff >

CreateDiffWindow ( const UObject* OldObject,
const UObject* NewObject,
const FRevisionInfo& OldRevision,
const FRevisionInfo& NewRevision,
const UClass* ObjectClass
)

 Helper function to create a window that holds a diff widget (default window title)
Public function Static TSharedRef< SWidget > Helper function for generating an empty widget
Protected function FDiffControl  
Protected function void Function used to generate the list of differences and the widgets needed to calculate that list
Protected function Const TSharedRef< SBox >

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

  
Protected function Const FName  
Public function Const void

GetModifications ( FArchive& Archive
)

 Return a serialized buffer of change requests made by the user
Protected function Const bool Called to determine whether we have a list of differences to cycle through
Protected function Const bool  
Public function Const bool Returns whether SetOutputObject was called with a valid object
Protected function void Called when user clicks button to go to next difference
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
Protected function Const void

OnModeChanged ( const FName& InNewViewMode
)

  
Protected function void Called when user clicks button to go to prev difference
Public function Const void Submit an archive with change requests to make to OutputObject
Protected function void

SetCurrentMode ( FName NewMode
)

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

SetOutputObject ( const UObject* OutputObject
)

 Enables actions like "Choose Left" and "Choose Right" which will modify the OutputObject
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
FOnSetOutputObjectEvent  
FOnWindowClosedEvent  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page