Navigation
API > API/Runtime > API/Runtime/Chaos
Templated data history holding a data buffer
| Name | TDataRewindHistory |
| Type | struct |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/RewindData.h |
| Include Path | #include "RewindData.h" |
Syntax
template<typename DataType>
struct TDataRewindHistory : public Chaos::FBaseRewindHistory
Inheritance Hierarchy
- FBaseRewindHistory → TDataRewindHistory
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TDataRewindHistory
(
const int32 FrameCount |
RewindData.h | ||
TDataRewindHistory
(
const int32 FrameCount, |
RewindData.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~TDataRewindHistory() |
RewindData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool EvalData
(
const int32 EvalFrame |
Eval the data from the buffer at a specific frame | RewindData.h | |
DataType & GetAndLoadEarliestData() |
Returns the earliest data entry and loads it as the current data of the history | RewindData.h | |
DataType * GetAndLoadNextIncrementalData() |
Returns the next incremental data entry after the CurrentIndex (and loads it as the current data of the history), if there isn't a data entry with a higher LocalFrame value, nullptr is returned | RewindData.h | |
const DataType & GetCurrentData () |
RewindData.h | ||
DataType & GetCurrentData () |
Current data that is being loaded/recorded | RewindData.h | |
TArray< DataType > & GetDataHistory() |
RewindData.h | ||
const TArray< DataType > & GetDataHistoryConst() |
RewindData.h | ||
const uint32 GetFrameIndex
(
const int32 Frame |
Return circular index for given frame value | RewindData.h | |
bool LoadData
(
const int32 LoadFrame |
Load the data from the buffer at a specific frame | RewindData.h | |
uint32 NumValidData
(
const uint32 StartFrame, |
Get the number of valid data in the buffer index range | RewindData.h |
Overridden from FBaseRewindHistory
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CopyAllDataGrowingOrdered
(
Chaos::FBaseRewindHistory& OutHistory |
Copy all data and record it ordered and growing | RewindData.h | |
virtual bool ExtractData
(
const int32 ExtractFrame, |
Extract states at a given time | RewindData.h | |
virtual const int32 GetEarliestFrame() |
Return the least up to date frame entry in history | RewindData.h | |
virtual const int32 GetHistorySize() |
Return the max size of the history | RewindData.h | |
virtual const int32 GetLatestFrame() |
Return the most up to date frame entry in history | RewindData.h | |
virtual const bool HasDataInHistory() |
Return if history has valid data | RewindData.h | |
virtual bool HasValidData
(
const int32 ValidFrame |
Check if the history buffer contains an entry for the given frame | RewindData.h | |
virtual void Initialize() |
Initialize history | RewindData.h | |
virtual void MergeData
(
int32 FromFrame, |
Iterate over and merge data | RewindData.h | |
virtual bool RecordData
(
const int32 RecordFrame, |
Record data into the history buffer at a given time | RewindData.h | |
virtual bool RecordDataGrowingOrdered
(
const void* HistoryData |
Record data in order and allow growing the history | RewindData.h | |
virtual void ResetFast() |
Perform a fast reset, marking the data history as reset but not clearing the data or resetting collections | RewindData.h | |
virtual void ResizeDataHistory
(
const int32 FrameCount, |
Resize the history | RewindData.h | |
virtual void SetRecordDataIncremental
(
const bool bInIncremental |
Set if this history should only allow overriding of data if it has a higher value than current recorded data | RewindData.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 ClosestData
(
const int32 DataFrame, |
Get the closest (min/max) valid data from the data frame | RewindData.h |