Class VehicleWheelConfiguration

Configuration for a wheel of a vehicle. This contains properties describing the geometry and behavior of the wheel itself, as well as the suspension that the wheel is attached to.

Hierarchy

  • FrameworkObject
    • VehicleWheelConfiguration

Constructors

Accessors

  • get camber(): rsx.Degree
  • Camber angle of the wheel. This is the angle how far the wheel is tilted along the forward axis of the vehicle.

    Returns rsx.Degree

  • set camber(value): void
  • Parameters

    Returns void

  • get isVisualModelFlipped(): boolean
  • Whether the visual model should be flipped along the x-axis. This way, the same wheel model can be used wheels on both sides of the vehicle.

    Returns boolean

  • set isVisualModelFlipped(value): void
  • Parameters

    • value: boolean

    Returns void

  • get maximumBrakeTorque(): number
  • Maximum torque the brake can apply to the wheel.

    Returns number

  • set maximumBrakeTorque(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumHandBrakeTorque(): number
  • Maximum torque the handbrake can apply to the wheel.

    Returns number

  • set maximumHandBrakeTorque(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumLength(): number
  • Maximum length of the suspension. The bottom end of the suspension will be at a distance of maximumLength from position in the suspensionDirection.

    Returns number

  • set maximumLength(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumSteeringAngle(): rsx.Degree
  • Maximum steering angle of the wheel. Keep at 0 for wheels that should not turn when steering.

    Returns rsx.Degree

  • set maximumSteeringAngle(value): void
  • Parameters

    Returns void

  • get minimumLength(): number
  • Minimum length of the suspension. The upper end of the suspension will be at a distance of minimumLength from position in the suspensionDirection.

    Returns number

  • set minimumLength(value): void
  • Parameters

    • value: number

    Returns void

  • get name(): string
  • Name of the wheel for organization and ease of access. See CVehicle::findWheel.

    Returns string

  • set name(value): void
  • Parameters

    • value: string

    Returns void

  • get radius(): number
  • Radius of the wheel.

    Returns number

  • set radius(value): void
  • Parameters

    • value: number

    Returns void

  • get suspensionDamping(): number
  • Spring damping of the suspension. It determines how bouncy the suspension feels. This should be tuned according to the suspensionStiffness. A good starting value for tuning this parameter is 0.1 * suspensionStiffness.

    Returns number

  • set suspensionDamping(value): void
  • Parameters

    • value: number

    Returns void

  • get suspensionPreload(): number
  • How much the suspension is pre-loaded. The suspension is a spring and its force is proportional to how far it is compressed. The pre-load determines how much the spring is compressed even when the suspension is fully extended. If greater than 0, it causes the suspension to produce force, even when it is fully extended. Excessivley large values may cause unstable simulation behavior.

    Returns number

  • set suspensionPreload(value): void
  • Parameters

    • value: number

    Returns void

  • get suspensionStiffness(): number
  • Spring stiffness of the suspension. This determines how much force the suspension creates when it is compressed.

    Returns number

  • set suspensionStiffness(value): void
  • Parameters

    • value: number

    Returns void

  • get toe(): rsx.Degree
  • Toe angle of the wheel. This is the angle how far the wheel is turned around the up axis of the vehicle.

    Returns rsx.Degree

  • set toe(value): void
  • Parameters

    Returns void

  • get transformBase(): EnumValue<VehicleWheelTransformBaseType, number>
  • Defines around which point the visual model of a wheel is rotated. In Pivot mode, the visual model rotates around its pivot. In WheelCenter mode, it rotates around the center of the simulated wheel. This incurs a slight performance penalty, but can be used even when the visual model pivot is off-center. Only has an effect when the visual model type is Path.

    Returns EnumValue<VehicleWheelTransformBaseType, number>

  • set transformBase(value): void
  • Parameters

    Returns void

  • get visualModel(): VehicleVisualModel
  • The visual model used to represent the wheel graphically. Note that the wheel should not have any active Collider components. If this is a template, this means that the template should not contain active Collider components. If this is a path, the scene object pointed to by the path should not have any active Collider components.

    Returns VehicleVisualModel

  • set visualModel(value): void
  • Parameters

    Returns void

  • get width(): number
  • Width of the wheel.

    Returns number

  • set width(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Copies relevant properties from other to this wheel.

    Parameters

    • other: VehicleWheelConfiguration

      The other wheel to copy the properties from.

    • isMirrored: boolean

      Whether other is on the opposite side of the vehicle and vectors need to be flipped.

    Returns void