SEventsTree

Profiler events tree. Contains a tree of profiler event for the selected graph bar.

Unreal Engine C++ API Reference > Developer > ProfileVisualizer

Inheritance Hierarchy

References

   
Module ProfileVisualizer
Header /Engine/Source/Developer/ProfileVisualizer/Public/SEventsTree.h
Include #include "SEventsTree.h"

Syntax

class SEventsTree : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)  

Remarks

Profiler events tree. Contains a tree of profiler event for the selected graph bar.

Variables

Type Name Description
bool bSuppressSelectionChangedEvent Suppresses SelectionChanged delegate to avoid event loops between graph visualizer and events tree
EVisualizerTime... DurationUnits Currently selected time units
TSharedPtr< STr... EventsListView A pointer to the ListView of profiler events
FString FilterText Events filter text
FOnEventSelecti... OnEventSelectionChangedDelegate Delegate used to notify when event selection changes
TSharedPtr< FVi... ProfileData Original profiler data
TArray< TShared... SelectedEvents List of events for the currently selected thread
TArray< TShared... SelectedEventsView List of events for the currently selected thread
TSharedPtr< FVi... SelectedThread Currently selected events for this tree
FName SortByColumn Specify which column to sort with
EColumnSortMode... SortMode Currently selected sorting mode
EVisualizerView... ViewMode Currently selected view mode
TMap< TSharedPt... ViewToEventsMap Maps the events generated using currently selected view and sorting modes to the source events tree

Functions

Type Name Description
bool CheckDurationUnits ( EVisualizerTimeUnits::Type InUnits ) Gets the currently selected time units
bool CheckViewMode ( EVisualizerViewMode::Type InMode ) Given a view mode checks if it's the currently selected one
void Construct ( const FArguments& InArgs ) Construct the widget
int32 CountEvents ( TArray< TSharedPtr< FVisualizerEven... ) Recursively counts all events in the tree
void CreateSelectedEventsView () Given the selected events from the bar graph creates a copy of the selection applying the current view and sorting mode
TSharedPtr< ... CreateSelectedEventsViewRecursively ( TSharedPtr< FVisualizerEvent > Sour... ) Helper function for creating a copy of the selected events in a hierarchy
void CreateSelectedEventsViewRecursivelyAndFlatten ( TSharedPtr< FVisualizerEvent > Sour... ) Helper function for creating a copy of the selected events and flattening the hierarchy
void CreateSelectedEventsViewRecursivelyCoalesced ( TArray< TSharedPtr< FVisualizerEven..., TArray< TSharedPtr< FVisualizerEven..., TSharedPtr< FVisualizerEvent > InPa... ) Helper function for creating a copy of the selected events combining leaves with the same name
void CreateSelectedEventsViewRecursivelyFlatCoalesced ( TArray< TSharedPtr< FVisualizerEven... ) Helper function for creating a copy of the selected events combining leaves with the same name and flattening the hierarchy
bool FilterEvent ( TSharedPtr< FVisualizerEvent > InEv... ) Checks if event name passes current filter
EColumnSortM... GetColumnSortMode ( const FName ColumnId )  
FText GetDurationColumnTitle () Gets the currently selected time units text
double GetEventDuration ( double InDurationMs ) Converts ms to currently selected time units.
FString GetTabTitle () Gets a label for this events tree tab
void HandleBarEventSelectionChanged ( int32 Thread, TSharedPtr< FVisualizerEvent > Sele... ) Function called when the user selects an event bar in the graph
void HandleBarGraphExpansionChanged ( TSharedPtr< FVisualizerEvent > Sele... ) Function called when the currently expanded bar graph changes
void HandleBarGraphSelectionChanged ( TSharedPtr< FVisualizerEvent > Sele... ) Function called when the currently selected bar graph changes
void OnColumnSortModeChanged ( const EColumnSortPriority::Type Sor..., const FName& ColumnId, const EColumnSortMode::Type InSortM... ) Handles column sorting mode change
void OnEventSelectionChanged ( TSharedPtr< FVisualizerEvent > Sele..., ESelectInfo::Type SelectInfo ) Function called when the currently selected event in the list of thread events changes
void OnFilterTextChanged ( const FText& InFilterText ) Called by the editable text control when the filter text is changed by the user
void OnFilterTextCommitted ( const FText& InFilterText, ETextCommit::Type CommitInfo ) Called by the editable text control when a user presses enter or commits their text change
TSharedRef< ... OnGenerateWidgetForEventsList ( TSharedPtr< FVisualizerEvent > InIt..., const TSharedRef< STableViewBase > ... ) Generates SEventItem widgets for the events tree
void OnGetChildrenForEventsList ( TSharedPtr< FVisualizerEvent > InIt..., TArray< TSharedPtr< FVisualizerEven... ) Given a profiler event, generates children for it
bool RestoreEventSelection ( TArray< TSharedPtr< FVisualizerEven... ) Restores event selection after changes to the tree
void SetDurationUnits ( EVisualizerTimeUnits::Type InUnits ) Sets 'Duration' column time units
void SetViewMode ( EVisualizerViewMode::Type InMode ) Sets the current view mode
void SortEventsList () Sorts the selected events tree
void SortEventsList ( TArray< TSharedPtr< FVisualizerEven... ) Recursively sorts the selected events tree

Classes

Type Name Description
Public struct FArguments  

Typedefs

Name Description
FOnEventSelectionChanged Delegate used when the selection changes

Constants

Name Description
NAME_DurationColumn Name of 'Duration' column
NAME_NameColumn Name of 'Name' column

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library