1. Epic GamesDeveloper
  3. UGeometryCacheTrackStreamable

UGeometryCacheTrackStreamable

Derived GeometryCacheTrack class, used for Transform animation.

API > API/Plugins > API/Plugins/GeometryCache

Derived GeometryCacheTrack class, used for Transform animation.

FGeometryCacheTrackStreamableRenderResource keeps a reference to the track. Be sure to keep the implementation of this class valid so it properly releases the render resoruce before making any changes to this object that may affect the render thread.

   
Name UGeometryCacheTrackStreamable
Type class
Header File /Engine/Plugins/Runtime/GeometryCache/Source/GeometryCache/Classes/GeometryCacheTrackStreamable.h
Include Path #include "GeometryCacheTrackStreamable.h"

Syntax

UCLASS (MinimalAPI, CollapseCategories, HideCategories=Object, BlueprintType, Config=Engine)  
class UGeometryCacheTrackStreamable : public UGeometryCacheTrack

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UGeometryCacheTrackStreamable ( const FObjectInitializer& ObjectInitializer
)

   GeometryCacheTrackStreamable.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UGeometryCacheTrackStreamable()

   GeometryCacheTrackStreamable.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Codec TObjectPtr< UGeometryCacheCodecBase > Codec for this track GeometryCacheTrackStreamable.h
  • VisibleAnywhere
  • Category=GeometryCache
Preprocessor FGeometryCachePreprocessor *   GeometryCacheTrackStreamable.h
  • VisibleAnywhere
  • Category=GeometryCache

Protected

Name Type Remarks Include Path Unreal Specifiers
Chunks TArray< FStreamedGeometryCacheChunk > Stored data for each Mesh sample GeometryCacheTrackStreamable.h  
Hash uint64   GeometryCacheTrackStreamable.h  
ImportVisibilitySamples TArray< TPair< float, bool > >   GeometryCacheTrackStreamable.h  
ReleaseResourcesFence FRenderCommandFence   GeometryCacheTrackStreamable.h  
RenderResource FGeometryCacheTrackStreamableRenderResource   GeometryCacheTrackStreamable.h  
Samples TArray< FGeometryCacheTrackStreamableSampleInfo >   GeometryCacheTrackStreamable.h  
StartSampleTime float   GeometryCacheTrackStreamable.h  
VisibilitySamples TArray< FVisibilitySample >   GeometryCacheTrackStreamable.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMeshSample ( const FGeometryCacheMeshData& MeshData,
const float SampleTime,
bool bSameTopologyAsPrevious
)

 Add a GeometryCacheMeshData sample to the Track GeometryCacheTrackStreamable.h  

void AddVisibilitySample ( const bool bVisible,
const float SampleTime
)

   GeometryCacheTrackStreamable.h  

void BeginCoding ( UGeometryCacheCodecBase* SetCodec,
bool bForceSingleOptimization,
bool bCalculateAndStoreMotionVectors,
bool bOptimizeIndexBuffers
)

 Begin coding and set the codec to use for this track. GeometryCacheTrackStreamable.h  

bool EndCoding()

 Finish up coding. Return true if the track has samples GeometryCacheTrackStreamable.h  

void FindSampleIndexesFromTime ( float Time,
bool bLooping,
bool bIsPlayingBackwards,
int32& OutFrameIndex,
int32& OutNextFrameIndex,
float& InterpolationFactor
)

 Find the two frames closest to the given time. GeometryCacheTrackStreamable.h  

const uint32 FindSampleIndexFromTime ( const float Time,
const bool bLooping
) const

 FindSampleIndexFromTime uses binary search to find the closest index to Time inside Samples GeometryCacheTrackStreamable.h  
  GeometryCacheTrackStreamable.h  

const FStreamedGeometryCacheChunk & GetChunk ( int32 ChunkID
) const

   GeometryCacheTrackStreamable.h  

void GetChunksForTimeRange ( float StartTime,
float EndTime,
bool Looping,
TArray< int32 >& OutChunkIndexes
)

 Get the CunksIds that need to be loaded to display any frames falling within the given time range. GeometryCacheTrackStreamable.h  
  GeometryCacheTrackStreamable.h  

const FGeometryCacheTrackStreamableSampleInfo & GetSampleInfo ( int32 SampleID
) const

 Get the info for the sample with the given ID. GeometryCacheTrackStreamable.h  

const FVisibilitySample & GetVisibilitySample ( float Time,
const bool bLooping
) const

   GeometryCacheTrackStreamable.h  

Overridden from UGeometryCacheTrack

Name Remarks Include Path Unreal Specifiers

virtual uint64 GetHash()

 Return the hash of the mesh data of the track GeometryCacheTrackStreamable.h  

virtual const float GetMaxSampleTime()

 GetMaxSampleTime, returns the time for the last sample Not the same as the animation length since it might not start at time 0 GeometryCacheTrackStreamable.h  

virtual bool GetMeshDataAtSampleIndex ( int32 SampleIndex,
FGeometryCacheMeshData& OutMeshData
)

 Get the mesh data for the specified sample index GeometryCacheTrackStreamable.h  

virtual bool GetMeshDataAtTime ( float Time,
FGeometryCacheMeshData& OutMeshData
)

 Get the mesh data for the specified time GeometryCacheTrackStreamable.h  

virtual const FGeometryCacheTrackSampleInfo & GetSampleInfo ( float Time,
const bool bLooping
)

 Get the info for the sample displayed at the given time. GeometryCacheTrackStreamable.h  

virtual void SetDuration ( float NewDuration
)

 Set the duration property. GeometryCacheTrackStreamable.h  

virtual const bool UpdateBoundsData ( const float Time,
const bool bLooping,
const bool bIsPlayingBackward,
int32& InOutBoundsSampleIndex,
FBox& OutBounds
)

 UpdateBoundsData GeometryCacheTrackStreamable.h  

virtual const bool UpdateMeshData ( const float Time,
const bool bLooping,
int32& InOutMeshSampleIndex,
FGeometryCacheMeshData*& OutMeshData
)

 UpdateMeshData* GeometryCacheTrackStreamable.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GeometryCacheTrackStreamable.h  

virtual void FinishDestroy()

   GeometryCacheTrackStreamable.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   GeometryCacheTrackStreamable.h  

virtual bool IsReadyForFinishDestroy()

   GeometryCacheTrackStreamable.h  

virtual void PostInitProperties()

   GeometryCacheTrackStreamable.h  

virtual void PostLoad()

   GeometryCacheTrackStreamable.h  

virtual void Serialize ( FArchive& Ar
)

   GeometryCacheTrackStreamable.h  

Static

Name Remarks Include Path Unreal Specifiers

static void TriggerSerializationCrash()

 Creates a totally invalid UGeometryCacheTrackStreamable instance specially set up to be very large and then tries to serialize it to smoke-test the serialization of large assets and bulk data. GeometryCacheTrackStreamable.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page