Navigation
API > API/Runtime > API/Runtime/Chaos
Inheritance Hierarchy
- FBaseRewindHistory
- TDataRewindHistory
References
| Module | Chaos |
| Header | /Engine/Source/Runtime/Experimental/Chaos/Public/RewindData.h |
| Include | #include "RewindData.h" |
Syntax
template<typename DataType>
struct TDataRewindHistory : public Chaos::FBaseRewindHistory
Remarks
Templated data history holding a data buffer
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bIsLocalHistory | Check if the history is on the local/remote client | |
| int32 | CurrentFrame | Current frame that is being loaded/recorded | |
| int32 | CurrentIndex | Current index that is being loaded/recorded | |
| TArray< DataType > | DataHistory | Data buffer holding the history | |
| int32 | LatestFrame | The most up to date frame entry in history | |
| int32 | NumFrames | Number of frames in data history |
Constructors
| Type | Name | Description | |
|---|---|---|---|
TDataRewindHistory
(
const int32 FrameCount |
|||
TDataRewindHistory
(
const int32 FrameCount, |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| int32 | ClosestData
(
const int32 DataFrame, |
Get the closest (min/max) valid data from the data frame | |
| int32 | ClosestDatas
(
const int32 DatasFrame, |
||
| bool | Eval the data from the buffer at a specific frame | ||
| bool | |||
| const DataType & | |||
| DataType & | Current data that is being loaded/recorded | ||
| const DataType & | |||
| DataType & | |||
| TArray< DataType > & | |||
| TArray< DataType > & | |||
| const uint32 | GetFrameIndex
(
const int32 Frame |
||
| bool | Load the data from the buffer at a specific frame | ||
| bool | |||
| uint32 | NumValidData
(
const uint32 StartFrame, |
Get the number of valid data in the buffer index range | |
| uint32 | NumValidDatas
(
const uint32 StartFrame, |
Overridden from FBaseRewindHistory
| Type | Name | Description | |
|---|---|---|---|
| bool | ExtractData
(
const int32 ExtractFrame, |
Extract states at a given time | |
| const int32 | Return the least up to date frame entry in history | ||
| const int32 | Return the max size of the history | ||
| const int32 | Return the most up to date frame entry in history | ||
| const bool | Return if history has valid data | ||
| bool | HasValidData
(
const int32 ValidFrame |
Check if the history buffer contains an entry for the given frame | |
| void | Initialize () |
Initialize history | |
| void | Iterate over and merge data | ||
| bool | RecordData
(
const int32 RecordFrame, |
Record the data from the buffer at a specific frame | |
| void | ResetFast () |
Perform a fast reset, marking the data history as reset but not clearing the data or resetting collections | |
| void | ResizeDataHistory
(
const int32 FrameCount, |
Resize the history |