Navigation
API > API/Editor > API/Editor/StatsViewer
The public interface for a stats page.
The table does its best to display the relevant information.
Objects UCLASS metadata required are: DisplayName - The name displayed in the page selection dropdown. Tooltip - The tooltip displayed in the page selection dropdown. ObjectSetType - A text representation of the UENUM used for object set enumeration.
The object set UENUM also uses metadata to display certain information. UENUM metadata syntax differs from UCLASS metadata as it is specified via the UMETA() tag, rather than meta=() UPROPERTY subtags. DisplayName - The name displayed in the object set dropdown. ToolTip - The tooltip displayed over the object set dropdown.
The UI supports the following UPROPERTY metadata: ColumnWidth - Integer value. The (proportionally-based, not absolute) width of the properties column. ShowTotal - Either true or false. Whether the column header should attempt to show a total (provided in Generate() via the OutTotals map). SortMode - Either Ascending or Descending. If this is specified then the properties column will be sorted on table creation. Unit - Text value displayed next to table entries and totals
| Name | IStatsPage |
| Type | class |
| Header File | /Engine/Source/Editor/StatsViewer/Public/IStatsPage.h |
| Include Path | #include "IStatsPage.h" |
Syntax
class IStatsPage
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddEntry
(
UObject* InEntry |
Adds a stats entry to the page Not all pages have to override this - only ones that accept transient data output from processes that do not persist in the editor | IStatsPage.h | |
virtual void Clear() |
Clears any entries added via AddEntry() Not all pages have to override this - only ones that accept transient data output from processes that do not persist in the editor | IStatsPage.h | |
void Generate
(
TArray< TWeakObjectPtr< UObject > >& OutObjects |
Fill the output array with statistic objects to be displayed | IStatsPage.h | |
void GenerateTotals
(
const TArray< TWeakObjectPtr< UObject > >& InObjects, |
Totals are displayed by mapping the CPP name of the columns property to the total string in the OutTotals map. | IStatsPage.h | |
void GetCustomColumns
(
TArray< TSharedRef< class IPropertyTableCustomColumn > >& OutCustomColumns |
Get any column customizations that this page wants to use. | IStatsPage.h | |
TSharedPtr< SWidget > GetCustomFilter
(
TWeakPtr< class IStatsViewer > InParentStatsViewer |
Get custom filter to display in the top part of the stats viewer, can return nullptr | IStatsPage.h | |
TSharedPtr< SWidget > GetCustomWidget
(
TWeakPtr< class IStatsViewer > InParentStatsViewer |
Get custom widget to display in the top part of the stats viewer, can return nullptr | IStatsPage.h | |
const FText GetDisplayName() |
Get the name of the entry type to be displayed in the page selection dropdown | IStatsPage.h | |
UClass * GetEntryClass() |
Get the class of the entry we handle This is needed to display the search filter's combo button | IStatsPage.h | |
FName GetName() |
Get the name of the entry type | IStatsPage.h | |
int32 GetObjectSetCount() |
Get the number of object sets this page supports | IStatsPage.h | |
FString GetObjectSetName
(
int32 InObjectSetIndex |
Get the name of the object set, to be displayed in the dropdown | IStatsPage.h | |
FString GetObjectSetToolTip
(
int32 InObjectSetIndex |
Get the tooltip of the object set, to be displayed over the object set the dropdown | IStatsPage.h | |
int32 GetSelectedObjectSet() |
Get the currently displayed object set | IStatsPage.h | |
const FText GetToolTip() |
Get the tooltip to be displayed over the page selection dropdown | IStatsPage.h | |
UWorld * GetWorld() |
Get the world used for page statistics. | IStatsPage.h | |
bool IsRefreshPending() |
Check if this page wants to refresh itself | IStatsPage.h | |
bool IsShowPending() |
Check if this page wants to show itself | IStatsPage.h | |
virtual void OnHide() |
Called back each time the page is hidden | IStatsPage.h | |
virtual void OnShow
(
TWeakPtr< class IStatsViewer > InParentStatsViewer |
Called back each time the page is shown | IStatsPage.h | |
void Refresh
(
bool bRefresh |
Sends a requests to the stats page to refresh itself the next chance it gets | IStatsPage.h | |
void SetSelectedObjectSet
(
int32 InObjectSetIndex |
Set the currently displayed object set | IStatsPage.h | |
void SetWorld
(
UWorld& InWorld |
Set a specific world to use for page statistics. | IStatsPage.h | |
void Show
(
bool bShow |
Tries to switch the currently displayed page to this one | IStatsPage.h |