Class VehicleWheelState

Class that gives access to the simulation state of a vehicle wheel.

Hierarchy

FrameworkObject
- VehicleWheelState

Index

Constructors

Accessors

angularVelocity collision configuration rotationAngle steerAngle suspensionLength transform visualModel visualModelInitialLocalTransform

Constructors

`Protected`constructor

new VehicleWheelState(isInternalConstructor?): VehicleWheelState
Parameters
- OptionalisInternalConstructor: boolean
Returns VehicleWheelState
Overrides FrameworkObject.constructor

Accessors

angularVelocity

get angularVelocity(): number
Get the angular velocity of the wheel.

Returns number
The angular velocity of the wheel.

collision

get collision(): Immutable<VehicleWheelCollision>
Get the collision of the wheel with the ground or null if the wheel does not have ground contact.

Returns Immutable<VehicleWheelCollision>
An object describing the collision of the wheel with the ground.

configuration

get configuration(): VehicleWheelConfiguration
Gets the configuration of this wheel.

Returns VehicleWheelConfiguration

rotationAngle

get rotationAngle(): rsx.Radian
Set the rotation angle of the wheel around its axis.

Returns rsx.Radian
set rotationAngle(value): void
Parameters
- value: rsx.Radian
Returns void

steerAngle

get steerAngle(): rsx.Radian
Get the steering angle of the wheel.

Returns rsx.Radian
The current steering angle of the wheel.

suspensionLength

get suspensionLength(): number
Get the suspension length of the wheel.

Returns number
The suspension length of the wheel.

transform

get transform(): Immutable<Transform>
Get the transform of the wheel in local space of the vehicle.

Returns Immutable<Transform>
The transform of the wheel.

visualModel

get visualModel(): SceneObject
Returns the visual model scene object of this wheel.

Returns SceneObject

visualModelInitialLocalTransform

get visualModelInitialLocalTransform(): Immutable<Transform>
Returns the initial local transform of this wheel's visualModel, before the simulation changed it for the first time.

Returns Immutable<Transform>