Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Custom state data class
Provides general control over local/cluster state data. Also manages game and render thread data.
| Name | TCustomStateData |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Cluster/CustomStates/DisplayClusterCustomStateBase.h |
| Include Path | #include "Cluster/CustomStates/DisplayClusterCustomStateBase.h" |
Syntax
template<typename TDataType>
class TCustomStateData : public UE::nDisplay::Private::FCustomStateBase
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TCustomStateData() |
Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Structs
| Name | Remarks |
|---|---|
| FCustomStateDataHolder | Auxiliary structure that holds all necessary data of a single state |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClusterStatesData | TSharedRef< TMap< FName, FCustomStateDataHolder< TDataType > > > | Holds data of this state on all nodes. | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
| NextFrameData | TDataType | Data to use on the next frame | Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const TDataType & GetData() |
Returns local state data bound to current thread and frame | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
void SetData
(
TValue&& NewData |
Sets new state data for the next frame. | Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Public Virtual
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AdvanceFrameData_GT() |
Game thread data update | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
void AdvanceFrameData_RT() |
Render thread data update | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
TSet< FName > GetNodes() |
Returns node IDs available in the storage | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
TDataType & GetThreadData () |
Internal thread sensitive getter of local state data | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
const TDataType & GetThreadData () |
Internal thread sensitive getter of local state data (const version) | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
const TDataType & GetThreadData
(
const FName& NodeId |
Internal thread sensitive getter of a specific node state data (const version) | Cluster/CustomStates/DisplayClusterCustomStateBase.h | |
TDataType & GetThreadData
(
const FName& NodeId, |
Internal thread sensitive getter of a specific node state data | Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsSetDataAllowed() |
Ask children whether SetData is allowed for the instance. | Cluster/CustomStates/DisplayClusterCustomStateBase.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static auto & GetThreadDataImpl
(
THolderType& Holder |
Internal helper to get data based on the current thread (for const and non-const callers) | Cluster/CustomStates/DisplayClusterCustomStateBase.h |