Class WheelInfo

WheelInfo

Constructors

  • Parameters

    • Optional options: {
          axleLocal?: Vec3;
          axleWorld?: Vec3;
          chassisConnectionPointLocal?: Vec3;
          chassisConnectionPointWorld?: Vec3;
          clippedInvContactDotSuspension?: number;
          customSlidingRotationalSpeed?: number;
          dampingCompression?: number;
          dampingRelaxation?: number;
          deltaRotation?: number;
          directionLocal?: Vec3;
          directionWorld?: Vec3;
          forwardAcceleration?: number;
          frictionSlip?: number;
          isFrontWheel?: boolean;
          maxSuspensionForce?: number;
          maxSuspensionTravel?: number;
          radius?: number;
          rollInfluence?: number;
          rotation?: number;
          sideAcceleration?: number;
          skidInfo?: number;
          slipInfo?: number;
          steering?: number;
          suspensionForce?: number;
          suspensionLength?: number;
          suspensionMaxLength?: number;
          suspensionRelativeVelocity?: number;
          suspensionRestLength?: number;
          suspensionStiffness?: number;
          useCustomSlidingRotationalSpeed?: boolean;
      }
      • Optional axleLocal?: Vec3

        axleLocal

      • Optional axleWorld?: Vec3

        axleWorld

      • Optional chassisConnectionPointLocal?: Vec3

        Connection point, defined locally in the chassis body frame.

      • Optional chassisConnectionPointWorld?: Vec3

        chassisConnectionPointWorld

      • Optional clippedInvContactDotSuspension?: number

        clippedInvContactDotSuspension

        Default

        1
        
      • Optional customSlidingRotationalSpeed?: number

        Speed to apply to the wheel rotation when the wheel is sliding.

        Default

        -0.1
        
      • Optional dampingCompression?: number

        dampingCompression

        Default

        10
        
      • Optional dampingRelaxation?: number

        dampingRelaxation

        Default

        10
        
      • Optional deltaRotation?: number

        deltaRotation

        Default

        0
        
      • Optional directionLocal?: Vec3

        directionLocal

      • Optional directionWorld?: Vec3

        directionWorld

      • Optional forwardAcceleration?: number

        forwardAcceleration

      • Optional frictionSlip?: number

        frictionSlip

        Default

        10.5
        
      • Optional isFrontWheel?: boolean

        isFrontWheel

        Default

        true
        
      • Optional maxSuspensionForce?: number

        maxSuspensionForce

      • Optional maxSuspensionTravel?: number

        Max travel distance of the suspension, in meters.

        Default

        1
        
      • Optional radius?: number

        radius

        Default

        1
        
      • Optional rollInfluence?: number

        rollInfluence

        Default

        0.01
        
      • Optional rotation?: number

        Rotation value, in radians.

        Default

        0
        
      • Optional sideAcceleration?: number

        sideAcceleration

      • Optional skidInfo?: number

        skidInfo

        Default

        0
        
      • Optional slipInfo?: number

        slipInfo

      • Optional steering?: number

        steering

        Default

        0
        
      • Optional suspensionForce?: number

        suspensionForce

        Default

        0
        
      • Optional suspensionLength?: number

        suspensionLength

        Default

        0
        
      • Optional suspensionMaxLength?: number

        suspensionMaxLength

        Default

        2
        
      • Optional suspensionRelativeVelocity?: number

        suspensionRelativeVelocity

        Default

        0
        
      • Optional suspensionRestLength?: number

        suspensionRestLength

        Default

        1
        
      • Optional suspensionStiffness?: number

        suspensionStiffness

        Default

        100
        
      • Optional useCustomSlidingRotationalSpeed?: boolean

        If the customSlidingRotationalSpeed should be used.

        Default

        false
        

    Returns WheelInfo

Properties

axleLocal: Vec3

axleLocal

axleWorld: Vec3

axleWorld

brake: number

brake

chassisConnectionPointLocal: Vec3

Connection point, defined locally in the chassis body frame.

chassisConnectionPointWorld: Vec3

chassisConnectionPointWorld

clippedInvContactDotSuspension: number

clippedInvContactDotSuspension

Default

1
customSlidingRotationalSpeed: number

Speed to apply to the wheel rotation when the wheel is sliding.

Default

-0.1
dampingCompression: number

dampingCompression

Default

10
dampingRelaxation: number

dampingRelaxation

Default

10
deltaRotation: number

deltaRotation

Default

0
directionLocal: Vec3

directionLocal

directionWorld: Vec3

directionWorld

engineForce: number

engineForce

forwardAcceleration: number

forwardAcceleration

forwardImpulse: number

forwardImpulse

frictionSlip: number

frictionSlip

Default

10.5
isFrontWheel: boolean

isFrontWheel

Default

true
isInContact: boolean

isInContact

maxSuspensionForce: number

maxSuspensionForce

maxSuspensionTravel: number

Max travel distance of the suspension, in meters.

Default

1
radius: number

radius

Default

1
raycastResult: WheelRaycastResult

The result from raycasting.

rollInfluence: number

rollInfluence

Default

0.01
rotation: number

Rotation value, in radians.

Default

0
sideAcceleration: number

sideAcceleration

sideImpulse: number

sideImpulse

skidInfo: number

skidInfo

Default

0
sliding: boolean

sliding

slipInfo: number

slipInfo

steering: number

steering

Default

0
suspensionForce: number

suspensionForce

Default

0
suspensionLength: number

suspensionLength

Default

0
suspensionMaxLength: number

suspensionMaxLength

Default

2
suspensionRelativeVelocity: number

suspensionRelativeVelocity

Default

0
suspensionRestLength: number

suspensionRestLength

Default

1
suspensionStiffness: number

suspensionStiffness

Default

100
useCustomSlidingRotationalSpeed: boolean

If the customSlidingRotationalSpeed should be used.

Default

false
worldTransform: Transform

Wheel world transform.

Methods

  • Parameters

    Returns void