Class WheeledVehicle.Wheel

Vehicle wheel settings.

System.Object
WheeledVehicle.Wheel
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class Wheel : ValueType

Fields

Collider

Collider that represents the wheel shape and it's placement. Has to be attached as a child to the vehicle. Triangle mesh collider is not supported (use convex mesh or basic shapes).

Declaration
[EditorOrder(4)]
public Collider Collider
Field Value
Collider

DampingRate

Damping rate applied to wheel. Specified in kilograms metres-squared per second (kg m^2 s^-1).

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Steering", null)]
[EditorOrder(11)]
public float DampingRate
Field Value
System.Single

Mass

Combined mass of the wheel and the tire in kg. Typically, a wheel has mass between 20Kg and 80Kg but can be lower and higher depending on the vehicle.

Declaration
[EditorOrder(1)]
public float Mass
Field Value
System.Single

MaxBrakeTorque

Max brake torque that can be applied to wheel. Specified in kilograms metres-squared per second-squared (kg m^2 s^-2)

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Steering", null)]
[EditorOrder(12)]
public float MaxBrakeTorque
Field Value
System.Single

MaxHandBrakeTorque

Max handbrake torque that can be applied to wheel. Specified in kilograms metres-squared per second-squared (kg m^2 s^-2)

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Steering", null)]
[EditorOrder(13)]
public float MaxHandBrakeTorque
Field Value
System.Single

MaxSteerAngle

Max steer angle that can be achieved by the wheel (in degrees, -180 to 180).

Declaration
[Limit(-180F, 180F, 1F)]
[EditorDisplay("Steering", null)]
[EditorOrder(10)]
public float MaxSteerAngle
Field Value
System.Single

Radius

Distance in metres between the center of the wheel and the outside rim of the tire. It is important that the value of the radius closely matches the radius of the render mesh of the wheel. Any mismatch will result in the wheels either hovering above the ground or intersecting the ground.

Declaration
[EditorOrder(2)]
public float Radius
Field Value
System.Single

SprungMassMultiplier

Spring sprung mass force multiplier.

Declaration
[Limit(0.01F, 3.40282347E+38F, 1F)]
[EditorDisplay("Suspension", null)]
[EditorOrder(19)]
public float SprungMassMultiplier
Field Value
System.Single

SuspensionDampingRate

Spring damper rate of suspension unit.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Suspension", null)]
[EditorOrder(20)]
public float SuspensionDampingRate
Field Value
System.Single

SuspensionForceOffset

The vertical offset from where suspension forces are applied (relative to the vehicle center of mass). The suspension force is applies on the vertical axis going though the wheel center.

Declaration
[EditorDisplay("Suspension", null)]
[EditorOrder(23)]
public float SuspensionForceOffset
Field Value
System.Single

SuspensionMaxDrop

The maximum offset for the suspension that wheel can go below resting location.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Suspension", null)]
[EditorOrder(22)]
public float SuspensionMaxDrop
Field Value
System.Single

SuspensionMaxRaise

The maximum offset for the suspension that wheel can go above resting location.

Declaration
[Limit(0F, 3.40282347E+38F, 1F)]
[EditorDisplay("Suspension", null)]
[EditorOrder(21)]
public float SuspensionMaxRaise
Field Value
System.Single

TireFrictionScale

The tire friction scale (scales the drivable surface friction under the tire).

Declaration
[EditorDisplay("Tire", null)]
[EditorOrder(33)]
public float TireFrictionScale
Field Value
System.Single

TireLateralMax

The maximum tire load (normalized) at which tire cannot provide more lateral stiffness (no matter how much extra load is applied to it).

Declaration
[EditorDisplay("Tire", null)]
[EditorOrder(31)]
public float TireLateralMax
Field Value
System.Single

TireLateralStiffness

The tire lateral stiffness to have given lateral slip.

Declaration
[EditorDisplay("Tire", null)]
[EditorOrder(30)]
public float TireLateralStiffness
Field Value
System.Single

TireLongitudinalStiffness

The tire longitudinal stiffness to have given longitudinal slip.

Declaration
[EditorDisplay("Tire", null)]
[EditorOrder(32)]
public float TireLongitudinalStiffness
Field Value
System.Single

Width

Full width of the wheel in metres. This parameter has no bearing on the handling but is a very useful parameter to have when trying to render debug data relating to the wheel/tire/suspension.

Declaration
[EditorOrder(3)]
public float Width
Field Value
System.Single

Properties

Default

The default WheeledVehicle.Wheel.

Declaration
public static WheeledVehicle.Wheel Default { get; }
Property Value
WheeledVehicle.Wheel

Extension Methods