UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSimpleSuspension Struct Reference

#include <SimpleSuspension.h>

Public Member Functions

 FSimpleSuspension ()
 
 FSimpleSuspension (const FSimpleSuspensionParams &SuspensionParams)
 
void Setup (const FSimpleSuspensionParams &InSuspensionParams)
 
void Setup (const FSimpleSuspensionParams &InSuspensionParams, const float TotalMass, const float Gravity)
 
void ComputeSpringParams (const float TotalMass, const float Gravity)
 
void Update (const FTransform &LocalToWorld, const FVector &LinearVelocity, const FVector &AngularVelocityRad, const FSimpleSuspensionRaycast &RaycastFunction=SimpleSuspensionRaycastGroundPlane)
 

Public Attributes

FSimpleSuspensionParams SuspensionParams
 
FSimpleSuspensionState SuspensionState
 

Constructor & Destructor Documentation

◆ FSimpleSuspension() [1/2]

FSimpleSuspension::FSimpleSuspension ( )
inline

◆ FSimpleSuspension() [2/2]

FSimpleSuspension::FSimpleSuspension ( const FSimpleSuspensionParams SuspensionParams)
inline

Member Function Documentation

◆ ComputeSpringParams()

void FSimpleSuspension::ComputeSpringParams ( const float  TotalMass,
const float  Gravity 
)

Compute sprung masses, stiffnesses, damping, etc.

◆ Setup() [1/2]

void FSimpleSuspension::Setup ( const FSimpleSuspensionParams InSuspensionParams)

Take full set of parameters. They might be invalid, who cares.

◆ Setup() [2/2]

void FSimpleSuspension::Setup ( const FSimpleSuspensionParams InSuspensionParams,
const float  TotalMass,
const float  Gravity 
)

Copy in a full set of parameters, and then compute the spring params and overwrite whatever we got for that

◆ Update()

void FSimpleSuspension::Update ( const FTransform LocalToWorld,
const FVector LinearVelocity,
const FVector AngularVelocityRad,
const FSimpleSuspensionRaycast RaycastFunction = SimpleSuspensionRaycastGroundPlane 
)

Compute suspension compressions, individual spring forces, and the total force that the suspension system wants to apply to the body. Actual application of this force must be done by someone else.

Member Data Documentation

◆ SuspensionParams

FSimpleSuspensionParams FSimpleSuspension::SuspensionParams

◆ SuspensionState

FSimpleSuspensionState FSimpleSuspension::SuspensionState

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