eulerjs API / @eulerjs/vehicle / Wheel

Wheel

Defined in: packages/vehicle/src/RaycastVehicle.ts:55

One wheel of a RaycastVehicle: how it is built, what the driver sets (steering, drive and brake), and what it was doing on the last step.

Constructors

Constructor

new Wheel(options): Wheel;

Defined in: packages/vehicle/src/RaycastVehicle.ts:112

Parameters

Parameter	Type
options	WheelOptions

Returns

Wheel

Properties

Property	Modifier	Type	Default value	Description	Defined in
brakeForce	public	number	0	The most force the brake slows the wheel with, in newtons. It stops the wheel, but never drives it backward.	packages/vehicle/src/RaycastVehicle.ts:80
brakeTorque	public	number	0	With tyres: 'slip': the most torque the brake slows the wheel's spin with, in N·m. brakeForce adds to it, times the radius.	packages/vehicle/src/RaycastVehicle.ts:84
center	readonly	Vector3	...	Where the wheel's centre is, in world space, for drawing it.	packages/vehicle/src/RaycastVehicle.ts:110
compression	public	number	0	How far its spring was compressed, in metres; 0 off the ground.	packages/vehicle/src/RaycastVehicle.ts:89
contactNormal	readonly	Vector3	...	-	packages/vehicle/src/RaycastVehicle.ts:104
contactPoint	readonly	Vector3	...	Where the tyre touched the ground, and the ground's normal there, in world space.	packages/vehicle/src/RaycastVehicle.ts:103
curveShape	readonly	number	undefined	The tyre curve's shape and stiffness (Pacejka's C and B), from slidingGrip.	packages/vehicle/src/RaycastVehicle.ts:72
curveStiffness	readonly	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:73
driveForce	public	number	0	The force the engine drives the tyre forward with, in newtons; negative drives it backward.	packages/vehicle/src/RaycastVehicle.ts:78
driveTorque	public	number	0	With tyres: 'slip': the torque the engine drives the wheel with, in N·m; negative drives it backward. driveForce adds to it, times the radius.	packages/vehicle/src/RaycastVehicle.ts:82
grip	public	number	undefined	Change it to make the tyre slide more or less, as a handbrake does to the rear tyres.	packages/vehicle/src/RaycastVehicle.ts:62
ground	public	Body | undefined	undefined	What it stood on.	packages/vehicle/src/RaycastVehicle.ts:106
inertia	public	number	undefined	In kg·m².	packages/vehicle/src/RaycastVehicle.ts:65
load	public	number	0	How hard the ground pushed on the tyre, in newtons.	packages/vehicle/src/RaycastVehicle.ts:91
loadSensitivity	public	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:69
mount	readonly	Vector3	undefined	-	packages/vehicle/src/RaycastVehicle.ts:56
nominalLoad	public	number | undefined	undefined	-	packages/vehicle/src/RaycastVehicle.ts:70
onGround	public	boolean	false	Whether the tyre was on the ground on the last step.	packages/vehicle/src/RaycastVehicle.ts:87
peakSlipAngle	public	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:66
peakSlipRatio	public	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:67
radius	readonly	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:57
rollingResistance	public	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:63
sliding	public	boolean	false	Whether the tyre was asked for more grip than it has, and slid; with tyres: 'slip', whether it was past its peak.	packages/vehicle/src/RaycastVehicle.ts:93
slidingGrip	readonly	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:68
slipAngle	public	number	0	With tyres: 'slip': the angle between where the tyre points and where it goes, in radians, positive sliding to its left.	packages/vehicle/src/RaycastVehicle.ts:99
slipRatio	public	number	0	With tyres: 'slip': (spin × radius − speed) / speed on the last step: positive spinning up, −1 locked.	packages/vehicle/src/RaycastVehicle.ts:97
spinAngle	public	number	0	How far the wheel has turned about its axle, in radians, for drawing it.	packages/vehicle/src/RaycastVehicle.ts:101
spinSpeed	public	number	0	With tyres: 'slip': how fast the wheel spins about its axle, in rad/s, positive rolling forward.	packages/vehicle/src/RaycastVehicle.ts:95
springDamping	public	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:60
springStiffness	public	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:59
steerAngle	public	number	0	How far the wheel is turned about its strut, in radians: positive turns it to the body's left.	packages/vehicle/src/RaycastVehicle.ts:76
surface	public	GroundSurface | undefined	undefined	What RaycastVehicleOptions.surface said the ground was like where it touched, on the last step.	packages/vehicle/src/RaycastVehicle.ts:108
suspensionLength	readonly	number	undefined	-	packages/vehicle/src/RaycastVehicle.ts:58