1. Epic GamesDeveloper
  3. FGeometryCacheStreamBase

FGeometryCacheStreamBase

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.

Unreal Engine C++ API Reference > Plugins > GeometryCacheStreamer

Inheritance Hierarchy

References

   
Module GeometryCacheStreamer
Header /Engine/Plugins/Runtime/GeometryCache/Source/GeometryCacheStreamer/Public/GeometryCacheStreamBase.h
Include #include "GeometryCacheStreamBase.h"

Syntax

class FGeometryCacheStreamBase : public IGeometryCacheStream

Remarks

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.

Variables

  Type Name Description
Protected variable bool bCacheNeedsUpdate  
Protected variable std::atomic< bool > bCancellationRequested  
Protected variable int32 CurrentFrameIndex  
Protected variable FGeometryCacheStreamDetails Details  
Protected variable FFrameIndexToMeshData FramesAvailable  
Protected variable FRWLock FramesAvailableLock  
Protected variable TArray< int32 > FramesNeeded  
Protected variable TArray< FGeometryCacheStreamReadRequest * > FramesRequested  
Protected variable TArray< int32 > FramesToBeCached  
Protected variable float MaxCachedDuration  
Protected variable int32 MaxCachedFrames  
Protected variable float MaxMemAllowed  
Protected variable float MemoryUsed  
Protected variable TArray< int32 > ReadIndices  
Protected variable TArray< FGeometryCacheStreamReadRequest * > ReadRequestsPool  
Protected variable FGeometryCacheStreamStats Stats  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void  
Protected function void

GetMeshData ( int32 FrameIndex,
int32 ReadConcurrencyIndex,
FGeometryCacheMeshData& OutMeshData
)

 Derived class must provide a way to get the mesh data for the given FrameIndex, called from worker threads
Protected function void  
Protected function void

LoadFrameData ( int32 FrameIndex
)

  
Protected function Virtual void Function called from main thread to prepare for GetMeshData
Public function void Updates the current position in the stream
Protected function void

UpdateFramesNeeded ( int32 StartIndex,
int32 NumFrames
)

  

Overridden from IGeometryCacheStream

  Type Name Description
Public function Virtual int32 Cancel the scheduled read requests. Return the number of requests that were canceled
Public function Virtual bool

GetFrameData ( int32 FrameIndex,
FGeometryCacheMeshData& OutMeshData
)

 Get the MeshData at given FrameIndex without waiting for data to be ready Return true if MeshData could be retrieved
Public function Virtual uint32 Return the number of frame indices needed to be loaded
Public function Virtual Const const FGeometryCacheStreamStats & Return the memory usage and related stats for the stream
Public function Virtual void

Prefetch ( int32 StartFrameIndex,
int32 NumFrames
)

 Prefetch NumFrames starting from the given StartFrameIndex.
Public function Virtual bool Request a read of the next frame as determined by the stream.
Public function Virtual void

SetLimits ( float MaxMemoryAllowed,
float MaxCachedDuration
)

 Set the memory usage limits for the stream
Public function Virtual void

UpdateRequestStatus ( TArray< int32 >& OutFramesCompleted
)

 Update the status of the read requests currently in progress.

Typedefs

Name Description
FFrameIndexToMeshData  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page