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

FCharacterGroundConstraintSolver class. More...

#include <CharacterGroundConstraintSolver.h>

Public Member Functions

void SetBodies (FSolverBody *CharacterSolverBody, FSolverBody *GroundSolverBody=nullptr)
 Must call SetBodies and GatherInput before solve.
 
void GatherInput (FReal Dt, const FCharacterGroundConstraintSettings &Settings, const FCharacterGroundConstraintDynamicData &Data)
 
void SolvePosition ()
 Solve function performs one iteration of the solver.
 
void ScatterOutput (const FReal Dt, FVec3 &OutSolverAppliedForce, FVec3 &OutSolverAppliedTorque)
 
void Reset ()
 
FVec3 GetLinearImpulse (FReal Dt) const
 Gets the solver linear displacement for this constraint and converts to an impulse in units of ML/T.
 
FVec3 GetAngularImpulse (FReal Dt) const
 Gets the solver angular displacement for this constraint and converts to an impulse in units of ML/T.
 

Detailed Description

FCharacterGroundConstraintSolver class.

Computes the and applies linear and angular displacement for a character ground constraint

Member Function Documentation

◆ GatherInput()

void Chaos::Private::FCharacterGroundConstraintSolver::GatherInput ( FReal  Dt,
const FCharacterGroundConstraintSettings Settings,
const FCharacterGroundConstraintDynamicData Data 
)

◆ GetAngularImpulse()

FORCEINLINE_DEBUGGABLE FVec3 Chaos::Private::FCharacterGroundConstraintSolver::GetAngularImpulse ( FReal  Dt) const

Gets the solver angular displacement for this constraint and converts to an impulse in units of ML/T.

◆ GetLinearImpulse()

FORCEINLINE_DEBUGGABLE FVec3 Chaos::Private::FCharacterGroundConstraintSolver::GetLinearImpulse ( FReal  Dt) const

Gets the solver linear displacement for this constraint and converts to an impulse in units of ML/T.

FCharacterGroundConstraintSolver inline functions.

◆ Reset()

void Chaos::Private::FCharacterGroundConstraintSolver::Reset ( )

◆ ScatterOutput()

void Chaos::Private::FCharacterGroundConstraintSolver::ScatterOutput ( const FReal  Dt,
FVec3 OutSolverAppliedForce,
FVec3 OutSolverAppliedTorque 
)

Gets the solver output as a force and torque in units ML/T^2 and ML^2/T^2 respectively and resets the solver

◆ SetBodies()

void Chaos::Private::FCharacterGroundConstraintSolver::SetBodies ( FSolverBody CharacterSolverBody,
FSolverBody GroundSolverBody = nullptr 
)

Must call SetBodies and GatherInput before solve.

FCharacterGroundConstraintSolver.

◆ SolvePosition()

FORCEINLINE_DEBUGGABLE void Chaos::Private::FCharacterGroundConstraintSolver::SolvePosition ( )

Solve function performs one iteration of the solver.

Solve Functions.


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