Navigation
API > API/Plugins > API/Plugins/ChaosCaching > API/Plugins/ChaosCaching/Chaos > API/Plugins/ChaosCaching/Chaos/Adapters
Inheritance Hierarchy
- IModularFeature
- FComponentCacheAdapter
- FFleshCacheAdapter
- FGeometryCollectionCacheAdapter
- FStaticMeshCacheAdapter
References
| Module | ChaosCaching |
| Header | /Engine/Plugins/Experimental/ChaosCaching/Source/ChaosCaching/Public/Chaos/Adapters/CacheAdapter.h |
| Include | #include "Chaos/Adapters/CacheAdapter.h" |
Syntax
class FComponentCacheAdapter : public IModularFeature
Remarks
Base adapter type for interfacing with Chaos simulation caches. Any component wishing to use caches must have a compatible record adapter and a playback adapter to produce and consume cache data.
This base interface should not be used to implement those adapters however but the derived classes FCacheRecordAdapter and FCachePlaybackAdapter (declared below) should instead be used.
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
Chaos::FPhysicsSolverEvents * | BuildEventsSolver
(
UPrimitiveComponent* InComponent |
Called to retrieve the base events solver for a specific component. |
  |
Chaos::FPhysicsSolver * | GetComponentSolver
(
UPrimitiveComponent* InComponent |
Called to retrieve the rigid solver for a specific component if it exists. |
  |
UClass * | Query the class that this adapter wants to drive. | |
  |
FGuid | GetGuid () |
Gets a unique identifier for the adapter |
  |
uint8 | GetPriority () |
Gets the priority for an adapter. |
  |
void | Initialize () |
Called from the game thread to perform any global setup that the adapter may need to perform. |
 |
bool | InitializeForPlayback
(
UPrimitiveComponent* InComponent, |
Called from the game thread to initialize a component and cache ready to playback a cache |
 |
bool | InitializeForRecord
(
UPrimitiveComponent* InComponent, |
Called from the game thread to initialize a component and cache ready to record a cache |
  |
void | Playback_PreSolve
(
UPrimitiveComponent* InComponent, |
Called by a cache observer actor when a cache needs to be applied to a component through this adapter. |
  |
void | Record_PostSolve
(
UPrimitiveComponent* InComp, |
Called by a cache observer when a component should be recorded to a cache through this adapter. |
  |
void | SetRestState
(
UPrimitiveComponent* InComponent, |
Called from the game thread to set rest state from an evaluated time in the cache. |
  |
SupportType | SupportsComponentClass
(
UClass* InComponentClass |
Query whether InComponentClass can be driven by this adapter. |
  |
bool | ValidForPlayback
(
UPrimitiveComponent* InComponent, |
Determines whether a cache is able to safely playback on a component. |
   |
void | WaitForSolverTasks
(
UPrimitiveComponent* InComponent |
Stall on any solver tasks that could broadcast events via the EventsSolver. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
SupportType |
Constants
| Name | Description |
|---|---|
| EngineAdapterPriorityBegin | |
| FeatureName | Registration name for modular features module |
| UserAdapterPriorityBegin |