SBarVisualizer

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

Unreal Engine C++ API Reference > Developer > ProfileVisualizer

Inheritance Hierarchy

References

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

Syntax

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

Remarks

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

Variables

Type Name Description
TSharedPtr< SLi... BarGraphsList A pointer to the ListView of threads graph bars
bool bSuppressBarGraphSelectionChangedDelegate Should the OnBarGraphSelectionChangedDelegate be suppressed to avoid event loops
TArray< TShared... Graphs List of all SGraphBar widgets in the tree
FOnBarEventSele... OnBarEventSelectionChangedDelegate Delegate used when single event on the bar graph is selected
FOnBarGraphCont... OnBarGraphContextMenuDelegate Delegate used when the user right-clicks on a bar graph
FOnBarGraphExpa... OnBarGraphExpansionChangedDelegate Delegate used when bar graph selection changes
FOnBarGraphSele... OnBarGraphSelectionChangedDelegate Delegate used when bar graph selection changes
TSharedPtr< FVi... ProfileData Original profiler data
TArray< TShared... ProfileDataView Profiler data view (filtered data)
TSharedPtr< SSc... ScrollBar A pointer to the horizontal scrollbar widget
float ScrollbarOffset Scrollbar offset
TSharedPtr< FVi... SelectedBarGraph Currently selected bar graph
TSharedPtr< STi... Timeline A pointer to the horizontal scrollbar widget
EVisualizerView... ViewMode Bar visualizer view mode
TSharedPtr< STe... ZoomLabel A pointer to the Zoom Label widget
float ZoomSliderValue Zoom slider value

Functions

Type Name Description
void AdjustTimeline ( TSharedPtr< FVisualizerEvent > InEv... ) Adjusts timeline to match the selected event's start and duration
bool CheckViewMode ( EVisualizerViewMode::Type InMode ) Given a view mode checks if it's the currently selected one
void ClearBarSelection ( TSharedPtr< FVisualizerEvent > Grap..., TSharedPtr< FVisualizerEvent > Sele... ) Recursively clears selection on all bar graphs
void Construct ( const FArguments& InArgs ) Construct the widget
void CreateDataView () Creates filtered data
void CreateFlattenedData ( TSharedPtr< FVisualizerEvent > InDa..., TArray< TSharedPtr< FVisualizerEven... ) Creates flattened data view
FReply ExpandBar ( TSharedPtr< FVisualizerEvent > BarG... ) Called when the user clicked bar graph's expand button
TSharedPtr< ... FindSelectedEventsParent ( TArray< TSharedPtr< FVisualizerEven..., TSharedPtr< FVisualizerEvent > Sele... )  
EVisibility GetHomeButtonVisibility () Checks if home button should be visible
float GetMaxGraphOffset () Gets the maximum graph offset value for the graph bars
float GetMaxScrollOffsetFraction () Gets the maximum scroll offset fraction value for the horizontal scrollbar
FText GetSelectedCategoryName () Gets the currently displayed hierarchy node name
EVisibility GetToParentButtonVisibility () Checks if 'to parent' button should be visible
float GetZoom () Gets the actual zoom level for the graph bars
FText GetZoomLabel () Constructs the zoom label string based on the current zoom level value.
float GetZoomValue () Callback used to get the current zoom slider value.
void HandleEventSelectionChanged ( TSharedPtr< FVisualizerEvent > Sele... ) Handles selection change in the events tree
bool IsExpandable ( TSharedPtr< FVisualizerEvent > InEv... ) Checks if the selected event has children with children
void OnBarEventSelectionChanged ( TSharedPtr< FVisualizerEvent > Sele..., ESelectInfo::Type SelectInfo, int32 BarId ) Function called when the user selects an event bar in the graph
void OnBarGeometryChanged ( FGeometry Geometry ) Called when bar graph geometry (size) changes
void OnBarGraphSelectionChanged ( TSharedPtr< FVisualizerEvent > Sele..., ESelectInfo::Type SelectInfo ) Function called when the currently selected bar graph changes
FReply OnBarRightClicked ( const FGeometry& BarGeometry, const FPointerEvent& MouseEvent, TSharedPtr< FVisualizerEvent > Sele... ) Forwards right-click event to the visualizer main frame
TSharedRef< ... OnGenerateWidgetForList ( TSharedPtr< FVisualizerEvent > InIt..., const TSharedRef< STableViewBase > ... ) Generates SGraphBar widget for the threads list
void OnGetChildrenForList ( TSharedPtr< FVisualizerEvent > InIt..., TArray< TSharedPtr< FVisualizerEven... ) Generates children for the specified tree view item
FReply OnHomeClicked () Handles clickong on 'Home' button
void OnSetZoomValue ( float NewValue ) Callback used to handle zoom slider
FReply OnToParentClicked () Handles clicking on 'Back to parent' button
void ScrollBar_OnUserScrolled ( float InScrollOffsetFraction ) Callback for scrolling the horizontal scrollbar
void SetViewMode ( EVisualizerViewMode::Type InMode ) 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