UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::Private::FCharacterGroundConstraintContainerSolver Class Reference

#include <CharacterGroundConstraintContainerSolver.h>

+ Inheritance diagram for Chaos::Private::FCharacterGroundConstraintContainerSolver:

Public Member Functions

 FCharacterGroundConstraintContainerSolver (FCharacterGroundConstraintContainer &InConstraintContainer, const int32 InPriority)
 
 ~FCharacterGroundConstraintContainerSolver ()
 
virtual int32 GetNumConstraints () const override final
 
virtual void Reset (const int32 InMaxConstraints) override final
 
virtual void AddConstraints () override final
 Add all constraints from the constraint container in the order that they appear there.
 
virtual void AddConstraints (const TArrayView< Private::FPBDIslandConstraint * > &IslandConstraints) override final
 Add all constraints from an island (guaranteed to be from the same constraint container)
 
virtual void AddBodies (FSolverBodyContainer &SolverBodyContainer) override final
 Set the bodies on the constraint from the constraint data solver.
 
virtual void GatherInput (const FReal Dt) override final
 Initialize the solver from the constraint data.
 
virtual void GatherInput (const FReal Dt, const int32 BeginIndex, const int32 EndIndex) override final
 
virtual void ScatterOutput (const FReal Dt) override final
 Get the solver output that will be stored per constraint - applied force and torque.
 
virtual void ScatterOutput (const FReal Dt, const int32 BeginIndex, const int32 EndIndex) override final
 
virtual void ApplyPositionConstraints (const FReal Dt, const int32 It, const int32 NumIts) override final
 Apply a single position solve iteration for all constraints.
 
virtual void ApplyVelocityConstraints (const FReal Dt, const int32 It, const int32 NumIts) override final
 
virtual void ApplyProjectionConstraints (const FReal Dt, const int32 It, const int32 NumIts) override final
 
- Public Member Functions inherited from Chaos::FConstraintContainerSolver
 FConstraintContainerSolver (const int32 InPriority)
 
virtual ~FConstraintContainerSolver ()
 
void SetPriority (const int32 InPriority)
 
int32 GetPriority () const
 
virtual void PreApplyPositionConstraints (const FReal Dt)
 
virtual void PreApplyVelocityConstraints (const FReal Dt)
 
virtual void PreApplyProjectionConstraints (const FReal Dt)
 

Constructor & Destructor Documentation

◆ FCharacterGroundConstraintContainerSolver()

Chaos::Private::FCharacterGroundConstraintContainerSolver::FCharacterGroundConstraintContainerSolver ( FCharacterGroundConstraintContainer InConstraintContainer,
const int32  InPriority 
)

◆ ~FCharacterGroundConstraintContainerSolver()

Chaos::Private::FCharacterGroundConstraintContainerSolver::~FCharacterGroundConstraintContainerSolver ( )

Member Function Documentation

◆ AddBodies()

void Chaos::Private::FCharacterGroundConstraintContainerSolver::AddBodies ( FSolverBodyContainer SolverBodyContainer)
finaloverridevirtual

Set the bodies on the constraint from the constraint data solver.

Implements Chaos::FConstraintContainerSolver.

◆ AddConstraints() [1/2]

void Chaos::Private::FCharacterGroundConstraintContainerSolver::AddConstraints ( )
finaloverridevirtual

Add all constraints from the constraint container in the order that they appear there.

Implements Chaos::FConstraintContainerSolver.

◆ AddConstraints() [2/2]

void Chaos::Private::FCharacterGroundConstraintContainerSolver::AddConstraints ( const TArrayView< Private::FPBDIslandConstraint * > &  IslandConstraints)
finaloverridevirtual

Add all constraints from an island (guaranteed to be from the same constraint container)

Implements Chaos::FConstraintContainerSolver.

◆ ApplyPositionConstraints()

void Chaos::Private::FCharacterGroundConstraintContainerSolver::ApplyPositionConstraints ( const FReal  Dt,
const int32  It,
const int32  NumIts 
)
finaloverridevirtual

Apply a single position solve iteration for all constraints.

Implements Chaos::FConstraintContainerSolver.

◆ ApplyProjectionConstraints()

void Chaos::Private::FCharacterGroundConstraintContainerSolver::ApplyProjectionConstraints ( const FReal  Dt,
const int32  It,
const int32  NumIts 
)
finaloverridevirtual

Apply a single projection solve iteration for all constraints Note: Currently not used for character ground constraints

Implements Chaos::FConstraintContainerSolver.

◆ ApplyVelocityConstraints()

void Chaos::Private::FCharacterGroundConstraintContainerSolver::ApplyVelocityConstraints ( const FReal  Dt,
const int32  It,
const int32  NumIts 
)
finaloverridevirtual

Apply a single velocity solve iteration for all constraints Note: Currently not used for character ground constraints

Implements Chaos::FConstraintContainerSolver.

◆ GatherInput() [1/2]

void Chaos::Private::FCharacterGroundConstraintContainerSolver::GatherInput ( const FReal  Dt)
finaloverridevirtual

Initialize the solver from the constraint data.

Implements Chaos::FConstraintContainerSolver.

◆ GatherInput() [2/2]

void Chaos::Private::FCharacterGroundConstraintContainerSolver::GatherInput ( const FReal  Dt,
const int32  BeginIndex,
const int32  EndIndex 
)
finaloverridevirtual

◆ GetNumConstraints()

virtual int32 Chaos::Private::FCharacterGroundConstraintContainerSolver::GetNumConstraints ( ) const
inlinefinaloverridevirtual

◆ Reset()

void Chaos::Private::FCharacterGroundConstraintContainerSolver::Reset ( const int32  MaxConstraints)
finaloverridevirtual

Set the maximum number of constraints the solver will have to handle. This will be called only once per tick, so containers resized here will not have to resize again this tick so that pointers to elements in the container will remain valid for the tick (but not beyond).

Implements Chaos::FConstraintContainerSolver.

◆ ScatterOutput() [1/2]

void Chaos::Private::FCharacterGroundConstraintContainerSolver::ScatterOutput ( const FReal  Dt)
finaloverridevirtual

Get the solver output that will be stored per constraint - applied force and torque.

Implements Chaos::FConstraintContainerSolver.

◆ ScatterOutput() [2/2]

void Chaos::Private::FCharacterGroundConstraintContainerSolver::ScatterOutput ( const FReal  Dt,
const int32  BeginIndex,
const int32  EndIndex 
)
finaloverridevirtual

The documentation for this class was generated from the following files: