Skip to content

Class WheelDesc

Namespace: Apogee.Physics
Assembly: Apogee.Physics.dll

One wheel of a vehicle. The vehicle's space has +Z forward, +Y up and +X to its left (glTF's). Its is where the wheel's center sits with its suspension fully extended: the suspension reaches above that, and the wheel rests somewhere in that travel under the load.

public sealed class WheelDesc : EngineObject

Inheritance

object ← EngineObject ← WheelDesc

Inherited Members

EngineObject.IsAdopted, EngineObject.Handle, EngineObject.IsDestroyed, EngineObject.Class, EngineObject.Adopt(), EngineObject.TryGet(SlotHandle, out EngineObject), EngineObject.Destroy(), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

BrakeFactor

Scales the brake torque while driving: an ABS or a one-sided brake sets it per step (see ).

public float BrakeFactor { get; set; }

Property Value

float

Class

What the registry knows about this object's class.

public override ClassInfo Class { get; }

Property Value

ClassInfo

Entity

An entity (usually a child of the vehicle's entity) whose local transform follows the wheel each frame: its place on the suspension, steered and spinning. 0 for none.

public Entity Entity { get; set; }

Property Value

Entity

Friction

Scales the tire's grip (1 is Jolt's default tire).

public float Friction { get; set; }

Property Value

float

MaxBrakeTorque

Brake torque in N·m at full brake.

public float MaxBrakeTorque { get; set; }

Property Value

float

MaxHandbrakeTorque

public float MaxHandbrakeTorque { get; set; }

Property Value

float

MaxSteerAngle

How far the wheel turns at full steering, in degrees (0: it does not steer).

public float MaxSteerAngle { get; set; }

Property Value

float

Position

Where the wheel's center is with the suspension extended, in the vehicle's space.

public Vector3 Position { get; set; }

Property Value

Vector3

Powered

Whether the engine drives it (wheeled vehicles) or it is the track's sprocket (tracked).

public bool Powered { get; set; }

Property Value

bool

Radius

public float Radius { get; set; }

Property Value

float

SteerRatio

How much of the steering a wheel takes, and which way: 1 for front wheels, -1 for rear steering, 1 on every axle for crab steering. A wheel with no steer angle counts as ratio 0, the fixed axle. With two wheels of different ratios the steered wheels turn about one turning center (Ackermann).

public float SteerRatio { get; set; }

Property Value

float

SuspensionDamping

1 is critically damped.

public float SuspensionDamping { get; set; }

Property Value

float

SuspensionFrequency

The suspension's natural frequency in Hz: higher is stiffer.

public float SuspensionFrequency { get; set; }

Property Value

float

SuspensionLength

How far the wheel can move up from its extended position.

public float SuspensionLength { get; set; }

Property Value

float

TorqueShare

The share of the engine's torque this wheel's axle gets, among the powered axles. By the load on the axles, a lightly loaded front axle would spin.

public float TorqueShare { get; set; }

Property Value

float

Width

public float Width { get; set; }

Property Value

float