AChaosCacheManager

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ChaosCaching

Header

/Engine/Plugins/Experimental/ChaosCaching/Source/ChaosCaching/Public/Chaos/CacheManagerActor.h

Include

#include "Chaos/CacheManagerActor.h"

Syntax

UCLASS(Experimental)
class AChaosCacheManager : public AActor

Variables

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

UChaosCacheColl...

 

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

Name Description

Public function

AChaosCacheManager

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

FObservedCom...

 

AddNewObservedComponent

(
    UPrimitiveComponent* InCompone...
)

Public function Const

bool

 

CanRecord()

Returns true if this cache manager is allowed to record caches.

Protected function

void

 

ClearObservedComponents()

Protected function

FObservedCom...

 

FindObservedComponent

(
    UPrimitiveComponent* InCompone...
)

Protected function

FObservedCom...

 

FindOrAddObservedComponent

(
    UPrimitiveComponent* InCompone...
)

Protected function

void

 

HandlePostSolve

(
    Chaos::FReal InDt,
    Chaos::FPhysicsSolver* InSolve...
)

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

Protected function

void

 

HandlePreBuffer

(
    Chaos::FReal InDt,
    Chaos::FPhysicsSolver* InSolve...
)

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

Protected function

void

 

HandlePreSolve

(
    Chaos::FReal InDt,
    Chaos::FPhysicsSolver* InSolve...
)

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

Protected function

void

 

HandleTeardown

(
    Chaos::FPhysicsSolver* InSolve...
)

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 UFunction BlueprintCallable, Category

void

 

ResetAllComponentTransforms()

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 UFunction callineditor

void

 

SetStartTime

(
    float InStartTime
)

End UObject interface Expose StartTime property to Sequencer.

Protected function UFunction BlueprintCallable, Category

void

 

TriggerAll()

Triggers the recording or playback of all observed components

Protected function UFunction BlueprintCallable, Category

void

 

TriggerComponent

(
    UPrimitiveComponent* InCompone...
)

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

Name Description

Protected function Virtual

void

 

BeginPlay()

AActor interface

Protected function Virtual

void

 

EndPlay

(
    const EEndPlayReason::Type EndPlayR...
)

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

Public function Virtual

void

 

TickActor

(
    float DeltaTime,
    enum ELevelTick TickType,
    FActorTickFunction& ThisTickFuncti...
)

AActor interface

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Typedefs

Name

Description

FTickObservedFunction