VehicleDifferentialSettings Class Reference

#include <VehicleDifferential.h>

Public Member Functions
void	SaveBinaryState (StreamOut &inStream) const
	Saves the contents in binary form to inStream.
void	RestoreBinaryState (StreamIn &inStream)
	Restores the contents in binary form to inStream.
void	CalculateTorqueRatio (float inLeftAngularVelocity, float inRightAngularVelocity, float &outLeftTorqueFraction, float &outRightTorqueFraction) const

Public Attributes
int	mLeftWheel = -1
	Index (in mWheels) that represents the left wheel of this differential (can be -1 to indicate no wheel)
int	mRightWheel = -1
	Index (in mWheels) that represents the right wheel of this differential (can be -1 to indicate no wheel)
float	mDifferentialRatio = 3.42f
	Ratio between rotation speed of gear box and wheels.
float	mLeftRightSplit = 0.5f
	Defines how the engine torque is split across the left and right wheel (0 = left, 0.5 = center, 1 = right)
float	mLimitedSlipRatio = 1.4f
	Ratio max / min wheel speed. When this ratio is exceeded, all torque gets distributed to the slowest moving wheel. This allows implementing a limited slip differential. Set to FLT_MAX for an open differential. Value should be > 1.
float	mEngineTorqueRatio = 1.0f
	How much of the engines torque is applied to this differential (0 = none, 1 = full), make sure the sum of all differentials is 1.

Member Function Documentation

CalculateTorqueRatio()

void VehicleDifferentialSettings::CalculateTorqueRatio	(	float	inLeftAngularVelocity,
		float	inRightAngularVelocity,
		float &	outLeftTorqueFraction,
		float &	outRightTorqueFraction
	)		const

Calculate the torque ratio between left and right wheel

Parameters

inLeftAngularVelocity	Angular velocity of left wheel (rad / s)
inRightAngularVelocity	Angular velocity of right wheel (rad / s)
outLeftTorqueFraction	Fraction of torque that should go to the left wheel
outRightTorqueFraction	Fraction of torque that should go to the right wheel

RestoreBinaryState()

void VehicleDifferentialSettings::RestoreBinaryState

(

StreamIn &

inStream

)

Restores the contents in binary form to inStream.

SaveBinaryState()

void VehicleDifferentialSettings::SaveBinaryState

(

StreamOut &

inStream

)

const

Saves the contents in binary form to inStream.

Member Data Documentation

mDifferentialRatio

float VehicleDifferentialSettings::mDifferentialRatio = 3.42f

Ratio between rotation speed of gear box and wheels.

mEngineTorqueRatio

float VehicleDifferentialSettings::mEngineTorqueRatio = 1.0f

How much of the engines torque is applied to this differential (0 = none, 1 = full), make sure the sum of all differentials is 1.

mLeftRightSplit

float VehicleDifferentialSettings::mLeftRightSplit = 0.5f

Defines how the engine torque is split across the left and right wheel (0 = left, 0.5 = center, 1 = right)

mLeftWheel

int VehicleDifferentialSettings::mLeftWheel = -1

Index (in mWheels) that represents the left wheel of this differential (can be -1 to indicate no wheel)

mLimitedSlipRatio

float VehicleDifferentialSettings::mLimitedSlipRatio = 1.4f

Ratio max / min wheel speed. When this ratio is exceeded, all torque gets distributed to the slowest moving wheel. This allows implementing a limited slip differential. Set to FLT_MAX for an open differential. Value should be > 1.

mRightWheel

int VehicleDifferentialSettings::mRightWheel = -1

Index (in mWheels) that represents the right wheel of this differential (can be -1 to indicate no wheel)

---

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

• Jolt/Physics/Vehicle/VehicleDifferential.h
• Jolt/Physics/Vehicle/VehicleDifferential.cpp