Navigation
API > API/Plugins > API/Plugins/GeometryCacheStreamer
Base class for GeometryCache stream for use with the GeometryCacheStreamer Besides implementing the basic functionalities expected of the stream, it implements basic memory statistics and management for use by the streamer. Derived classes need to implement a way to retrieve the mesh data for a frame through GetMeshData.
| Name | FGeometryCacheStreamBase |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GeometryCache/Source/GeometryCacheStreamer/Public/GeometryCacheStreamBase.h |
| Include Path | #include "GeometryCacheStreamBase.h" |
Syntax
class FGeometryCacheStreamBase : public IGeometryCacheStream
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGeometryCacheStreamBase
(
int32 ReadConcurrency, |
GeometryCacheStreamBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FGeometryCacheStreamBase() |
GeometryCacheStreamBase.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFrameIndexToMeshData | TMap< int32, FGeometryCacheMeshData * > | GeometryCacheStreamBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateCurrentFrameIndex
(
int32 FrameIndex |
Updates the current position in the stream | GeometryCacheStreamBase.h |
Overridden from IGeometryCacheStream
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 CancelRequests() |
Cancel the scheduled read requests. Return the number of requests that were canceled | GeometryCacheStreamBase.h | |
virtual bool GetFrameData
(
int32 FrameIndex, |
Get the MeshData at given FrameIndex without waiting for data to be ready Return true if MeshData could be retrieved | GeometryCacheStreamBase.h | |
virtual uint32 GetNumFramesNeeded() |
Return the number of frame indices needed to be loaded | GeometryCacheStreamBase.h | |
virtual const FGeometryCacheStreamStats & GetStreamStats() |
Return the memory usage and related stats for the stream | GeometryCacheStreamBase.h | |
virtual void Prefetch
(
int32 StartFrameIndex, |
Prefetch NumFrames starting from the given StartFrameIndex. | GeometryCacheStreamBase.h | |
virtual bool RequestFrameData () |
Request a read of the next frame as determined by the stream. | GeometryCacheStreamBase.h | |
virtual void SetLimits
(
float MaxMemoryAllowed, |
Set the memory usage limits for the stream | GeometryCacheStreamBase.h | |
virtual void UpdateRequestStatus
(
TArray< int32 >& OutFramesCompleted |
Update the status of the read requests currently in progress. | GeometryCacheStreamBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DecrementMemoryStat
(
const FGeometryCacheMeshData& MeshData |
GeometryCacheStreamBase.h | ||
void GetMeshData
(
int32 FrameIndex, |
Derived class must provide a way to get the mesh data for the given FrameIndex, called from worker threads | GeometryCacheStreamBase.h | |
void IncrementMemoryStat
(
const FGeometryCacheMeshData& MeshData |
GeometryCacheStreamBase.h | ||
void LoadFrameData
(
int32 FrameIndex |
GeometryCacheStreamBase.h | ||
virtual void PrepareRead() |
Function called from main thread to prepare for GetMeshData | GeometryCacheStreamBase.h | |
void UpdateFramesNeeded
(
int32 StartIndex, |
GeometryCacheStreamBase.h |