Navigation
API > API/Developer > API/Developer/ProfileVisualizer
Profiler events tree. Contains a tree of profiler event for the selected graph bar.
| Name | SEventsTree |
| Type | class |
| Header File | /Engine/Source/Developer/ProfileVisualizer/Public/SEventsTree.h |
| Include Path | #include "SEventsTree.h" |
Syntax
class SEventsTree : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SEventsTree
- FSlateControlledConstruction → SWidget → SCompoundWidget → SEventsTree
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnEventSelectionChanged | TBaseDelegate_OneParam< void, TSharedPtr< FVisualizerEvent > > | Delegate used when the selection changes | SEventsTree.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NAME_DurationColumn | FName | Name of 'Duration' column | SEventsTree.h |
| NAME_NameColumn | FName | Name of 'Name' column | SEventsTree.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct the widget | SEventsTree.h | |
FString GetTabTitle() |
Gets a label for this events tree tab | SEventsTree.h | |
void HandleBarEventSelectionChanged
(
int32 Thread, |
Function called when the user selects an event bar in the graph | SEventsTree.h | |
void HandleBarGraphExpansionChanged
(
TSharedPtr< FVisualizerEvent > Selection |
Function called when the currently expanded bar graph changes | SEventsTree.h | |
void HandleBarGraphSelectionChanged
(
TSharedPtr< FVisualizerEvent > Selection |
Function called when the currently selected bar graph changes | SEventsTree.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CheckDurationUnits
(
EVisualizerTimeUnits::Type InUnits |
Gets the currently selected time units | SEventsTree.h | |
bool CheckViewMode
(
EVisualizerViewMode::Type InMode |
Given a view mode checks if it's the currently selected one | SEventsTree.h | |
int32 CountEvents
(
TArray< TSharedPtr< FVisualizerEvent > >& Events |
Recursively counts all events in the tree | SEventsTree.h | |
void CreateSelectedEventsView() |
Given the selected events from the bar graph creates a copy of the selection applying the current view and sorting mode | SEventsTree.h | |
TSharedPtr< FVisualizerEvent > CreateSelectedEventsViewRecursively
(
TSharedPtr< FVisualizerEvent > SourceEvent |
Helper function for creating a copy of the selected events in a hierarchy | SEventsTree.h | |
void CreateSelectedEventsViewRecursivelyAndFlatten
(
TSharedPtr< FVisualizerEvent > SourceEvent |
Helper function for creating a copy of the selected events and flattening the hierarchy | SEventsTree.h | |
void CreateSelectedEventsViewRecursivelyCoalesced
(
TArray< TSharedPtr< FVisualizerEvent > >& SourceEvents, |
Helper function for creating a copy of the selected events combining leaves with the same name | SEventsTree.h | |
void CreateSelectedEventsViewRecursivelyFlatCoalesced
(
TArray< TSharedPtr< FVisualizerEvent > >& SourceEvents |
Helper function for creating a copy of the selected events combining leaves with the same name and flattening the hierarchy | SEventsTree.h | |
bool FilterEvent
(
TSharedPtr< FVisualizerEvent > InEvent |
Checks if event name passes current filter | SEventsTree.h | |
EColumnSortMode::Type GetColumnSortMode
(
const FName ColumnId |
SEventsTree.h | ||
FText GetDurationColumnTitle() |
Gets the currently selected time units text | SEventsTree.h | |
double GetEventDuration
(
double InDurationMs |
Converts ms to currently selected time units. | SEventsTree.h | |
void OnColumnSortModeChanged
(
const EColumnSortPriority::Type SortPriority, |
Handles column sorting mode change | SEventsTree.h | |
void OnEventSelectionChanged
(
TSharedPtr< FVisualizerEvent > Selection, |
Function called when the currently selected event in the list of thread events changes | SEventsTree.h | |
void OnFilterTextChanged
(
const FText& InFilterText |
Called by the editable text control when the filter text is changed by the user | SEventsTree.h | |
void OnFilterTextCommitted
(
const FText& InFilterText, |
Called by the editable text control when a user presses enter or commits their text change | SEventsTree.h | |
TSharedRef< ITableRow > OnGenerateWidgetForEventsList
(
TSharedPtr< FVisualizerEvent > InItem, |
Generates SEventItem widgets for the events tree | SEventsTree.h | |
void OnGetChildrenForEventsList
(
TSharedPtr< FVisualizerEvent > InItem, |
Given a profiler event, generates children for it | SEventsTree.h | |
bool RestoreEventSelection
(
TArray< TSharedPtr< FVisualizerEvent > >& Events |
Restores event selection after changes to the tree | SEventsTree.h | |
void SetDurationUnits
(
EVisualizerTimeUnits::Type InUnits |
Sets 'Duration' column time units | SEventsTree.h | |
void SetViewMode
(
EVisualizerViewMode::Type InMode |
Sets the current view mode | SEventsTree.h | |
void SortEventsList () |
Sorts the selected events tree | SEventsTree.h | |
void SortEventsList
(
TArray< TSharedPtr< FVisualizerEvent > >& Events |
Recursively sorts the selected events tree | SEventsTree.h |