1. Epic GamesDeveloper
  3. SBarVisualizer

SBarVisualizer

Bars Visualizer. Contains a list of bars for each profiler category

API > API/Developer > API/Developer/ProfileVisualizer

Inheritance Hierarchy

References

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

Syntax

class SBarVisualizer : public SCompoundWidget

Remarks

Bars Visualizer. Contains a list of bars for each profiler category

Variables

  Type Name Description
Protected variable TSharedPtr< SListView< TSharedPtr< FVisualizerEvent > > > BarGraphsList A pointer to the ListView of threads graph bars
Protected variable bool bSuppressBarGraphSelectionChangedDelegate Should the OnBarGraphSelectionChangedDelegate be suppressed to avoid event loops
Protected variable TArray< TSharedPtr< SGraphBar > > Graphs List of all SGraphBar widgets in the tree
Protected variable FOnBarEventSelectionChanged OnBarEventSelectionChangedDelegate Delegate used when single event on the bar graph is selected
Protected variable FOnBarGraphContextMenu OnBarGraphContextMenuDelegate Delegate used when the user right-clicks on a bar graph
Protected variable FOnBarGraphExpansionChanged OnBarGraphExpansionChangedDelegate Delegate used when bar graph selection changes
Protected variable FOnBarGraphSelectionChanged OnBarGraphSelectionChangedDelegate Delegate used when bar graph selection changes
Protected variable TSharedPtr< FVisualizerEvent > ProfileData Original profiler data
Protected variable TArray< TSharedPtr< FVisualizerEvent > > ProfileDataView Profiler data view (filtered data)
Protected variable TSharedPtr< SScrollBar > ScrollBar A pointer to the horizontal scrollbar widget
Protected variable float ScrollbarOffset Scrollbar offset
Protected variable TSharedPtr< FVisualizerEvent > SelectedBarGraph Currently selected bar graph
Protected variable TSharedPtr< STimeline > Timeline A pointer to the horizontal scrollbar widget
Protected variable EVisualizerViewMode::Type ViewMode Bar visualizer view mode
Protected variable TSharedPtr< STextBlock > ZoomLabel A pointer to the Zoom Label widget
Protected variable float ZoomSliderValue Zoom slider value

Functions

  Type Name Description
Protected function void Adjusts timeline to match the selected event's start and duration
Protected function Const bool Given a view mode checks if it's the currently selected one
Protected function void Recursively clears selection on all bar graphs
Public function void

Construct ( const FArguments& InArgs
)

 Construct the widget
Protected function void Creates filtered data
Protected function void Creates flattened data view
Protected function FReply

ExpandBar ( TSharedPtr< FVisualizerEvent > BarGraphEvents
)

 Called when the user clicked bar graph's expand button
Protected function TSharedPtr< FVisualizerEvent >  
Protected function Const EVisibility Checks if home button should be visible
Protected function Const float Gets the maximum graph offset value for the graph bars
Protected function Const float Gets the maximum scroll offset fraction value for the horizontal scrollbar
Protected function Const FText Gets the currently displayed hierarchy node name
Protected function Const EVisibility Checks if 'to parent' button should be visible
Protected function Const float

GetZoom ()

 Gets the actual zoom level for the graph bars
Protected function Const FText Constructs the zoom label string based on the current zoom level value.
Protected function Const float Callback used to get the current zoom slider value.
Public function void Handles selection change in the events tree
Protected function bool Checks if the selected event has children with children
Protected function void

OnBarEventSelectionChanged ( TSharedPtr< FVisualizerEvent > Selection,
ESelectInfo::Type SelectInfo,
int32 BarId
)

 Function called when the user selects an event bar in the graph
Protected function void Called when bar graph geometry (size) changes
Protected function void Function called when the currently selected bar graph changes
Protected function FReply

OnBarRightClicked ( const FGeometry& BarGeometry,
const FPointerEvent& MouseEvent,
TSharedPtr< FVisualizerEvent > Selection
)

 Forwards right-click event to the visualizer main frame
Protected function TSharedRef< ITableRow > Generates SGraphBar widget for the threads list
Protected function void Generates children for the specified tree view item
Protected function FReply Handles clickong on 'Home' button
Protected function void

OnSetZoomValue ( float NewValue
)

 Callback used to handle zoom slider
Protected function FReply Handles clicking on 'Back to parent' button
Protected function void

ScrollBar_OnUserScrolled ( float InScrollOffsetFraction
)

 Callback for scrolling the horizontal scrollbar
Protected function void Sets the current view mode

Classes

  Type Name Description
Public struct FArguments    

Typedefs

Name Description
FOnBarEventSelectionChanged Delegate used when a single event on the bar graph is selected
FOnBarGraphContextMenu Delegate used when the user right-clicks on a bar graph
FOnBarGraphExpansionChanged Delegate used when bar graph expansion changes
FOnBarGraphSelectionChanged Delegate used when bar graph selection changes

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page