FStatsPage

Template for all stats pages/factories.

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Protected variable

bool

 

bRefresh

Flag to refresh the page

Protected variable

bool

 

bShow

Flag to show the page

Protected variable

UEnum *

 

ObjectSetEnum

End IStatsPage interface The enum we use for our object set

Protected variable

int32

 

ObjectSetIndex

Selected object set index

Protected variable

TWeakObjectPtr<...

 

StatsWorld

The world to use for pages that need to query actors/components.

Constructors

Name Description

Public function

FStatsPage()

Destructors

Name Description

Public function Virtual

~FStatsPage()

Overridden from IStatsPage

Name Description

Public function Virtual Const

void

 

GetCustomColumns

(
    TArray< TSharedRef< class IProperty...
)

Get any column customizations that this page wants to use.

Public function Virtual

TSharedPtr< ...

 

GetCustomFilter

(
    TWeakPtr< class IStatsViewer > InPa...
)

Get custom filter to display in the top part of the stats viewer, can return nullptr

Public function Virtual

TSharedPtr< ...

 

GetCustomWidget

(
    TWeakPtr< class IStatsViewer > InPa...
)

Get custom widget to display in the top part of the stats viewer, can return nullptr

Public function Virtual Const

const FText

 

GetDisplayName()

Get the name of the entry type to be displayed in the page selection dropdown

Public function Virtual Const

UClass *

 

GetEntryClass()

Get the class of the entry we handle This is needed to display the search filter's combo button

Public function Virtual Const

FName

 

GetName()

Get the name of the entry type

Public function Virtual Const

int32

 

GetObjectSetCount()

Get the number of object sets this page supports

Public function Virtual Const

FString

 

GetObjectSetName

(
    int32 InObjectSetIndex
)

Get the name of the object set, to be displayed in the dropdown

Public function Virtual Const

FString

 

GetObjectSetToolTip

(
    int32 InObjectSetIndex
)

Get the tooltip of the object set, to be displayed over the object set the dropdown

Public function Virtual Const

int32

 

GetSelectedObjectSet()

Get the currently displayed object set

Public function Virtual Const

const FText

 

GetToolTip()

Get the tooltip to be displayed over the page selection dropdown

Public function Virtual Const

UWorld *

 

GetWorld()

Get the world used for page statistics.

Public function Virtual Const

bool

 

IsRefreshPending()

Check if this page wants to refresh itself

Public function Virtual Const

bool

 

IsShowPending()

Check if this page wants to show itself

Public function Virtual

void

 

Refresh

(
    bool bRefresh
)

Sends a requests to the stats page to refresh itself the next chance it gets

Public function Virtual

void

 

SetSelectedObjectSet

(
    int32 InObjectSetIndex
)

Set the currently displayed object set

Public function Virtual

void

 

SetWorld

(
    UWorld& InWorld
)

Set a specific world to use for page statistics.

Public function Virtual

void

 

Show

(
    bool bInShow
)

Begin IStatsPage interface