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&40;Experimental, MinimalAPI&41;  
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 &  
Public function void Initialize the cache adapters before playing/recording the cache.
Public function Const bool Returns true if this cache manager is allowed to record caches.
Protected function void  
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 FObservedComponent *  
Protected function FObservedComponent &  
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 Handles physics thread post-solve (record data for components under record)
Protected function void Handles physics thread pre-buffer (mark dirty kinematic particles)
Protected function void End AActor interface Handles physics thread pre-solve (push kinematic data for components under playback)
Protected function void Handles solver teardown due to solver destruction / stream-out
Protected function void Evaluates and sets state for all observed components at the specified time.
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.
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 callineditor void

SetStartTime ( float InStartTime
)

 End UObject interface Expose StartTime property to Sequencer.
Protected function UFunction BlueprintCallable, Category void Triggers the recording or playback of all observed components
Protected function UFunction BlueprintCallable, Category void Triggers a component to play or record.
Protected function UFunction BlueprintCallable, Category void

TriggerComponentByCache ( FName InCacheName
)

 Triggers a component to play or record.

Overridden from AActor

  Type Name Description
Protected function Virtual void AActor interface
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Overridable function called whenever this actor is being removed from a level
Public function Virtual void

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

 AActor interface

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void End AActor interface UObject interface

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