1. Epic GamesDeveloper
  3. FGeometryCollectionPhysicsProxy

FGeometryCollectionPhysicsProxy

Class to manage sharing data between the game thread and the simulation thread (which may not be different than the game thread) for a `[FGeometryDynamicCollection](API\Runtime\Chaos\FGeometryDynamicCollection)_.

API > API/Runtime > API/Runtime/Chaos > API/Runtime/Chaos/PhysicsProxy

Inheritance Hierarchy

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/PhysicsProxy/GeometryCollectionPhysicsProxy.h
Include #include "PhysicsProxy/GeometryCollectionPhysicsProxy.h"

Syntax

class FGeometryCollectionPhysicsProxy : public TPhysicsProxy< FGeometryCollectionPhysicsProxy, FStubGeometryCollectionData, FGeometryCollectionProxyTimestamp >

Remarks

Class to manage sharing data between the game thread and the simulation thread (which may not be different than the game thread) for a `FGeometryDynamicCollection_.

Constructors

  Type Name Description
Public function    
Public function  

FGeometryCollectionPhysicsProxy ( UObject* InOwner,
FGeometryDynamicCollection& GameThreadCollection,
const FSimulationParameters& SimulationParameters,
FCollisionFilterData InSimFilter,
FCollisionFilterData InQueryFilter,
FGuid InCollectorGuid,
const Chaos::EMultiBufferMode BufferMode
)

 InOwner_InDynamicCollection_ game thread owned geometry collection.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddForceCallback ( FParticlesType& InParticles,
const float InDt,
const int32 InIndex
)

  
Protected function Const Chaos::FVec3f Adjust inertia to account for per component scale properties ( from material override and world transform scale )
Protected function Const float

AdjustMassForScale ( float Mass
)

 Adjust scalar mass to account for per component scale properties ( from material override and world transform scale )
Public function void  
Public function void  
Public function void  
Public function void

ApplyExternalStrain_External ( FGeometryCollectionItemIndex ItemIndex,
const FVector& WorldLocation,
float Radius,
int32 PropagationDepth,
float PropagationFactor,
float StrainValue
)

  
Public function void

ApplyForceAt_External ( FVector Force,
FVector WorldLocation
)

  
Public function void

ApplyImpulseAt_External ( FVector Force,
FVector WorldLocation
)

  
Public function void

ApplyInternalStrain_External ( FGeometryCollectionItemIndex ItemIndex,
const FVector& WorldLocation,
float Radius,
int32 PropagationDepth,
float PropagationFactor,
float StrainValue
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

BufferCommand ( Chaos::FPBDRigidsSolver* RigidsSolver,
const FFieldSystemCommand& Command
)

 Enqueue a field Command_ to be processed by ProcessCommands() or `FieldForcesUpdateCallback().
Public function void  
Public function void Push GT state into the `PhysToGameInterchange_ for async physics
Public function void Push PT state into the `PhysToGameInterchange_.
Protected function Chaos::FPBDRigidClusteredParticleHandle *

BuildClusters_Internal ( const uint32 CollectionClusterIndex,
TArray< Chaos::FPBDRigidParticleHandle* >& ChildHandles,
const TArray< int32 >& ChildTransformGroupIndices,
const Chaos::FClusterCreationParameters& Parameters,
const Chaos::FUniqueIdx* ExistingIndex
)

 Build a physics thread cluster parent particle.
Protected function Chaos::TPBDGeometryCollectionParticleHandle< Chaos::FReal, 3 > *

BuildNonClusters_Internal ( const uint32 CollectionClusterIndex,
Chaos::FPBDRigidsSolver* RigidsSolver,
float Mass,
Chaos::FVec3f Inertia,
const Chaos::FUniqueIdx* ExistingIndex
)

  
Public function Static int32

CalculateAndSetLevel ( int32 TransformGroupIdx,
const TManagedArray< int32 >& Parent,
TManagedArray< int32 >& Levels
)

 Traverses the parents of TransformGroupIdx counting number of levels, and sets levels array value for TransformGroupIdx and its parents if not yet initialized.
Protected function Static int32

CalculateHierarchyLevel ( const FGeometryDynamicCollection& DynamicCollection,
int32 TransformIndex
)

 Traverses the parents of TransformIndex_ in GeometryCollection_, counting the number of levels until the next parent is `INDEX_NONE_.
Public function void Called at the end of `FPBDRigidsSolver::PushPhysicsStateExec()_.
Protected function Const float  
Public function Const float  
Protected function Const float Compute user defined damage threshold for a specific transform this account for component level damage threshold as well as size specific ones
Public function Static EPhysicsProxyType  
Public function void  
Protected function void

CreateNonClusteredParticles ( Chaos::FPBDRigidsSolver* RigidsSolver,
const FGeometryCollection& RestCollection,
const FGeometryDynamicCollection& DynamicCollection
)

  
Public function void  
Protected function void
DirtyAllParticles

( const Chaos::FPBDRigidsSolver& RigidsSolver
)

  
Public function void  
Public function void

DisableParticles_External ( TArray< int32 >&& TransformGroupIndices
)

  
Public function void

EndFrameCallback ( const float InDt
)

  
Public function void  
Public function void

FieldParameterUpdateCallback ( Chaos::FPBDRigidsSolver* RigidSolver,
const bool bUpdateViews
)

  
Protected function Const Chaos::FPBDRigidClusteredParticleHandle *  
Public function Const const TArray< int32 > *  
Public function void Does nothing as `BufferPhysicsResults()_ already did this.
Public function Const TArray< Chaos::FPhysicsObjectHandle >  
Public function Const TArray< Chaos::FPhysicsObjectHandle >  
Public function Const const FGeometryCollectionResults *  
Public function FGeometryDynamicCollection &  
Public function TArray< TUniquePtr< FParticle > > &  
Public function void

GetFilteredParticleHandles ( TArray< Chaos::TGeometryParticleHandle< Chaos::FReal, 3 >* >& Handles,
const Chaos::FPBDRigidsSolver* RigidSolver,
const EFieldFilterType FilterType,
const EFieldObjectType ObjectType
)

 Get all the geometry collection particle handles filtered by object state
Public function Const int32  
Public function Const FClusterHandle *  
Public function FParticle *  
Public function Const const FParticle *  
Public function FParticleHandle *  
Public function Const const FParticleHandle *  
Public function Const FGeometryCollectionItemIndex  
Public function Const const FProxyInterpolationBase &  
Public function FProxyInterpolationBase &  
Public function Const bool  
Public function Const FGeometryCollectionItemIndex  
Public function Const FGeometryCollectionItemIndex  
Public function Const int32  
Public function Const int32  
Public function Const FClusterHandle *  
Public function Const const FParticle *  
Public function FParticle *  
Public function Const const FParticleHandle *  
Public function FParticleHandle *  
Public function Const const TArray< FClusterHandle * >  
Public function FGeometryDynamicCollection &  
Public function Const Chaos::FPhysicsObjectHandle  
Public function Const const FTransform &  
Public function void * Get all the geometry collection particle handles based on the processing resolution
Public function Const EReplicationMode  
Public function Const const FSimulationParameters &  
Public function FSimulationParameters &  
Public function Const SOLVER_TYPE * Proxy publics
Public function Const FClusterHandle *  
Public function TArray< FClusterHandle * > &  
Public function TArray< FClusterHandle * > &  
Public function Const int32  
Public function Const void  
Public function Const FName  
Public function TArray< TUniquePtr< FParticle > > &  
Public function Const const TArray< FClusterHandle * >  
Public function const FTransform &  
Public function void Construct `PTDynamicCollection_, copying attributes from the game thread, and prepare for simulation.
Public function void Finish initialization on the physics thread.
Public function Static void

InitializeDynamicCollection ( FGeometryDynamicCollection& DynamicCollection,
const FGeometryCollection& RestCollection,
const FSimulationParameters& Params
)

  
Public function Static void NOTE - Making any changes to data stored on the rest collection below MUST be accompanied by a rotation of the DDC key in FDerivedDataGeometryCollectionCooker::GetVersionString
Public function bool

IsDirty ()

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Chaos::FParticleData *

NewData ()

 Pushes current game thread particle state into the `GameToPhysInterchange_.
Public function void  
Public function void  
Public function void  
Protected function void

PrepareBufferData ( Chaos::FDirtyGeometryCollectionData& BufferData,
const FGeometryDynamicCollection& ThreadCollection,
Chaos::FReal SolverLastDt
)

  
Public function bool

PullFromPhysicsState ( const Chaos::FDirtyGeometryCollectionData& BufferData,
const int32 SolverSyncTimestamp,
const Chaos::FDirtyGeometryCollectionData* NextPullData,
const Chaos::FRealSingle* Alpha,
const Chaos::FDirtyRigidParticleReplicationErrorData* Error,
const Chaos::FReal AsyncFixedTimeStep
)

 Pulls data out of the PhysToGameInterchange and updates `GTDynamicCollection_.
Public function void Push data from the game thread to the physics thread
Public function void Apply the state changes on the physics thread
Public function void  
Protected function bool

RebaseParticleGameThreadCollectionTransformOnNewWorldTransform_External ( int32 ParticleIndex,
const TManagedArray< FTransform >& MassToLocal,
bool bIsComponentTransformScaled,
const FTransform& ComponentScaleTransform
)

  
Public function void  
Public function void

Reset ()

  
Protected function void

ScaleClusterGeometry_Internal ( const FVector& WorldScale
)

 Scale the cluster particles geometry (creates if necessary an additional TImplicitObjectScaled object into the implicits hierarchy)
Public function void

SetAnchoredByIndex_External ( int32 Index,
bool bAnchored
)

  
Public function void

SetAnchoredByTransformedBox_External ( const FBox& Box,
const FTransform& Transform,
bool bAnchored,
int32 MaxLevel
)

  
Protected function void  
Public function void

SetCollisionParticlesPerObjectFraction ( float CollisionParticlesPerObjectFractionIn
)

  
Public function void  
Public function void  
Protected function void  
Public function void

SetDamagePropagationData_External ( bool bEnabled,
float BreakDamagePropagationFactor,
float ShockDamagePropagationFactor
)

  
Protected function void

SetDamagePropagationData_Internal ( bool bEnabled,
float BreakDamagePropagationFactor,
float ShockDamagePropagationFactor
)

  
Public function void

SetDamageThresholds_External ( const TArray< float >& DamageThresholds
)

  
Protected function void

SetDamageThresholds_Internal ( const TArray< float >& DamageThresholds
)

  
Public function void  
Protected function void

SetFilterData_Internal ( const FCollisionFilterData& NewSimFilter,
const FCollisionFilterData& NewQueryFilter
)

  
Public function void

SetGravityGroupIndex_External ( int32 GravityGroupIndex
)

  
Protected function void

SetGravityGroupIndex_Internal ( int32 GravityGroupIndex
)

  
Public function void  
Protected function void  
Public function void

SetNotifyBreakings_External ( bool bNotify
)

  
Public function void

SetNotifyCrumblings_External ( bool bNotify,
bool bIncludeChildren
)

  
Public function void  
Public function void

SetNotifyGlobalCrumblings_External ( bool bNotify,
bool bIncludeChildren
)

  
Public function void  
Public function void

SetNotifyRemovals_External ( bool bNotify
)

  
Public function void

SetOneWayInteractionLevel_External ( int32 OneWayInteractionLevel
)

  
Protected function void

SetOneWayInteractionLevel_Internal ( int32 InOneWayInteractionLevel
)

  
Protected function void  
Public function void  
Protected function void  
Public function void  
Public function void

SetPostPhysicsSyncCallback ( TFunction< void()> Callback
)

  
Public function void  
Public function void  
Protected function void

SetSleepingState ( const Chaos::FPBDRigidsSolver& RigidsSolver
)

  
Public function void

SetUseMaterialDamageModifiers_External ( bool bUseMaterialDamageModifiers
)

  
Protected function void

SetUseMaterialDamageModifiers_Internal ( bool bUseMaterialDamageModifiers
)

  
Public function void

SetUseStaticMeshCollisionForTraces_External ( bool bInUseStaticMeshCollisionForTraces
)

 Todo(chaos): Remove this and move to a cook time approach of the SM data based on the GC property Set whether the GC should be using collision from the Static Mesh or the GC itself for game thread traces ( this needs to be called on the game thread )
Public function void

SetWorldTransform_External ( const FTransform& WorldTransform
)

 Set the world transform ( this needs to be called on the game thread )
Protected function void

SetWorldTransform_Internal ( const FTransform& WorldTransform
)

  
Public function void

StartFrameCallback ( const float InDt,
const float InTime
)

  
Public function void  
Protected function void  
Public function void

UpdateFilterData_External ( const FCollisionFilterData& NewSimFilter,
const FCollisionFilterData& NewQueryFilter
)

  
Public function void

UpdateKinematicBodiesCallback ( const FParticlesType& InParticles,
const float InDt,
const float InTime,
FKinematicProxy& InKinematicProxy
)

  
Public function void  

Overridden from IPhysicsProxyBase

  Type Name Description
Public function Virtual Const void * Implemented so we can construct TAccelerationStructureHandle.

Classes

  Type Name Description
Public struct FParticleCollisionFilterData    

Enums

  Type Name Description
Public enum EReplicationMode    

Typedefs

Name Description
Base  
FClusterHandle  
FCreateTraceCollisionGeometryCallback Todo(chaos): Remove this and move to a cook time approach of the SM data based on the GC property
FParticle  
FParticleHandle  
FSimplicial  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page