1. Epic GamesDeveloper
  3. UChaosCache

UChaosCache

API > API/Plugins > API/Plugins/ChaosCaching > API/Plugins/ChaosCaching/Chaos

Inheritance Hierarchy

References

   
Module ChaosCaching
Header /Engine/Plugins/Experimental/ChaosCaching/Source/ChaosCaching/Public/Chaos/ChaosCache.h
Include #include "Chaos/ChaosCache.h"

Syntax

UCLASS&40;Experimental, MinimalAPI&41;  
class UChaosCache : public UObject

Variables

  Type Name Description
Public variable UProperty bool bCompressChannels  
Public variable UProperty TArray< int32 > ChannelCurveToParticle Map a curve index in the cache to the original particle index specified when recording
Public variable UProperty float ChannelsCompressionErrorThreshold  
Public variable UProperty float ChannelsCompressionSampleRate  
Public variable UProperty TMap< FName, FRichCurves > ChannelsTracks Per-particle data, continuous per-frame data
Public variable UProperty TMap< FName, FCompressedRichCurves > CompressedChannelsTracks  
Public variable UProperty TMap< FName, FRichCurve > CurveData Per component/cache curve data, any continuous data that isn't per-particle can be stored here
Public variable UProperty TMap< FName, FParticleTransformTrack > NamedTransformTracks  
Public variable UProperty Category visibleanywhere uint32 NumRecordedFrames  
Public variable UProperty TArray< FPerParticleCacheData > ParticleTracks Per-particle data, includes transforms, velocities and other per-particle, per-frame data
Public variable UProperty Category visibleanywhere float RecordedDuration  
Public variable UProperty TArray< int32 > TrackToParticle Maps a track index in the cache to the original particle index specified when recording

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Adds a new frame to process to a threadsafe queue for later processing in FlushPendingFrames
Public function FCacheUserToken Initialise the cache for playback, may not take any actual action on the cache but will provide the caller with a valid cache user token if it is safe to continue with playback
Public function FCacheUserToken

BeginRecord ( const UPrimitiveComponent* InComponent,
FGuid InAdapterId,
const FTransform& SpaceTransform
)

 Reset and initialize a cache to make it ready to record the specified component
Public function void

BuildSpawnableFromComponent ( const UPrimitiveComponent* InComponent,
const FTransform& SpaceTransform
)

 Initializes the spawnable template from a currently existing component so it can be spawned by the editor when a cache is dragged into the scene.
Public function void

CompressChannelsData ( float ErrorThreshold,
float SampleRate
)

  
Public function void

EndPlayback ( FCacheUserToken& InOutToken
)

 End a playback session for the cache.
Public function void

EndRecord ( FCacheUserToken& InOutToken
)

 End the recording session for the cache.
Public function FCacheEvaluationResult

Evaluate ( const FCacheEvaluationContext& InContext,
const TArray< FTransform >* MassToLocalTransforms
)

 Evaluate the cache with the specified parameters, returning the evaluated results
Public function void

EvaluateCurves ( const FPerParticleCacheData& InData,
float InTime,
TMap< FName, float >& OutCurves
)

  
Public function void  
Public function void

EvaluateSingle ( int32 InIndex,
FPlaybackTickRecord& InTickRecord,
const FTransform* MassToLocal,
FTransform* OutOptTransform,
TMap< FName, float >* OutOptCurves
)

 Evaluates a single particle from the tracks array
Public function void

EvaluateTransform ( const FPerParticleCacheData& InData,
float InTime,
const FTransform* MassToLocal,
FTransform& OutTransform
)

  
Public function FCacheEventTrack &  
Public function void As we record post-simulate of physics, we're almost always taking data from a non-main thread (physics thread).
Public function Const float Gets the recorded duration of the cache
Public function Const const FCacheSpawnableTemplate & Read access to the spawnable template stored in the cache

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FNamedTransformTrack Per component/cache transform data.

Constants

Name Description
CurrentVersion Version 0 : Pre versioning.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page