Navigation
API > API/Runtime > API/Runtime/Chaos > API/Runtime/Chaos/Chaos
Inheritance Hierarchy
- FPBDConstraintContainer
- FCharacterGroundConstraintContainer
- FPBDCollisionConstraints
- FPBDIndexedConstraintContainer
- FPBDChainConstraints
- TPBDIndexedConstraintContainer
- FPBDNullConstraints
- FPBDPositionConstraints
- FPBDRigidDynamicSpringConstraints
- FPBDRigidSpringConstraints
- FPBDSuspensionConstraints
- FPBDJointConstraints
References
| Module | Chaos |
| Header | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDConstraintContainer.h |
| Include | #include "Chaos/PBDConstraintContainer.h" |
Syntax
class FPBDConstraintContainer
Remarks
Base class for containers of constraints. A Constraint Container holds an array of constraints and provides methods to allocate and deallocate constraints as well as the API required to plug into Constraint Rules.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FConstraintHandleTypeID | ConstraintHandleType | |
 |
int32 | ContainerId |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FPBDConstraintContainer
(
FConstraintHandleTypeID InConstraintHandleType |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddConstraintsToGraph
(
Private::FPBDIslandManager& IslandManager |
Add all the constraints in the container to the graph |
 |
TUniquePtr< FConstraintContainerSolver > | CreateGroupSolver
(
const int32 Priority |
Create a constraint solver for an Evolution with Graph support (World evolution). |
 |
TUniquePtr< FConstraintContainerSolver > | CreateSceneSolver
(
const int32 Priority |
Create a constraint solver for an Evolution without Graph support (RBAN evolution). |
  |
void | DisconnectConstraints
(
const TSet< TGeometryParticleHandle< FReal, 3 >* >& |
This is called when a particle is destroyed. |
  |
const FConstraintHandleTypeID & | The TypeID of the constraints in this container. Used to safely downcast constraint handles. | |
  |
int32 | The ContainerId is used to map constraint handles back to their constraint container. | |
  |
int32 | Get the number of constraints in this container (includes inactive and disabled) | |
  |
void | OnDisableParticle
(
FGeometryParticleHandle* DisabledParticle |
This is called to notify the constraint container that a particle has been disabled. |
  |
void | OnEnableParticle
(
FGeometryParticleHandle* EnabledParticle |
This is called to notify the constraint container that a particle has been disabled. |
 |
void | PrepareTick () |
Called oncer per tick to initialize buffers required for the rest of the tick |
 |
void | Empty the constraints (must be removed from the graph first, if required) | |
 |
void | SetContainerId
(
int32 InContainerId |
|
 |
void | Should undo any allocations in PrepareTick | |
  |
void | UpdatePositionBasedState
(
const FReal Dt |
An opportunity to create/destroy constraints based on particle state. |