Navigation
API > API/Runtime > API/Runtime/ChaosVehiclesCore
| Name | FWheelSimModule |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/WheelModule.h |
| Include Path | #include "SimModule/WheelModule.h" |
Syntax
class FWheelSimModule :
public Chaos::FWheelBaseInterface ,
public Chaos::TSimModuleSettings< FWheelSettings > ,
public Chaos::TSimulationModuleTypeable< FWheelSimModule >
Inheritance Hierarchy
- TSimulationModuleTypeable → FTorqueSimModule → FWheelBaseInterface → FWheelSimModule
- TSimulationModuleTypeable → FWheelBaseInterface → FWheelSimModule
- TSimModuleSettings → FWheelSimModule
- TSimulationModuleTypeable → FWheelSimModule
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWheelSimModule
(
const FWheelSettings& Settings |
SimModule/WheelModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bPrevTouchingGround | bool | SimModule/WheelModule.h | ||
| BrakeTorque | float | SimModule/WheelModule.h | ||
| bTouchingGround | bool | For output | SimModule/WheelModule.h | |
| ForceFromFriction | FVector | SimModule/WheelModule.h | ||
| FWheelOutputData | friend | SimModule/WheelModule.h | ||
| MassPerWheel | float | SimModule/WheelModule.h | ||
| SlipAngle | float | SimModule/WheelModule.h | ||
| SteerAngleDegrees | float | SimModule/WheelModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetEffectiveRadius() |
Get the radius of the wheel [cm] | SimModule/WheelModule.h | |
FVector GetForceFromFriction() |
SimModule/WheelModule.h | ||
float GetLinearSpeed() |
Get linear forwards speed from angluar velocity and wheel radius | SimModule/WheelModule.h | |
float GetSteerAngleDegrees() |
SimModule/WheelModule.h | ||
void SetLinearSpeed
(
float LinearMetersPerSecondIn |
Set wheel rotational speed to match the specified linear forwards speed | SimModule/WheelModule.h |
Overridden from FWheelBaseInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float GetWheelRadius() |
SimModule/WheelModule.h |
Overridden from ISimulationModuleBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Animate() |
Animate/modify the childToParent transforms, to say rotate a wheel, or rudder, etc | SimModule/WheelModule.h | |
virtual TSharedPtr< FModuleNetData > GenerateNetData
(
const int32 NodeArrayIndex |
This is the replication datas | SimModule/WheelModule.h | |
virtual FSimOutputData * GenerateOutputData() |
SimModule/WheelModule.h | ||
virtual const FString GetDebugName() |
Get the friendly name for this module, primarily for logging & debugging module tree | SimModule/WheelModule.h | |
virtual bool GetDebugString
(
FString& StringOut |
Option to return debug text for drawing on the HUD in the Game Thread | SimModule/WheelModule.h | |
virtual bool IsBehaviourType
(
eSimModuleTypeFlags InType |
Is Module of a specific type - used for casting | SimModule/WheelModule.h | |
virtual void Simulate
(
float DeltaTime, |
The main Simulation function that is called from the physics async callback thread | SimModule/WheelModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName CHAOSTYPENAMERETRIVAL() |
SimModule/WheelModule.h |