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

#include <SuspensionSystem.h>

+ Inheritance diagram for Chaos::FSimpleSuspensionSim:

Public Member Functions

 FSimpleSuspensionSim (const FSimpleSuspensionConfig *SetupIn)
 
void SetSuspensionLength (float InLength, float WheelRadius)
 
float GetNormalizedLength ()
 
void SetLocalVelocity (const FVector &InVelocity)
 
void SetLocalVelocityFromWorld (const FTransform &InWorldTransform, const FVector &InWorldVelocity)
 
void SetLocalRestingPosition (const FVector &InOffset)
 
void SetSpringIndex (uint32 InIndex)
 
void UpdateWorldRaycastLocation (const FTransform &BodyTransform, float WheelRadius, FSuspensionTrace &OutTrace)
 
float GetTraceLength (float WheelRadius)
 
float GetSpringLength ()
 
float GetSuspensionForce () const
 
FVector GetSuspensionForceVector (const FTransform &InTransform)
 
float GetSuspensionOffset ()
 
const FVectorGetLocalRestingPosition () const
 
void Simulate (float DeltaTime)
 
int32 GetAveragingCount () const
 
int32 GetAveragingNum () const
 
float GetLastSpringLength () const
 
float GetLastDisplacement () const
 
float GetAveragingLength (const int32 LengthIndex) const
 
void SetAveragingCount (const int32 InAveragingCount)
 
void SetAveragingNum (const int32 InAveragingNum)
 
void SetLastSpringLength (const float InLastSpringLength)
 
void SetLastDisplacement (const float InLastDisplacement)
 
void SetAveragingLength (const int32 LengthIndex, const float InAveragingLength)
 
- Public Member Functions inherited from TVehicleSystem< FSimpleSuspensionConfig >
 TVehicleSystem ()
 
 TVehicleSystem (const FSimpleSuspensionConfig *SetupIn)
 
FSimpleSuspensionConfig & AccessSetup ()
 
const FSimpleSuspensionConfig & Setup () const
 

Protected Attributes

float DisplacementInput
 
float LastDisplacement
 
FVector LocalVelocity
 
float SuspensionForce
 
FVector LocalOffset
 
float SpringDisplacement
 
uint32 SpringIndex
 
float LastSpringLength
 
float AveragingLength [NUM_SUS_AVERAGING]
 
int AveragingCount
 
int AveragingNum
 

Additional Inherited Members

- Public Attributes inherited from TVehicleSystem< FSimpleSuspensionConfig >
const FSimpleSuspensionConfig * SetupPtr
 

Constructor & Destructor Documentation

◆ FSimpleSuspensionSim()

Chaos::FSimpleSuspensionSim::FSimpleSuspensionSim ( const FSimpleSuspensionConfig SetupIn)
inline

Member Function Documentation

◆ GetAveragingCount()

int32 Chaos::FSimpleSuspensionSim::GetAveragingCount ( ) const
inline

◆ GetAveragingLength()

float Chaos::FSimpleSuspensionSim::GetAveragingLength ( const int32  LengthIndex) const
inline

◆ GetAveragingNum()

int32 Chaos::FSimpleSuspensionSim::GetAveragingNum ( ) const
inline

◆ GetLastDisplacement()

float Chaos::FSimpleSuspensionSim::GetLastDisplacement ( ) const
inline

◆ GetLastSpringLength()

float Chaos::FSimpleSuspensionSim::GetLastSpringLength ( ) const
inline

◆ GetLocalRestingPosition()

const FVector & Chaos::FSimpleSuspensionSim::GetLocalRestingPosition ( ) const
inline

◆ GetNormalizedLength()

float Chaos::FSimpleSuspensionSim::GetNormalizedLength ( )
inline

◆ GetSpringLength()

float Chaos::FSimpleSuspensionSim::GetSpringLength ( )

◆ GetSuspensionForce()

float Chaos::FSimpleSuspensionSim::GetSuspensionForce ( ) const
inline

◆ GetSuspensionForceVector()

FVector Chaos::FSimpleSuspensionSim::GetSuspensionForceVector ( const FTransform InTransform)
inline

◆ GetSuspensionOffset()

float Chaos::FSimpleSuspensionSim::GetSuspensionOffset ( )
inline

◆ GetTraceLength()

float Chaos::FSimpleSuspensionSim::GetTraceLength ( float  WheelRadius)
inline

◆ SetAveragingCount()

void Chaos::FSimpleSuspensionSim::SetAveragingCount ( const int32  InAveragingCount)
inline

◆ SetAveragingLength()

void Chaos::FSimpleSuspensionSim::SetAveragingLength ( const int32  LengthIndex,
const float  InAveragingLength 
)
inline

◆ SetAveragingNum()

void Chaos::FSimpleSuspensionSim::SetAveragingNum ( const int32  InAveragingNum)
inline

◆ SetLastDisplacement()

void Chaos::FSimpleSuspensionSim::SetLastDisplacement ( const float  InLastDisplacement)
inline

◆ SetLastSpringLength()

void Chaos::FSimpleSuspensionSim::SetLastSpringLength ( const float  InLastSpringLength)
inline

◆ SetLocalRestingPosition()

void Chaos::FSimpleSuspensionSim::SetLocalRestingPosition ( const FVector InOffset)
inline

◆ SetLocalVelocity()

void Chaos::FSimpleSuspensionSim::SetLocalVelocity ( const FVector InVelocity)
inline

set local velocity at suspension position

◆ SetLocalVelocityFromWorld()

void Chaos::FSimpleSuspensionSim::SetLocalVelocityFromWorld ( const FTransform InWorldTransform,
const FVector InWorldVelocity 
)
inline

◆ SetSpringIndex()

void Chaos::FSimpleSuspensionSim::SetSpringIndex ( uint32  InIndex)
inline

◆ SetSuspensionLength()

void Chaos::FSimpleSuspensionSim::SetSuspensionLength ( float  InLength,
float  WheelRadius 
)
inline

todo: Change This ; Set suspension length after determined from raycast

◆ Simulate()

void Chaos::FSimpleSuspensionSim::Simulate ( float  DeltaTime)

◆ UpdateWorldRaycastLocation()

void Chaos::FSimpleSuspensionSim::UpdateWorldRaycastLocation ( const FTransform BodyTransform,
float  WheelRadius,
FSuspensionTrace OutTrace 
)
inline

Member Data Documentation

◆ AveragingCount

int Chaos::FSimpleSuspensionSim::AveragingCount
protected

◆ AveragingLength

float Chaos::FSimpleSuspensionSim::AveragingLength[NUM_SUS_AVERAGING]
protected

◆ AveragingNum

int Chaos::FSimpleSuspensionSim::AveragingNum
protected

◆ DisplacementInput

float Chaos::FSimpleSuspensionSim::DisplacementInput
protected

◆ LastDisplacement

float Chaos::FSimpleSuspensionSim::LastDisplacement
protected

◆ LastSpringLength

float Chaos::FSimpleSuspensionSim::LastSpringLength
protected

◆ LocalOffset

FVector Chaos::FSimpleSuspensionSim::LocalOffset
protected

◆ LocalVelocity

FVector Chaos::FSimpleSuspensionSim::LocalVelocity
protected

◆ SpringDisplacement

float Chaos::FSimpleSuspensionSim::SpringDisplacement
protected

◆ SpringIndex

uint32 Chaos::FSimpleSuspensionSim::SpringIndex
protected

◆ SuspensionForce

float Chaos::FSimpleSuspensionSim::SuspensionForce
protected

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