Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Custom state interface
| Name | IDisplayClusterCustomState |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Cluster/CustomStates/IDisplayClusterCustomState.h |
| Include Path | #include "Cluster/CustomStates/IDisplayClusterCustomState.h" |
Syntax
class IDisplayClusterCustomState
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDisplayClusterCustomState() |
Cluster/CustomStates/IDisplayClusterCustomState.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FName GetName() |
Returns custom state's unique name | Cluster/CustomStates/IDisplayClusterCustomState.h | |
void Lock() |
Lock this state to prevent any changes | Cluster/CustomStates/IDisplayClusterCustomState.h | |
void Serialize
(
FArchive& Ar |
SerializationIt's used to serialize data of a custom state into an output buffer | Cluster/CustomStates/IDisplayClusterCustomState.h | |
void Unlock() |
Enable any changes after Lock() call | Cluster/CustomStates/IDisplayClusterCustomState.h | |
| Deserialization | Cluster/CustomStates/IDisplayClusterCustomState.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AdvanceFrame() |
Progress to the next frame | Cluster/CustomStates/IDisplayClusterCustomState.h | |
| Returns type identificator | Cluster/CustomStates/IDisplayClusterCustomState.h | ||
virtual TSet< FName > GetUpstreams () |
Returns set of node IDs that this custom state is expecting to get updates from. | Cluster/CustomStates/IDisplayClusterCustomState.h | |
virtual bool HasCustomUpstreamConfiguration () |
Whether this state requires some custom update path. | Cluster/CustomStates/IDisplayClusterCustomState.h | |
virtual bool ShouldPropagate() |
Whether this state should propagate its data to any other cluster nodes | Cluster/CustomStates/IDisplayClusterCustomState.h |