Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni.readonly

Interface ConstVehicleDifferentialSettings

All Superinterfaces:

AutoCloseable, Comparable<JoltPhysicsObject>, ConstJoltPhysicsObject

All Known Implementing Classes:

VehicleDifferentialSettings

public interface ConstVehicleDifferentialSettings
extends ConstJoltPhysicsObject

Read-only access to a VehicleDifferentialSettings object. (native type: const VehicleDifferentialSettings)

Method Summary

Modifier and Type	Method	Description
float	getDifferentialRatio()	Return the number of gearbox rotations per wheel rotation.
float	getEngineTorqueRatio()	Return the fraction of the engine's torque that is applied to this differential.
float	getLeftRightSplit()	Return the fraction of the engine's torque that is applied to the right wheel.
int	getLeftWheel()	Return the index of the left wheel.
float	getLimitedSlipRatio()	Return the ratio of maximum wheel speed to minimum wheel speed.
int	getRightWheel()	Return the index of the right wheel.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Method Details

getDifferentialRatio

float getDifferentialRatio()

Return the number of gearbox rotations per wheel rotation. The settings are unaffected.

Returns:

the ratio

getEngineTorqueRatio

float getEngineTorqueRatio()

Return the fraction of the engine's torque that is applied to this differential. The settings are unaffected.

Returns:

the fraction

getLeftRightSplit

float getLeftRightSplit()

Return the fraction of the engine's torque that is applied to the right wheel. The settings are unaffected.

Returns:

the desired fraction (all left=0, all right=1)

getLeftWheel

int getLeftWheel()

Return the index of the left wheel. The settings are unaffected.

Returns:

the index of the wheel (≥0) or -1 for none

getLimitedSlipRatio

float getLimitedSlipRatio()

Return the ratio of maximum wheel speed to minimum wheel speed. The settings are unaffected.

Returns:

the ratio (>1, FLT_MAX for an open differential)

getRightWheel

int getRightWheel()

Return the index of the right wheel. The settings are unaffected.

Returns:

the index of the wheel (≥0) or -1 for none