Navigation
API > API/Plugins > API/Plugins/ChaosUserDataPT
Inheritance Hierarchy
- ISimCallbackObject
- TSimCallbackObject
- TUserDataManagerPT
References
| Module | ChaosUserDataPT |
| Header | /Engine/Plugins/Experimental/ChaosUserDataPT/Source/ChaosUserDataPT/Public/ChaosUserDataPT.h |
| Include | #include "ChaosUserDataPT.h" |
Syntax
template<typename TUserData>
class TUserDataManagerPT : public Chaos::TSimCallbackObject< TUserDataManagerPTInput< TUserData >, FSimCallbackNoOutput, ESimCallbackOptions::Presimulate|ESimCallbackOptions::ParticleUnregister >
Remarks
A chaos callback object which stores and allows access to user data associated with particles on the physics thread.
Note that FSimCallbackOutput is the output struct - this carries no data because this is a one-way callback. We use it basically just to marshal data in one direction.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
int32 | InputIdentifier_GT | Identifier of the next input to be created on the game thread. |
 |
int32 | InputIdentifier_PT | Identifier of the last input to be consumed on the physics thread. |
 |
TSparseArray< TUniquePtr< TUserData > > | UserDataMap_PT | Map of particle unique ids to user data. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | ClearData_GT () |
Clear all data. |
  |
const TUserData * | GetData_PT
(
const TParticleHandle& Handle |
TParticleHandle is generalized here because it can be FRigidBodyHandle_Internal or FGeometryParticleHandle which have the same api... |
 |
bool | RemoveData_GT
(
const TParticleHandle& Handle |
Remove user data associated with a particle handle. |
 |
bool | RemoveData_GT
(
const Chaos::FPhysicsObjectHandle& Object |
|
 |
bool | SetData_GT
(
const TParticleHandle& Handle, |
Add or update user data associated with a particle handle. |
 |
bool | SetData_GT
(
const Chaos::FPhysicsObjectHandle& Object, |
Overridden from ISimCallbackObject
| Type | Name | Description | |
|---|---|---|---|
   |
FName | Get a stat name to describe this callback in external profiling and STATS when Named events are enabled | |
  |
void | OnParticleUnregistered_Internal
(
TArray< TTuple< FUniqueIdx, FSingleParticlePhysicsProxy* >>& UnregisteredProxies |
Called once in a simulation step if any particles were unregistered. |
  |
void | Called before simulation step |
Typedefs
| Name | Description |
|---|---|
| TInput |