Navigation
Unreal Engine C++ API Reference > Editor > StatsViewer
Inheritance Hierarchy
- IStatsPage
- FStatsPage
References
Module | StatsViewer |
Header | /Engine/Source/Editor/StatsViewer/Public/StatsPage.h |
Include | #include "StatsPage.h" |
Syntax
template<typename Entry>
class FStatsPage : public IStatsPage
Remarks
Template for all stats pages/factories. These classes generate uniform arrays of identically-typed objects that are displayed in a PropertyTable. Boilerplate implementations are below that all pages in this module currently more-or-less share
Variables
Type | Name | Description | |
---|---|---|---|
![]() |
bool | bRefresh | Flag to refresh the page |
![]() |
bool | bShow | Flag to show the page |
![]() |
UEnum * | ObjectSetEnum | End IStatsPage interface The enum we use for our object set |
![]() |
int32 | ObjectSetIndex | Selected object set index |
![]() |
TWeakObjectPtr< UWorld > | StatsWorld | The world to use for pages that need to query actors/components. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FStatsPage () |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
~FStatsPage () |
Overridden from IStatsPage
Type | Name | Description | |
---|---|---|---|
![]() ![]() ![]() |
void | GetCustomColumns
(
TArray< TSharedRef< class IPropertyTableCustomColumn > >& OutCustomColumns |
Get any column customizations that this page wants to use. |
![]() ![]() |
TSharedPtr< SWidget > | GetCustomFilter
(
TWeakPtr< class IStatsViewer > InParentStatsViewer |
Get custom filter to display in the top part of the stats viewer, can return nullptr |
![]() ![]() |
TSharedPtr< SWidget > | GetCustomWidget
(
TWeakPtr< class IStatsViewer > InParentStatsViewer |
Get custom widget to display in the top part of the stats viewer, can return nullptr |
![]() ![]() ![]() |
const FText | Get the name of the entry type to be displayed in the page selection dropdown | |
![]() ![]() ![]() |
UClass * | Get the class of the entry we handle This is needed to display the search filter's combo button | |
![]() ![]() ![]() |
FName | GetName () |
Get the name of the entry type |
![]() ![]() ![]() |
int32 | Get the number of object sets this page supports | |
![]() ![]() ![]() |
FString | GetObjectSetName
(
int32 InObjectSetIndex |
Get the name of the object set, to be displayed in the dropdown |
![]() ![]() ![]() |
FString | GetObjectSetToolTip
(
int32 InObjectSetIndex |
Get the tooltip of the object set, to be displayed over the object set the dropdown |
![]() ![]() ![]() |
int32 | Get the currently displayed object set | |
![]() ![]() ![]() |
const FText | GetToolTip () |
Get the tooltip to be displayed over the page selection dropdown |
![]() ![]() ![]() |
UWorld * | GetWorld () |
Get the world used for page statistics. |
![]() ![]() ![]() |
bool | Check if this page wants to refresh itself | |
![]() ![]() ![]() |
bool | Check if this page wants to show itself | |
![]() ![]() |
void | Refresh
(
bool bRefresh |
Sends a requests to the stats page to refresh itself the next chance it gets |
![]() ![]() |
void | SetSelectedObjectSet
(
int32 InObjectSetIndex |
Set the currently displayed object set |
![]() ![]() |
void | Set a specific world to use for page statistics. | |
![]() ![]() |
void | Show
(
bool bInShow |
Begin IStatsPage interface |