1. Epic GamesDeveloper
  3. AChaosCacheManager

AChaosCacheManager

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Experimental, MinimalAPI)  
class AChaosCacheManager : public AActor

Variables

  Type Name Description
Protected variable bool bCanRecord Determines if the actor is allowed to record a cache.
Protected variable bool bIsSimulating True if observed components are actively simulating, dynamically or kinematically.
Public variable UProperty Category editinstanceonly TObjectPtr< UChaosCacheCollection > CacheCollection The Cache Collection asset to use for this observer.
Public variable UProperty Category, EditAnywhere ECacheMode CacheMode How to use the cache - playback or record
Public variable UProperty Category, EditAnywhere EStartMode StartMode How to trigger the cache record or playback, timed will start counting at BeginPlay, Triggered will begin counting from when the owning cache manager is requested to trigger the cache action
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadWrite float StartTime Defines the (random access) time that represents the rest pose of the components managed by this cache.

Constructors

  Type Name Description
Public function  

AChaosCacheManager ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function FObservedComponent &

AddNewObservedComponent ( UPrimitiveComponent* InComponent
)

  
Public function void Initialize the cache adapters before playing/recording the cache.
Protected function void AActor interface
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Public function Const bool Returns true if this cache manager is allowed to record caches.
Public function void Clear all the observed components
Public function Const bool

ContainsProperty ( const UStruct* Struct,
const void* InProperty
)

  
Protected function UFunction BlueprintCallable, Category void

EnablePlayback ( int32 Index,
bool bEnable
)

 Enable playback for a specific component using its index in the list of observed component
Protected function UFunction BlueprintCallable, Category void

EnablePlaybackByCache ( FName InCacheName,
bool bEnable
)

 Enable playback for a specific component using its cache name
Public function void Clean the cache adapters after playing/recording the cache.
Protected function void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Protected function FObservedComponent *

FindObservedComponent ( UPrimitiveComponent* InComponent
)

  
Public function void

FindOrAddObservedComponent ( UPrimitiveComponent* InComponent,
const FName& CacheName,
const bool bTransferSimulationFlag
)

 Find or add a primitive component to a cache manager
Public function Const const TArray< FObservedComponent > & Accessor to the manager observed components (read only)
Public function TArray< FObservedComponent > & Accessor to the manager observed components (read/write)
Protected function void

HandlePostSolve ( Chaos::FReal InDt,
Chaos::FPhysicsSolverEvents* InSolver
)

 Handles physics thread post-solve (record data for components under record)
Protected function void

HandlePreBuffer ( Chaos::FReal InDt,
Chaos::FPhysicsSolverEvents* InSolver
)

 Handles physics thread pre-buffer (mark dirty kinematic particles)
Protected function void

HandlePreSolve ( Chaos::FReal InDt,
Chaos::FPhysicsSolverEvents* InSolver
)

 End AActor interface Handles physics thread pre-solve (push kinematic data for components under playback)
Protected function void

HandleTeardown ( Chaos::FPhysicsSolverEvents* InSolver
)

 Handles solver teardown due to solver destruction / stream-out
Protected function void

OnStartFrameChanged ( Chaos::FReal InT
)

 Evaluates and sets state for all observed components at the specified time.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function void

RemoveObservedComponent ( UPrimitiveComponent* InComponent
)

 Remove a primitive component from the cache manager
Public function UFunction BlueprintCallable, Category void Resets all components back to the world space transform they had when the cache for them was originally recorded if one is available
Public function UFunction BlueprintCallable, Category void

ResetSingleTransform ( int32 InIndex
)

 Resets the component at the specified index in the observed list back to the world space transform it had when the cache for it was originally recorded if one is available
Public function void

SelectComponent ( int32 InIndex
)

 Set the component at the specified index in the observed array to be the selected component in the outliner.
Public function Virtual void

Serialize ( FArchive& Ar
)

 End AActor interface UObject interface
Protected function UFunction BlueprintCallable, Category void

SetCacheCollection ( UChaosCacheCollection* InCacheCollection
)

 Change the cache collection for this player if the cache is playing or recording this will have no effect
Public function UFunction BlueprintCallable, Category void

SetCurrentTime ( float CurrentTime
)

  
Public function void

SetObservedComponentProperties ( const ECacheMode& NewCacheMode
)

  
Public function UFunction callineditor void

SetStartTime ( float InStartTime
)

 End UObject interface Expose StartTime property to Sequencer. GetStartTime will be called on keys.
Public function void

TickActor ( float DeltaTime,
enum ELevelTick TickType,
FActorTickFunction& ThisTickFunction
)

 AActor interface
Protected function UFunction BlueprintCallable, Category void Triggers the recording or playback of all observed components
Protected function UFunction BlueprintCallable, Category void

TriggerComponent ( UPrimitiveComponent* InComponent
)

 Triggers a component to play or record.
Protected function UFunction BlueprintCallable, Category void

TriggerComponentByCache ( FName InCacheName
)

 Triggers a component to play or record.

Typedefs

Name Description
FTickObservedFunction  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page