1. Epic GamesDeveloper
  3. FPBDCollisionConstraints

FPBDCollisionConstraints

A container and solver for collision constraints.

Unreal Engine C++ API Reference > Runtime > Chaos > Chaos

Inheritance Hierarchy

References

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

Syntax

class FPBDCollisionConstraints : public Chaos::FPBDConstraintContainer

Remarks

A container and solver for collision constraints.

Constructors

  Type Name Description
Public function  

FPBDCollisionConstraints ( const FPBDRigidsSOAs& InParticles,
TArrayCollectionArray< bool >& Collided,
const TArrayCollectionArray< TSerializablePtr< FChaosPhysicsMaterial >>& PhysicsMaterials,
const TArrayCollectionArray< TUniquePtr< FChaosPhysicsMaterial >>& PerParticlePhysicsMaterials,
const THandleArray< FChaosPhysicsMaterial >*const SimMaterials,
const int32 NumCollisionsPerBlock,
const FReal RestitutionThreshold
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

ApplyCCDModifier ( const TArray< ISimCallbackObject* >& CCDModifiers,
FReal Dt
)

 Apply modifiers to CCD results
Public function void

ApplyCollisionModifier ( const TArray< ISimCallbackObject* >& CollisionModifiers,
FReal Dt
)

 Apply modifiers to the constraints and specify which constraints should be disabled.
Public function void

ApplyMidPhaseModifier ( const TArray< ISimCallbackObject* >& MidPhaseModifiers,
FReal Dt
)

 Apply modifiers to particle pair midphases
Public function void Called before collision detection to reset contacts.
Public function void Clears the list of active constraints.
Public function void Called after collision resolution in order to detect probes.
Public function void

DisableConstraints ( const TSet< FGeometryParticleHandle* >& ParticleHandle
)

 Disable the constraints associated with the ParticleHandle.
Public function void Put the container in "no handles" mode for use with simple solver.
Public function Virtual void

DisconnectConstraints ( const TSet< FGeometryParticleHandle* >& ParticleHandles
)

 Remove all constraints associated with the particles - called when particles are destroyed.
Public function void Called after collision detection to finalize the contacts.
Public function Const bool  
Public function Const bool  
Public function Const FConstHandles  
Public function Const const FPBDCollisionConstraint &

GetConstraint ( int32 Index
)

  
Protected function FPBDCollisionConstraint &

GetConstraint ( int32 Index
)

  
Public function Private::FCollisionConstraintAllocator &  
Public function Const FHandles  
Public function Const TArrayView< FPBDCollisionConstraint *const >  
Public function Const const FCollisionDetectorSettings &  
Public function Const FVec3  
Public function Const FReal  
Public function Const bool Whether this container provides constraint handles (simple solvers do not need them)
Public function Const bool  
Public function Const FReal  
Public function Const const FPBDCollisionSolverSettings &  
Public function Const Private::ECollisionSolverType The type of solver we are creating.
Public function Const bool  
Public function Const int32  
Protected function void Call PruneParticleEdgeCollisions on all particles with ECollisionConstraintFlags::CCF_SmoothEdgeCollisions set in CollisionFlags.
Public function void

RemoveConstraints ( const TSet< FGeometryParticleHandle* >& ParticleHandle
)

 Remove the constraints associated with the ParticleHandle.
Public function void

Reset ()

 Destroy all constraints
Public function void

SetCanDisableContacts ( bool bInCanDisableContacts
)

 Member Access
Public function void

SetCollisionsEnabled ( bool bInEnableCollisions
)

  
Public function void

SetCullDistance ( const FReal InCullDistance
)

  
Public function void  
Public function void

SetGravity ( const FVec3& InGravity
)

  
Public function void

SetIsDeterministic ( const bool bInIsDeterministic
)

 Enable or disable determinism. Support for determinism requires that we sort active constraints each tick, so there is additional cost.
Public function void

SetMaxPushOutVelocity ( const FReal InMaxPushOutVelocity
)

  
Public function void

SetPositionFrictionIterations ( const int32 InNumIterations
)

  
Public function void

SetPositionShockPropagationIterations ( const int32 InNumIterations
)

  
Public function void

SetRestitutionEnabled ( bool bInEnableRestitution
)

  
Public function void

SetRestitutionThreshold ( FReal InRestitutionThreshold
)

  
Public function void Set the solver type. NOTE: Any previously created solvers will not be recreated at this level. (See FPBDRigidsEvolutionGBF::UpdateCollisionSolverType)
Public function void

SetVelocityBoundsExpansion ( const FReal BoundsVelocityMultiplier,
const FReal MaxVelocityBoundsExpansion
)

  
Public function void

SetVelocityFrictionIterations ( const int32 InNumIterations
)

  
Public function void

SetVelocityShockPropagationIterations ( const int32 InNumIterations
)

  
Public function void  

Overridden from FPBDConstraintContainer

  Type Name Description
Public function Virtual void Add all the constraints in the container to the graph
Public function Virtual TUniquePtr< FConstraintContainerSolver >

CreateGroupSolver ( const int32 Priority
)

 Create a constraint solver for an Evolution with Graph support (World evolution).
Public function Virtual TUniquePtr< FConstraintContainerSolver >

CreateSceneSolver ( const int32 Priority
)

 Create a constraint solver for an Evolution without Graph support (RBAN evolution).
Public function Virtual Const int32 FConstraintContainer Implementation
Public function Virtual void Called oncer per tick to initialize buffers required for the rest of the tick
Public function Virtual void Empty the constraints (must be removed from the graph first, if required)
Public function Virtual void Should undo any allocations in PrepareTick

Typedefs

Name Description
Base  
FConstHandles  
FConstraintContainerHandle For use by dependent types.
FHandles Collision constraints have intrusive pointers. An array of constraint pointers can be uased as an array of handle pointers.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page