1. Epic GamesDeveloper
  3. FSimpleWheelSim

FSimpleWheelSim

Wheel instance data changes during the simulation

API > API/Runtime > API/Runtime/ChaosVehiclesCore

Wheel instance data changes during the simulation

   
Name FSimpleWheelSim
Type class
Header File /Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/WheelSystem.h
Include Path #include "WheelSystem.h"

Syntax

class FSimpleWheelSim : public TVehicleSystem< FSimpleWheelConfig >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FSimpleWheelSim ( const FSimpleWheelConfig* SetupIn
)

   WheelSystem.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ABSEnabled bool   WheelSystem.h  
AngularPosition float   WheelSystem.h  
AppliedLinearBrakeForce float   WheelSystem.h  
AppliedLinearDriveForce float Debug for now WheelSystem.h  
AvailableGrip float   WheelSystem.h  
bABSActivated bool   WheelSystem.h  
bClipping bool   WheelSystem.h  
bEngineBraking bool   WheelSystem.h  
bInContact bool   WheelSystem.h  
BrakeEnabled bool   WheelSystem.h  
BrakeTorque float   WheelSystem.h  
CorneringStiffness float   WheelSystem.h  
DriveTorque float In. WheelSystem.h  
EngineEnabled bool   WheelSystem.h  
ExternalBrakeTorque float   WheelSystem.h  
ExternalDriveTorque float   WheelSystem.h  
ExternalTorqueCombineMethod FSimpleWheelConfig::EExternalTorqueCombineMethod   WheelSystem.h  
ForceFromFriction FVector   WheelSystem.h  
ForceIntoSurface float   WheelSystem.h  
FrictionMultiplier float   WheelSystem.h  
GroundVelocityVector FVector   WheelSystem.h  
HandbrakeEnabled bool   WheelSystem.h  
HandbrakeTorque float   WheelSystem.h  
Inertia float   WheelSystem.h  
InputForces FVector   WheelSystem.h  
LateralAdhesiveLimit float   WheelSystem.h  
LateralSlipGraphMultiplier float   WheelSystem.h  
LongitudinalAdhesiveLimit float   WheelSystem.h  
MassPerWheel float   WheelSystem.h  
MaxBrakeTorque float   WheelSystem.h  
MaxOmega float   WheelSystem.h  
MaxSteeringAngle float   WheelSystem.h  
Omega float   WheelSystem.h  
Re float   WheelSystem.h  
SideSlipModifier float   WheelSystem.h  
SlipAngle float   WheelSystem.h  
SlipVelocity float   WheelSystem.h  
Spin float   WheelSystem.h  
SteeringAngle float   WheelSystem.h  
SteeringEnabled bool   WheelSystem.h  
SurfaceFriction float   WheelSystem.h  
Sx float   WheelSystem.h  
TractionControlEnabled bool   WheelSystem.h  
WheelIndex uint32   WheelSystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

float GetAngularPosition()

 Get the angular position of the wheel [radians] WheelSystem.h  

float GetAngularVelocity()

 Get the angular velocity of the wheel [radians/sec] WheelSystem.h  

float GetBrakeTorque()

 Get the braking torque being applied to the wheel [N.m] WheelSystem.h  

float GetDriveTorque()

 Get the drive torque being applied to the wheel [N.m] WheelSystem.h  

float GetEffectiveRadius()

 Get the radius of the wheel [cm] WheelSystem.h  

FVector GetForceFromFriction()

 Return the calculated available friction force WheelSystem.h  

float GetNormalizedLateralSlip()

   WheelSystem.h  

float GetNormalizedLongitudinalSlip()

 Get the current longitudinal slip value [0 no slip - using static friction, 1 full slip - using dynamic friction] WheelSystem.h  

float GetRoadSpeed()

 Get the road speed at the wheel WheelSystem.h  

float GetSkidMagnitude()

 Get the effective ground speed along the lateral wheel axis positive if wheel is faster than effective ground speed, negative if wheel is slower WheelSystem.h  

float GetSlipAngle()

 Get the slip angle for this wheel - angle between wheel forward axis and velocity vector [degrees] WheelSystem.h  

float GetSlipMagnitude()

 Get the difference between the wheel speed and the effective ground speed of the vehicle at the wheel positive if wheel is faster than effective ground speed, negative if wheel is slower WheelSystem.h  

float GetSteeringAngle()

   WheelSystem.h  

float GetSurfaceFriction()

 Get the friction coefficient of the surface in contact with the wheel WheelSystem.h  

float GetWheelGroundSpeed()

 Get the linear ground speed of the wheel based on its current rotational speed WheelSystem.h  

float GetWheelLoadForce()

 Get the magnitude of the force pressing the wheel into the terrain WheelSystem.h  

float GetWheelRPM()

 Get the wheel RPM [revolutions per minute] WheelSystem.h  

bool InContact()

 Is the wheel in contact with the terrain or another object WheelSystem.h  

bool IsABSActivated()

   WheelSystem.h  

bool IsSkidding()

   WheelSystem.h  

bool IsSlipping()

   WheelSystem.h  

void SetAngularPosition ( float PositionIn
)

 Set the angular position in radians WheelSystem.h  

void SetAngularVelocity ( float AngularVelocityIn
)

 Set the angular position in radians/sec WheelSystem.h  

void SetBrakeTorque ( float BrakeTorqueIn,
bool bEngineBrakingIn
)

 Set the braking torque - decelerating rotational force WheelSystem.h  

void SetBrakeTorqueOverride ( float BrakeTorqueIn,
bool bEngineBrakingIn
)

   WheelSystem.h  

void SetDriveTorque ( float EngineTorqueIn
)

 Set the drive torque - accelerating rotational force WheelSystem.h  

void SetDriveTorqueOverride ( float EngineTorqueIn
)

   WheelSystem.h  

void SetMassPerWheel ( float VehicleMassPerWheel
)

   WheelSystem.h  

void SetMatchingSpeed ( float LinearMetersPerSecondIn
)

 Set wheel rotational speed to match the specified linear forwards speed WheelSystem.h  

void SetMaxOmega ( float InMaxOmega
)

   WheelSystem.h  

void SetOnGround ( bool OnGround
)

   WheelSystem.h  

void SetSteeringAngle ( float InAngle
)

   WheelSystem.h  

void SetSurfaceFriction ( float InFriction
)

 Set the friction coefficient of the surface under the wheel WheelSystem.h  

void SetTorqueCombineMethod ( FSimpleWheelConfig::EExternalTorqueCombineMethod InCombineMethod
)

   WheelSystem.h  

void SetVehicleGroundSpeed ( const FVector& VIn
)

 Set the vehicle's speed at the wheels location in local wheel coords WheelSystem.h  

void SetWheelIndex ( uint32 InIndex
)

   WheelSystem.h  

void SetWheelLoadForce ( float WheelLoadForceIn
)

 Set the force pressing the wheel into the terrain - from suspension WheelSystem.h  

void SetWheelRadius ( float NewRadius
)

 Set the wheel radius - can change dynamically during simulation if desired WheelSystem.h  

void Simulate ( float DeltaTime
)

 Simulate - figure out wheel lateral and longitudinal forces based on available friction at the wheel Wheel load force from body weight and the surface friction together determine the grip available at the wheel DriveTorque accelerates the wheel BrakeTorque decelerates the wheel WheelSystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static float GetNormalisedFrictionFromSlipAngle ( float SlipIn
)

 Amount of friction we can expect after taking into account the amount the wheel slips WheelSystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page