1. Epic GamesDeveloper
  3. SEventsTree

SEventsTree

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

API > API/Developer > API/Developer/ProfileVisualizer

Inheritance Hierarchy

References

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

Syntax

class SEventsTree : public SCompoundWidget

Remarks

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

Variables

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

Functions

  Type Name Description
Protected function Const bool Gets the currently selected time units
Protected function Const bool Given a view mode checks if it's the currently selected one
Public function void

Construct ( const FArguments& InArgs
)

 Construct the widget
Protected function int32 Recursively counts all events in the tree
Protected function void Given the selected events from the bar graph creates a copy of the selection applying the current view and sorting mode
Protected function TSharedPtr< FVisualizerEvent > Helper function for creating a copy of the selected events in a hierarchy
Protected function void Helper function for creating a copy of the selected events and flattening the hierarchy
Protected function void Helper function for creating a copy of the selected events combining leaves with the same name
Protected function void Helper function for creating a copy of the selected events combining leaves with the same name and flattening the hierarchy
Protected function Const bool Checks if event name passes current filter
Protected function EColumnSortMode::Type

GetColumnSortMode ( const FName ColumnId
)

  
Protected function Const FText Gets the currently selected time units text
Protected function Const double

GetEventDuration ( double InDurationMs
)

 Converts ms to currently selected time units.
Public function Const FString Gets a label for this events tree tab
Public function void Function called when the user selects an event bar in the graph
Public function void Function called when the currently expanded bar graph changes
Public function void Function called when the currently selected bar graph changes
Protected function void

OnColumnSortModeChanged ( const EColumnSortPriority::Type SortPriority,
const FName& ColumnId,
const EColumnSortMode::Type InSortMode
)

 Handles column sorting mode change
Protected function void Function called when the currently selected event in the list of thread events changes
Protected function void

OnFilterTextChanged ( const FText& InFilterText
)

 Called by the editable text control when the filter text is changed by the user
Protected function void

OnFilterTextCommitted ( const FText& InFilterText,
ETextCommit::Type CommitInfo
)

 Called by the editable text control when a user presses enter or commits their text change
Protected function TSharedRef< ITableRow > Generates SEventItem widgets for the events tree
Protected function void Given a profiler event, generates children for it
Protected function bool Restores event selection after changes to the tree
Protected function void Sets 'Duration' column time units
Protected function void Sets the current view mode
Protected function void Sorts the selected events tree
Protected function void 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

On this page