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)_.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IPhysicsProxyBase

TPhysicsProxy

FGeometryCollectionPhysicsProxy

References

Module

Chaos

Header

/Engine/Source/Runtime/Experimental/Chaos/Public/PhysicsProxy/GeometryCollectionPhysicsProxy.h

Include

#include "PhysicsProxy/GeometryCollectionPhysicsProxy.h"

Syntax

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

Name Description

Public function

FGeometryCollectionPhysicsProxy()

Public function

FGeometryCollectionPhysicsProxy

(
    UObject* InOwner,
    FGeometryDynamicCollection& GameTh...,
    const FSimulationParameters& Simul...,
    FCollisionFilterData InSimFilter,
    FCollisionFilterData InQueryFilter,
    const Chaos::EMultiBufferMode Buffe...
)

`InOwner_`InDynamicCollection_ game thread owned geometry collection.

Destructors

Functions

Name Description

Public function

void

 

AddForceCallback

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

Public function

void

 

BindParticleCallbackMapping

(
    Chaos::TArrayCollectionArray< Physi...,
    Chaos::TArrayCollectionArray< int32...
)

Public function

void

 

BufferCommand

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

Enqueue a field Command_ to be processed by ProcessCommands() or `FieldForcesUpdateCallback().

Public function

void

 

BufferGameState()

Public function

void

 

BufferPhysicsResults

(
    Chaos::FPBDRigidsSolver* Curre...,
    Chaos::FDirtyGeometryCollectionData...
)

Push physics state into the `PhysToGameInterchange_.

Protected function

Chaos::TPBDR...

 

BuildClusters

(
    const uint32 CollectionClusterIndex,
    TArray< Chaos::TPBDRigidParticleHan...,
    const TArray< int32 >& ChildTransf...,
    const Chaos::FClusterCreationParame...,
    const Chaos::FUniqueIdx* Exist...
)

Build a physics thread cluster parent particle.

Protected function Const

int32

 

CalculateHierarchyLevel

(
    const FGeometryDynamicCollection& ...,
    int32 TransformIndex
)

Traverses the parents of TransformIndex_ in GeometryCollection, counting the number of levels until the next parent is `INDEX_NONE.

Public function

void

 

ClearAccumulatedData()

Called at the end of `FPBDRigidsSolver::PushPhysicsStateExec()_.

Public function

EPhysicsProx...

 

ConcreteType()

Public function

void

 

CreateRigidBodyCallback

(
    FParticlesType& InOutParticles
)

Public function

void

 

DisableCollisionsCallback

(
    TSet< TTuple< int32, int32 >>& InP...
)

Public function

void

 

DisableParticles

(
    TArray< int32 >& TransformGroupInd...
)

Public function

void

 

EndFrameCallback

(
    const float InDt
)

Public function

void

 

FieldForcesUpdateCallback

(
    Chaos::FPBDRigidsSolver* Rigid...
)

Public function

void

 

FieldParameterUpdateCallback

(
    Chaos::FPBDRigidsSolver* Rigid...,
    const bool bUpdateViews
)

Public function

void

 

FlipBuffer()

Does nothing as `BufferPhysicsResults()_ already did this.

Public function Const

const FGeome...

 

GetConsumerResultsGT()

Public function

TManagedArra...

 

GetExternalParticles()

Public function

void

 

GetFilteredParticleHandles

(
    TArray< Chaos::TGeometryParticleHan...,
    const Chaos::FPBDRigidsSolver*...,
    const EFieldFilterType FilterType,
    const EFieldObjectType ObjectType
)

Get all the geometry collection particle handles filtered by object state

Public function Const

bool

 

GetIsObjectDynamic()

Public function Const

const TArray...

 

GetParticles()

Public function

FGeometryDyn...

 

GetPhysicsCollection()

Public function

void

 

GetRelevantParticleHandles

(
    TArray< Chaos::TGeometryParticleHan...,
    const Chaos::FPBDRigidsSolver*...,
    EFieldResolutionType ResolutionType
)

Get all the geometry collection particle handles based on the processing resolution

Public function

FSimulationP...

 

GetSimParameters()

Public function Const

const FSimul...

 

GetSimParameters()

Public function

TArray< FClu...

 

GetSolverClusterHandles()

Public function

TArray< FClu...

 

GetSolverParticleHandles()

Public function Const

int32

 

GetTransformGroupIndexFromHandle

(
    const FParticleHandle* Handle
)

Public function

void

 

Initialize

(
    Chaos::FPBDRigidsEvolutionBase*...
)

Construct `PTDynamicCollection_, copying attributes from the game thread, and prepare for simulation.

Public function

void

 

InitializeBodiesPT

(
    Chaos::FPBDRigidsSolver* Rigid...,
    typename Chaos::FPBDRigidsSolver::F...
)

Finish initialization on the physics thread.

Public function Static

void

 

InitializeDynamicCollection

(
    FGeometryDynamicCollection& Dynami...,
    const FGeometryCollection& RestCol...,
    const FSimulationParameters& Param...
)

Protected function

void

 

InitializeRemoveOnFracture

(
    FParticlesType& Particles,
    const TManagedArray< int32 >& Dyna...
)

Public function Static

void

 

InitializeSharedCollisionStructures

(
    Chaos::FErrorReporter& ErrorReport...,
    FGeometryCollection& RestCollectio...,
    const FSharedSimulationParameters&...
)

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 Static

void

 

InitRemoveOnFracture

(
    FGeometryCollection& RestCollectio...,
    const FSharedSimulationParameters&...
)

Public function

bool

 

IsDirty()

Public function Const

bool

 

IsGTCollectionDirty()

Public function Const

bool

 

IsSimulating()

Public function

Chaos::FPart...

 

NewData()

Pushes current game thread particle state into the `GameToPhysInterchange_.

Public function

void

 

OnRemoveFromScene()

Public function

void

 

OnRemoveFromSolver

(
    Chaos::FPBDRigidsSolver* RBDSo...
)

Public function

bool

 

PullFromPhysicsState

(
    const Chaos::FDirtyGeometryCollecti...,
    const int32 SolverSyncTimestamp
)

Pulls data out of the PhysToGameInterchange and updates `GTDynamicCollection_.

Public function

void

 

PushStateOnGameThread

(
    Chaos::FPBDRigidsSolver* InSol...
)

Push data from the game thread to the physics thread

Public function

void

 

PushToPhysicsState()

Apply the state changes on the physics thread

Public function

void

 

Reset()

Protected function

void

 

SetClusteredParticleKinematicTarget

(
    Chaos::FPBDRigidClusteredParticleHa...,
    const FTransform& WorldTransform
)

Public function

void

 

SetCollisionParticlesPerObjectFraction

(
    float CollisionParticlesPerObjectFr...
)

Public function

void

 

SetWorldTransform

(
    const FTransform& WorldTransform
)

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

Public function

void

 

StartFrameCallback

(
    const float InDt,
    const float InTime
)

Public function

void

 

SyncBeforeDestroy()

Public function

void

 

UpdateKinematicBodiesCallback

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

Overridden from IPhysicsProxyBase

Name Description

Public function Virtual Const

void *

 

GetHandleUnsafe()

Implemented so we can construct TAccelerationStructureHandle.

Typedefs