1. Epic GamesDeveloper
  3. FPBDRigidsEvolutionBase

FPBDRigidsEvolutionBase

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

Inheritance Hierarchy

References

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

Syntax

class FPBDRigidsEvolutionBase

Variables

  Type Name Description
Protected variable TArray< TUniquePtr< FAccelerationStructure > > AccelerationBackingBuffer The backing buffer for all acceleration structures
Protected variable FGraphEventRef AccelerationStructureTaskComplete  
Protected variable FPendingSpatialDataQueue AsyncAccelerationQueue Pending operations for the acceleration structures being rebuilt asynchronously
Protected variable FAccelerationStructure * AsyncExternalAcceleration  
Protected variable FAccelerationStructure * AsyncInternalAcceleration  
Protected variable bool bCanStartAsyncTasks Allows us to tell evolution to stop starting async tasks if we are trying to cleanup solver/evo.
Protected variable bool bIsReset  
Protected variable bool bIsResim  
Protected variable bool bIsSingleThreaded  
Protected variable FCaptureRewindRule CaptureRewindData  
Protected variable TArrayCollectionArray< bool > Collided  
Protected variable TArray< FPBDConstraintContainer * > ConstraintContainers  
Protected variable TQueue< FAccelerationStructure *, EQueueMode::Spsc > ExternalStructuresPool External thread will push into this when done with structure internal thread will pop from this to generate new structure
Protected variable TQueue< FAccelerationStructure *, EQueueMode::Spsc > ExternalStructuresQueue Internal thread will push into this and external thread will consume
Protected variable TArray< FForceRule > ForceRules  
Protected variable TArray< FForceRule > ImpulseRules  
Protected variable FAccelerationStructure * InternalAcceleration  
Protected variable FPendingSpatialDataQueue InternalAccelerationQueue Pending operations for the internal acceleration structure
Protected variable Private::FPBDIslandGroupManager IslandGroupManager  
Protected variable Private::FPBDIslandManager IslandManager  
Protected variable FKinematicUpdateRule KinematicUpdate  
Public variable int32 LatestExternalTimestampConsumed_Internal The latest external timestamp we consumed inputs from, assigned to evolution when solver task executes, is used to stamp output data.
Protected variable TArray< FRemovalData > MAllRemovals  
Protected variable FRewindData * MRewindData  
Protected variable FPBDRigidsSOAs & Particles  
Protected variable TArrayAsMap< FUniqueIdx, uint32 > ParticleToCacheInnerIdx Void SerializePendingMap(FChaosArchive& Ar, TMap& Map) { TArray Keys; if (!Ar.IsLoading()) { Map.GenerateKeyArray(Keys); } Ar << AsAlwaysSerializableArray(Keys); for (auto Key : Keys) { FPendingSpatialData& PendingData = Map.FindOrAdd(Key); PendingData.Serialize(Ar); } /TODO: fix serialization } Used for async acceleration rebuild
Protected variable FUpdatePositionRule ParticleUpdatePosition  
Protected variable TArray< FUniqueIdx > PendingReleaseIndices  
Protected variable TArrayCollectionArray< TUniquePtr< FChaosPhysicsMaterial > > PerParticlePhysicsMaterials  
Protected variable TArrayCollectionArray< TSerializablePtr< FChaosPhysicsMaterial > > PhysicsMaterials  
Protected variable THandleArray< FChaosPhysicsMaterial > & SolverPhysicsMaterials  
Protected variable TMap< FSpatialAccelerationIdx, TUniquePtr< FSpatialAccelerationCache > > SpatialAccelerationCache  
Protected variable TUniquePtr< ISpatialAccelerationCollectionFactory > SpatialCollectionFactory  
Protected variable TArray< FUniqueIdx > UniqueIndicesPendingRelease  

Constructors

  Type Name Description
Public function  

FPBDRigidsEvolutionBase ( FPBDRigidsSOAs& InParticles,
THandleArray< FChaosPhysicsMaterial >& InSolverPhysicsMaterials,
bool InIsSingleThreaded
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddConstraintContainer ( FPBDConstraintContainer& InContainer,
const int32 Priority
)

 Register a constraint container with the evolution.
Public function void

AddForceFunction ( FForceRule ForceFunction
)

  
Public function void

AddImpulseFunction ( FForceRule ImpulseFunction
)

  
Public function void

ApplyKinematicTargets ( const FReal Dt,
const FReal StepFraction
)

  
Protected function void

ApplyParticlePendingData ( const FPendingSpatialData& PendingData,
FAccelerationStructure& SpatialAcceleration,
bool bUpdateCache,
bool bUpdateDynamicTrees
)

  
Public function Const bool  
Public function void Ticks computation of acceleration structures.
Protected function Static void

CopyPristineAccelerationStructures ( const TMap< FSpatialAccelerationIdx, TUniquePtr< FSpatialAccelerationCache >>& SpatialAccelerationC...,
FAccelerationStructure* FromStructure,
FAccelerationStructure* ToStructure,
bool CheckPristine
)

  
Protected function Static void

CopyUnBuiltDynamicAccelerationStructures ( const TMap< FSpatialAccelerationIdx, TUniquePtr< FSpatialAccelerationCache >>& SpatialAccelerationC...,
FAccelerationStructure* InternalAcceleration,
FAccelerationStructure* AsyncInternalAcceleration,
FAccelerationStructure* AsyncExternalAcceleration
)

  
Public function TArray< TPBDRigidClusteredParticleHandle< FReal, 3 > * >

CreateClusteredParticles ( int32 NumParticles,
const FUniqueIdx* ExistingIndices,
const FPBDRigidParticleParameters& Params
)

  
Protected function void  
Public function TArray< FPBDRigidParticleHandle * >

CreateDynamicParticles ( int32 NumParticles,
const FUniqueIdx* ExistingIndices,
const FPBDRigidParticleParameters& Params
)

  
Public function TArray< TPBDGeometryCollectionParticleHandle< FReal, 3 > * >

CreateGeometryCollectionParticles ( int32 NumParticles,
const FUniqueIdx* ExistingIndices,
const FPBDRigidParticleParameters& Params
)

  
Protected function void  
Public function TArray< FKinematicGeometryParticleHandle * >

CreateKinematicParticles ( int32 NumParticles,
const FUniqueIdx* ExistingIndices,
const FKinematicGeometryParticleParameters& Params
)

  
Public function TArray< FGeometryParticleHandle * >

CreateStaticParticles ( int32 NumParticles,
const FUniqueIdx* ExistingIndices,
const FGeometryParticleParameters& Params
)

  
Public function void  
Public function Virtual void Destroy all transient constraints (collisions) involving the specified particle.
Public function void
DirtyParticle

( TGeometryParticleHandleImp< FReal, 3, bPersistent >& Particle,
const EPendingSpatialDataOperation Op
)

  
Public function void Disconnect constraints (all types except collisions) from a particle to be removed (or destroyed) this will set the constraints to Enabled = false, but leave connections to the particles to support re-enabling at a later time.
Public function void Disable a particle so that it is no longer simulated.
Public function void

DisableParticles ( const TSet< FGeometryParticleHandle* >& InParticles
)

  
Public function void  
Public function void  
Public function void

DisconnectConstraints ( const TSet< FGeometryParticleHandle* >& RemovedParticles
)

 Disconnect constraints (all types except collisions) from a set of particles to be destroyed.
Public function void Enable constraints (all types except collisions) from the enabled particles; constraints will only become enabled if their particle end points are valid.
Public function void Enable a particle.Only enabled particles are simulated.
Protected function void  
Public function void  
Protected function void  
Public function void Perform a blocking flush of the spatial acceleration structure for situations where we aren't simulating but must have an up to date structure
Protected function void  
Public function FUniqueIdx  
Public function const TArray< FRemovalData > &  
Protected function FAccelerationStructure *  
Public function Const const Private::FPBDIslandGroupManager &  
Public function Const const Private::FPBDIslandManager &  
Public function Private::FPBDIslandManager &  
Public function Const const TParticleView< FPBDRigidClusteredParticles > &  
Public function Const int32 Get the number of position iterations the solver is running
Public function Const int32 Get the number of projection iterations the solver is running
Public function Const int32 Get the number of velocity iterations the solver is running
Public function Const const TGeometryParticleHandles< FReal, 3 > &  
Public function TGeometryParticleHandles< FReal, 3 > &  
Public function Const const FPBDRigidsSOAs &  
Public function FPBDRigidsSOAs &  
Public function Const const TUniquePtr< FChaosPhysicsMaterial > &  
Public function Const TSerializablePtr< FChaosPhysicsMaterial >  
Public function ISpatialAccelerationCollection< FAccelerationStructureHandle, FReal, 3 > *  
Public function void To be called when a particle geometry changes.
Public function Const const bool  
Public function Const const bool  
Public function Const bool  
Protected function Const int32  
Public function void  
Public function void Rebuilds the spatial acceleration from scratch. This should only be used for perf testing
Public function void To be called after creating a particle in the Particles container
Protected function void  
Protected function void  
Public function void  
Public function void Remove a constraint from the constraint graph
Public function void Remove a list of constraints from the constraint graph
Public function void  
Public function void

ReserveParticles ( const int32 Num
)

 Preallocate buffers for creating `Num_ particles.
Public function void  
Public function Virtual void Reset the collisions warm starting when resimulate.
Public function void Clear all constraints from the system reeady for shut down
Public function void  
Public function void

SetCanStartAsyncTasks ( bool bInCanStartAsyncTasks
)

  
Public function void  
Public function void

SetNumPositionIterations ( int32 InNumIterations
)

 Set the number of iterations to perform in the constraint position-solve phase
Public function void

SetNumProjectionIterations ( int32 InNumIterations
)

 Set the number of iterations to perform in the constraint projection phase
Public function void

SetNumVelocityIterations ( int32 InNumIterations
)

 Set the number of iterations to perform in the constraint velocity-solve phase
Public function void

SetParticleKinematicTarget ( FKinematicGeometryParticleHandle* KinematicHandle,
const FKinematicTarget& NewKinematicTarget
)

 Set the kinematic target for a particle.
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

SetReset ( bool bInReset
)

  
Public function void

SetResim ( bool bInResim
)

  
Public function void

SetRewindData ( FRewindData* RewindData
)

  
Public function void  
Protected function void  
Public function void Make a copy of the acceleration structure to allow for external modification.
Protected function void  

Classes

  Type Name Description
Protected class FChaosAccelerationStructureTask    

Typedefs

Name Description
FAccelerationStructure  
FCaptureRewindRule  
FForceRule  
FKinematicUpdateRule  
FUpdatePositionRule  
FUpdateVelocityRule  

Deprecated Functions

  Type Name Description
Public function Const const Private::FPBDIslandManager & Renamed to GetIslandManager
Public function Private::FPBDIslandManager & Renamed to GetIslandManager

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page