Navigation
API > API/Runtime > API/Runtime/Chaos
Container class for all character ground constraints on the physics thread.
| Name | FCharacterGroundConstraintContainer |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Character/CharacterGroundConstraintContainer.h |
| Include Path | #include "Chaos/Character/CharacterGroundConstraintContainer.h" |
Syntax
class FCharacterGroundConstraintContainer : public Chaos::FPBDConstraintContainer
Inheritance Hierarchy
- FPBDConstraintContainer → FCharacterGroundConstraintContainer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCharacterGroundConstraintContainer() |
Chaos/Character/CharacterGroundConstraintContainer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FCharacterGroundConstraintContainer() |
Chaos/Character/CharacterGroundConstraintContainer.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Base | FPBDConstraintContainer | Chaos/Character/CharacterGroundConstraintContainer.h | |
| FConstConstraints | TArrayView< const FCharacterGroundConstraintHandle *const > | Chaos/Character/CharacterGroundConstraintContainer.h | |
| FConstraints | TArrayView< FCharacterGroundConstraintHandle *const > | Chaos/Character/CharacterGroundConstraintContainer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ConstraintPool | TObjectPool< FCharacterGroundConstraintHandle > | Chaos/Character/CharacterGroundConstraintContainer.h | ||
| Constraints | TArray< FCharacterGroundConstraintHandle * > | Chaos/Character/CharacterGroundConstraintContainer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCharacterGroundConstraintHandle * AddConstraint
(
const FCharacterGroundConstraintSettings& InConstraintSettings, |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
FConstConstraints GetConstConstraints() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
FCharacterGroundConstraintHandle * GetConstraint
(
int32 ConstraintIndex |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
const FCharacterGroundConstraintHandle * GetConstraint
(
int32 ConstraintIndex |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
FConstraints GetConstraints() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
bool IsConstraintEnabled
(
int32 ConstraintIndex |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
int32 NumConstraints() |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
void RemoveConstraint
(
FCharacterGroundConstraintHandle* Constraint |
Chaos/Character/CharacterGroundConstraintContainer.h | ||
void SetConstraintEnabled
(
int32 ConstraintIndex, |
Required API from FConstraintContainer. | Chaos/Character/CharacterGroundConstraintContainer.h |
Overridden from FPBDConstraintContainer
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddConstraintsToGraph
(
Private::FPBDIslandManager& IslandManager |
Add all the constraints in the container to the graph | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual TUniquePtr< FConstraintContainerSolver > CreateGroupSolver
(
const int32 Priority |
Create a constraint solver for an Evolution with Graph support (World evolution). | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual TUniquePtr< FConstraintContainerSolver > CreateSceneSolver
(
const int32 Priority |
FConstraintContainer Implementation. | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual void DisconnectConstraints
(
const TSet< TGeometryParticleHandle< FReal, 3 >* >& |
This is called when a particle is destroyed. | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual int32 GetNumConstraints() |
Get the number of constraints in this container (includes inactive and disabled) | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual void OnDisableParticle
(
FGeometryParticleHandle* DisabledParticle |
This is called to notify the constraint container that a particle has been disabled. | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual void OnEnableParticle
(
FGeometryParticleHandle* EnabledParticle |
This is called to notify the constraint container that a particle has been disabled. | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual void PrepareTick() |
Called oncer per tick to initialize buffers required for the rest of the tick | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual void ResetConstraints() |
Empty the constraints (must be removed from the graph first, if required) | Chaos/Character/CharacterGroundConstraintContainer.h | |
virtual void UnprepareTick() |
Should undo any allocations in PrepareTick | Chaos/Character/CharacterGroundConstraintContainer.h |