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

#include <SuspensionBaseInterface.h>

+ Inheritance diagram for Chaos::FSuspensionBaseInterface:

Public Member Functions

 DEFINE_CHAOSSIMTYPENAME (FSuspensionBaseInterface)
 
 FSuspensionBaseInterface ()
 
virtual ~FSuspensionBaseInterface ()
 
virtual UE_API bool IsBehaviourType (eSimModuleTypeFlags InType) const override
 
virtual float GetMaxSpringLength () const =0
 
virtual float GetSpringLength () const =0
 
virtual void SetSpringLength (float InLength, float WheelRadius)=0
 
virtual void GetWorldRaycastLocation (const FTransform &BodyTransform, float WheelRadius, FSpringTrace &OutTrace)=0
 
UE_API void SetTargetPoint (const FSuspensionTargetPoint &InTargetPoint)
 
const FSuspensionTargetPointGetTargetPoint () const
 
bool IsWheelInContact () const
 
void SetWheelSimTreeIndex (int WheelTreeIndexIn)
 
int GetWheelSimTreeIndex () const
 
TEnumAsByte< EPhysicalSurfaceGetSurfaceType () const
 
void SetImpactNormal (const FVector &NewValue)
 
const FVectorGetImpactNormal () const
 
void SetHitDistance (const float NewValue)
 
float GetHitDistance () const
 
void SetTargetPosition (const FVector &NewValue)
 
const FVectorGetTargetPosition () const
 
- Public Member Functions inherited from Chaos::ISimulationModuleBase
 DEFINE_CHAOSSIMTYPENAME (ISimulationModuleBase)
 
 ISimulationModuleBase ()
 
virtual ~ISimulationModuleBase ()
 
int GetGuid () const
 
void SetGuid (int GuidIn)
 
virtual const FString GetDebugName () const =0
 
virtual bool IsEnabled () const
 
void SetStateFlags (eSimModuleState StateFlagsIn)
 
virtual void OnConstruction_External (const Chaos::FPhysicsObjectHandle &PhysicsObject)
 
virtual void OnTermination_External ()
 
virtual void Simulate (IPhysicsProxyBase *Proxy, Chaos::FPBDRigidParticleHandle *ParticleHandle, float DeltaTime, const FAllInputs &Inputs, FSimModuleTree &VehicleModuleSystem)
 
virtual void OnContactModification (Chaos::FCollisionContactModifier &Modifier, IPhysicsProxyBase *Proxy)
 
virtual void Simulate (float DeltaTime, const FAllInputs &Inputs, FSimModuleTree &VehicleModuleSystem)
 
virtual void Animate ()
 
void SetAnimationEnabled (bool bInEnabled)
 
bool IsAnimationEnabled ()
 
UE_API void SetAnimationData (const FName &BoneNameIn, const FVector &AnimationOffsetIn, int AnimationSetupIndexIn)
 
const FSimModuleAnimationDataGetAnimationData () const
 
const FVectorGetAnimationOffset () const
 
const FNameGetBoneName () const
 
int GetAnimationSetupIndex ()
 
virtual void DrawDebugInfo ()
 
virtual UE_API bool GetDebugString (FString &StringOut) const
 
void SetTransformIndex (int TransformIndexIn)
 
const int GetTransformIndex () const
 
void SetParticleIndex (FUniqueIdx ParticleIndexIn)
 
const FUniqueIdx GetParticleIndex () const
 
void SetTreeIndex (int TreeIndexIn)
 
int GetTreeIndex () const
 
void SetSimModuleTree (FSimModuleTree *SimModuleTreeIn)
 
UE_API void AddLocalForceAtPosition (const FVector &Force, const FVector &Position, bool bAllowSubstepping=true, bool bIsLocalForce=false, bool bLevelSlope=false, const FColor &DebugColorIn=FColor::Blue)
 
UE_API void AddForceAtCOMPosition (const FVector &Force, const FVector &OffsetFromCOM=FVector::ZeroVector, bool bAllowSubstepping=true, bool bLevelSlope=false, const FColor &DebugColorIn=FColor::Blue)
 
UE_API void AddLocalForce (const FVector &Force, bool bAllowSubstepping=true, bool bIsLocalForce=false, bool bLevelSlope=false, const FColor &DebugColorIn=FColor::Blue)
 
UE_API void AddLocalTorque (const FVector &Torque, bool bAllowSubstepping=true, bool bAccelChangeIn=true, const FColor &DebugColorIn=FColor::Magenta)
 
void SetClustered (bool IsClusteredIn)
 
bool IsClustered () const
 
void SetClusteredTransform (const FTransform &TransformIn)
 
const FTransformGetClusteredTransform () const
 
void SetInitialParticleTransform (const FTransform &TransformIn)
 
const FTransformGetInitialParticleTransform () const
 
void SetComponentTransform (const FTransform &TransformIn)
 
const FTransformGetComponentTransform () const
 
void SetIntactTransform (const FTransform &TransformIn)
 
const FTransformGetIntactTransform () const
 
UE_API const FTransformGetParentRelativeTransform () const
 
void SetLocalLinearVelocity (const FVector &VelocityIn)
 
const FVectorGetLocalLinearVelocity () const
 
void SetLocalAngularVelocity (const FVector &VelocityIn)
 
const FVectorGetLocalAngularVelocity () const
 
UE_API ISimulationModuleBaseGetParent ()
 
UE_API ISimulationModuleBaseGetFirstChild ()
 
UE_API FVehicleBlackboardGetSimBlackboard ()
 
const FVectorGetAppliedForce ()
 
virtual TSharedPtr< FModuleNetDataGenerateNetData (const int32 NodeArrayIndex) const =0
 
virtual FSimOutputDataGenerateOutputData () const
 
UE_API Chaos::FPBDRigidClusteredParticleHandleGetClusterParticle (Chaos::FClusterUnionPhysicsProxy *Proxy)
 
UE_API Chaos::FPBDRigidParticleHandleGetParticleFromUniqueIndex (int32 ParticleUniqueIdx, TArray< Chaos::FPBDRigidParticleHandle * > &Particles)
 
- Public Member Functions inherited from Chaos::FSimulationModuleTypeContainer
void AddType (FName InType)
 
bool IsSimType (FName InType) const
 
FName GetSimType () const
 
template<typename U >
bool IsSimType () const
 
template<typename U >
U * Cast ()
 
template<typename U >
const U * Cast () const
 
- Public Member Functions inherited from Chaos::TSimulationModuleTypeableBase< ISimulationModuleBase >
 TSimulationModuleTypeableBase ()
 

Protected Attributes

int WheelSimTreeIndex = INVALID_IDX
 
- Protected Attributes inherited from Chaos::ISimulationModuleBase
FSimModuleTreeSimModuleTree
 
int SimTreeIndex
 
eSimModuleState StateFlags
 
int TransformIndex
 
FUniqueIdx ParticleIdx
 
FTransform InitialParticleTransform
 
FTransform RelativeOffsetTransform
 
FTransform ComponentTransform
 
FTransform ClusteredCOMRelativeTransform
 
FTransform IntactCOMRelativeTransform
 
FVector LocalLinearVelocity
 
FVector LocalAngularVelocity
 
bool bClustered
 
bool bAnimationEnabled
 
FVector AnimationOffset
 
FSimModuleAnimationData AnimationData
 
FVector AppliedForce
 
int Guid
 
FPBDRigidClusteredParticleHandleCachedParticle
 

Additional Inherited Members

- Static Public Member Functions inherited from Chaos::FSimulationModuleTypeContainer
template<typename U >
static FName GetStaticSimType ()
 
- Static Public Member Functions inherited from Chaos::TSimulationModuleTypeableBase< ISimulationModuleBase >
static FName StaticSimTypeBase ()
 
- Public Attributes inherited from Chaos::ISimulationModuleBase
bool IsInitialized = false
 
- Public Attributes inherited from Chaos::FSimulationModuleTypeContainer
TSet< FNameMyTypes
 
FName MostRecentAdd = NAME_None
 
- Static Public Attributes inherited from Chaos::ISimulationModuleBase
static const int INVALID_IDX = -1
 

Constructor & Destructor Documentation

◆ FSuspensionBaseInterface()

Chaos::FSuspensionBaseInterface::FSuspensionBaseInterface ( )
inline

◆ ~FSuspensionBaseInterface()

virtual Chaos::FSuspensionBaseInterface::~FSuspensionBaseInterface ( )
inlinevirtual

Member Function Documentation

◆ DEFINE_CHAOSSIMTYPENAME()

Chaos::FSuspensionBaseInterface::DEFINE_CHAOSSIMTYPENAME ( FSuspensionBaseInterface  )

◆ GetHitDistance()

float Chaos::FSuspensionBaseInterface::GetHitDistance ( ) const
inline

◆ GetImpactNormal()

const FVector & Chaos::FSuspensionBaseInterface::GetImpactNormal ( ) const
inline

◆ GetMaxSpringLength()

virtual float Chaos::FSuspensionBaseInterface::GetMaxSpringLength ( ) const
pure virtual

◆ GetSpringLength()

virtual float Chaos::FSuspensionBaseInterface::GetSpringLength ( ) const
pure virtual

◆ GetSurfaceType()

TEnumAsByte< EPhysicalSurface > Chaos::FSuspensionBaseInterface::GetSurfaceType ( ) const
inline

◆ GetTargetPoint()

const FSuspensionTargetPoint & Chaos::FSuspensionBaseInterface::GetTargetPoint ( ) const
inline

◆ GetTargetPosition()

const FVector & Chaos::FSuspensionBaseInterface::GetTargetPosition ( ) const
inline

◆ GetWheelSimTreeIndex()

int Chaos::FSuspensionBaseInterface::GetWheelSimTreeIndex ( ) const
inline

◆ GetWorldRaycastLocation()

virtual void Chaos::FSuspensionBaseInterface::GetWorldRaycastLocation ( const FTransform BodyTransform,
float  WheelRadius,
FSpringTrace OutTrace 
)
pure virtual

◆ IsBehaviourType()

bool Chaos::FSuspensionBaseInterface::IsBehaviourType ( eSimModuleTypeFlags  InType) const
overridevirtual

Is Module of a specific behavioral data type

Implements Chaos::ISimulationModuleBase.

◆ IsWheelInContact()

bool Chaos::FSuspensionBaseInterface::IsWheelInContact ( ) const
inline

◆ SetHitDistance()

void Chaos::FSuspensionBaseInterface::SetHitDistance ( const float  NewValue)
inline

◆ SetImpactNormal()

void Chaos::FSuspensionBaseInterface::SetImpactNormal ( const FVector NewValue)
inline

◆ SetSpringLength()

virtual void Chaos::FSuspensionBaseInterface::SetSpringLength ( float  InLength,
float  WheelRadius 
)
pure virtual

◆ SetTargetPoint()

void Chaos::FSuspensionBaseInterface::SetTargetPoint ( const FSuspensionTargetPoint InTargetPoint)

◆ SetTargetPosition()

void Chaos::FSuspensionBaseInterface::SetTargetPosition ( const FVector NewValue)
inline

◆ SetWheelSimTreeIndex()

void Chaos::FSuspensionBaseInterface::SetWheelSimTreeIndex ( int  WheelTreeIndexIn)
inline

Member Data Documentation

◆ WheelSimTreeIndex

int Chaos::FSuspensionBaseInterface::WheelSimTreeIndex = INVALID_IDX
protected

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