Class VehicleWheelCollision

Struct containing data about the collision of a vehicle wheel with the ground.

Index

Constructors

Properties

_collider _collisionPoint _lateralDirection _longitudinalDirection _normal _velocity

Accessors

collider collisionPoint lateralDirection longitudinalDirection normal velocity

Methods

assign clone isEqual isEqual

Constructors

constructor

new VehicleWheelCollision(
    collider?: Collider,
    collisionPoint?: Immutable<Vector3>,
    velocity?: Immutable<Vector3>,
    normal?: Immutable<Vector3>,
    longitudinalDirection?: Immutable<Vector3>,
    lateralDirection?: Immutable<Vector3>,
): VehicleWheelCollision
Parameters
- Optionalcollider: Collider
- OptionalcollisionPoint: Immutable<Vector3>
- Optionalvelocity: Immutable<Vector3>
- Optionalnormal: Immutable<Vector3>
- OptionallongitudinalDirection: Immutable<Vector3>
- OptionallateralDirection: Immutable<Vector3>
Returns VehicleWheelCollision

Properties

`Protected`_collider

_collider: Collider

`Protected`_collisionPoint

_collisionPoint: Vector3

`Protected`_lateralDirection

_lateralDirection: Vector3

`Protected`_longitudinalDirection

_longitudinalDirection: Vector3

`Protected`_normal

_normal: Vector3

`Protected`_velocity

_velocity: Vector3

Accessors

collider

get collider(): Collider

Collider the wheel collided with.

Returns Collider
set collider(value: Collider): void
Parameters
- value: Collider
Returns void

collisionPoint

get collisionPoint(): Vector3

World space point of the collision.

Returns Vector3
set collisionPoint(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

lateralDirection

get lateralDirection(): Vector3

Sideways direction of the wheel along the ground.

Returns Vector3
set lateralDirection(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

longitudinalDirection

get longitudinalDirection(): Vector3

Forward direction of the wheel along the ground.

Returns Vector3
set longitudinalDirection(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

normal

get normal(): Vector3

Collision normal in world space.

Returns Vector3
set normal(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

velocity

get velocity(): Vector3

Velocity of the wheel at the collision point in world space. Does not take into account the wheel rotation speed.

Returns Vector3
set velocity(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

Methods

assign

assign(other: Immutable<VehicleWheelCollision>): VehicleWheelCollision
Copies all properties defined by the prototype of VehicleWheelCollision from other to this instance.
Parameters
- other: Immutable<VehicleWheelCollision>
Returns VehicleWheelCollision

clone

clone(): VehicleWheelCollision

Clones this instance and returns a new VehicleWheelCollision with identical values.

Returns VehicleWheelCollision

isEqual

isEqual(
this: Immutable<VehicleWheelCollision>,
other: Immutable<VehicleWheelCollision>,
): boolean
Determines if this VehicleWheelCollision instance is equal to the other instance.
Parameters
- this: Immutable<VehicleWheelCollision>
- other: Immutable<VehicleWheelCollision>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<VehicleWheelCollision>,
rhs: Immutable<VehicleWheelCollision>,
): boolean
Determines if both VehicleWheelCollision instances are equal.
Parameters
- lhs: Immutable<VehicleWheelCollision>
- rhs: Immutable<VehicleWheelCollision>
Returns boolean