1. Epic GamesDeveloper
  3. SBarVisualizer

SBarVisualizer

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

API > API/Developer > API/Developer/ProfileVisualizer

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

   
Name SBarVisualizer
Type class
Header File /Engine/Source/Developer/ProfileVisualizer/Public/SBarVisualizer.h
Include Path #include "SBarVisualizer.h"

Syntax

class SBarVisualizer : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FOnBarEventSelectionChanged TBaseDelegate_TwoParams< void, int32, TSharedPtr< FVisualizerEvent > > Delegate used when a single event on the bar graph is selected SBarVisualizer.h
FOnBarGraphContextMenu TBaseDelegate_TwoParams< void, TSharedPtr< FVisualizerEvent >, const FPointerEvent & > Delegate used when the user right-clicks on a bar graph SBarVisualizer.h
FOnBarGraphExpansionChanged TBaseDelegate_OneParam< void, TSharedPtr< FVisualizerEvent > > Delegate used when bar graph expansion changes SBarVisualizer.h
FOnBarGraphSelectionChanged TBaseDelegate_OneParam< void, TSharedPtr< FVisualizerEvent > > Delegate used when bar graph selection changes SBarVisualizer.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

 Construct the widget SBarVisualizer.h  

void HandleEventSelectionChanged ( TSharedPtr< FVisualizerEvent > Selection
)

 Handles selection change in the events tree SBarVisualizer.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AdjustTimeline ( TSharedPtr< FVisualizerEvent > InEvent
)

 Adjusts timeline to match the selected event's start and duration SBarVisualizer.h  

bool CheckViewMode ( EVisualizerViewMode::Type InMode
) const

 Given a view mode checks if it's the currently selected one SBarVisualizer.h  

void ClearBarSelection ( TSharedPtr< FVisualizerEvent > GraphEvents,
TSharedPtr< FVisualizerEvent > Selection
)

 Recursively clears selection on all bar graphs SBarVisualizer.h  

void CreateDataView()

 Creates filtered data SBarVisualizer.h  

void CreateFlattenedData ( TSharedPtr< FVisualizerEvent > InData,
TArray< TSharedPtr< FVisualizerEvent > >& FlattenedData
)

 Creates flattened data view SBarVisualizer.h  

FReply ExpandBar ( TSharedPtr< FVisualizerEvent > BarGraphEvents
)

 Called when the user clicked bar graph's expand button SBarVisualizer.h  

TSharedPtr< FVisualizerEvent > FindSelectedEventsParent ( TArray< TSharedPtr< FVisualizerEvent > >& BarGraphs,
TSharedPtr< FVisualizerEvent > Selection
)

   SBarVisualizer.h  

EVisibility GetHomeButtonVisibility()

 Checks if home button should be visible SBarVisualizer.h  

float GetMaxGraphOffset()

 Gets the maximum graph offset value for the graph bars SBarVisualizer.h  

float GetMaxScrollOffsetFraction()

 Gets the maximum scroll offset fraction value for the horizontal scrollbar SBarVisualizer.h  

FText GetSelectedCategoryName()

 Gets the currently displayed hierarchy node name SBarVisualizer.h  

EVisibility GetToParentButtonVisibility()

 Checks if 'to parent' button should be visible SBarVisualizer.h  

float GetZoom()

 Gets the actual zoom level for the graph bars SBarVisualizer.h  

FText GetZoomLabel()

 Constructs the zoom label string based on the current zoom level value. SBarVisualizer.h  

float GetZoomValue()

 Callback used to get the current zoom slider value. SBarVisualizer.h  

bool IsExpandable ( TSharedPtr< FVisualizerEvent > InEvent
)

 Checks if the selected event has children with children SBarVisualizer.h  

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

 Function called when the user selects an event bar in the graph SBarVisualizer.h  

void OnBarGeometryChanged ( FGeometry Geometry
)

 Called when bar graph geometry (size) changes SBarVisualizer.h  

void OnBarGraphSelectionChanged ( TSharedPtr< FVisualizerEvent > Selection,
ESelectInfo::Type SelectInfo
)

 Function called when the currently selected bar graph changes SBarVisualizer.h  

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

 Forwards right-click event to the visualizer main frame SBarVisualizer.h  

TSharedRef< ITableRow > OnGenerateWidgetForList ( TSharedPtr< FVisualizerEvent > InItem,
const TSharedRef< STableViewBase >& OwnerTable
)

 Generates SGraphBar widget for the threads list SBarVisualizer.h  

void OnGetChildrenForList ( TSharedPtr< FVisualizerEvent > InItem,
TArray< TSharedPtr< FVisualizerEvent > >& OutChildren
)

 Generates children for the specified tree view item SBarVisualizer.h  

FReply OnHomeClicked()

 Handles clickong on 'Home' button SBarVisualizer.h  

void OnSetZoomValue ( float NewValue
)

 Callback used to handle zoom slider SBarVisualizer.h  

FReply OnToParentClicked()

 Handles clicking on 'Back to parent' button SBarVisualizer.h  

void ScrollBar_OnUserScrolled ( float InScrollOffsetFraction
)

 Callback for scrolling the horizontal scrollbar SBarVisualizer.h  

void SetViewMode ( EVisualizerViewMode::Type InMode
)

 Sets the current view mode SBarVisualizer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page