Class RapierPhysics

constructor

• new RapierPhysics(ctx: Context): RapierPhysics

  Parameters

  • ctx: Context

  Returns RapierPhysics

debugRenderColliders

debugRenderRaycasts

gravity

• get gravity(): Vec3

  Returns Vec3

• set gravity(value: Vec3): void

  Parameters

  • value: Vec3

  Returns void

isInitialized

• get isInitialized(): boolean

  Returns boolean

isUpdating

• get isUpdating(): boolean

  Returns boolean

world

• get world(): undefined | World

  Get access to the rapier world

  Returns undefined | World

addBoxCollider

• addBoxCollider(collider: ICollider, size: Vector3): Promise<void>

  Parameters

  • collider: ICollider
  • size: Vector3

  Returns Promise<void>

addCapsuleCollider

• addCapsuleCollider(
      collider: ICollider,
      height: number,
      radius: number,
  ): Promise<void>

  Parameters

  • collider: ICollider
  • height: number
  • radius: number

  Returns Promise<void>

addFixedJoint

• addFixedJoint(body1: IRigidbody, body2: IRigidbody): void

  Parameters

  • body1: IRigidbody
  • body2: IRigidbody

  Returns void

addForce

• addForce(rigidbody: IRigidbody, force: Vec3, wakeup: boolean): void

  Parameters

  • rigidbody: IRigidbody
  • force: Vec3
  • wakeup: boolean

  Returns void

addHingeJoint

• addHingeJoint(
      body1: IRigidbody,
      body2: IRigidbody,
      anchor: { x: number; y: number; z: number },
      axis: { x: number; y: number; z: number },
  ): void

  The joint prevents any relative movement between two rigid-bodies, except for relative rotations along one axis. This is typically used to simulate wheels, fans, etc. They are characterized by one local anchor as well as one local axis on each rigid-body.

  Parameters

  • body1: IRigidbody
  • body2: IRigidbody
  • anchor: { x: number; y: number; z: number }
  • axis: { x: number; y: number; z: number }

  Returns void

addImpulse

• addImpulse(rigidbody: IRigidbody, force: Vec3, wakeup: boolean): void

  Parameters

  • rigidbody: IRigidbody
  • force: Vec3
  • wakeup: boolean

  Returns void

addMeshCollider

• addMeshCollider(
      collider: ICollider,
      mesh: Mesh,
      convex: boolean,
      extraScale?: Vector3,
  ): Promise<void>

  Parameters

  • collider: ICollider
  • mesh: Mesh
  • convex: boolean
  • OptionalextraScale: Vector3

  Returns Promise<void>

addSphereCollider

• addSphereCollider(collider: ICollider): Promise<void>

  Parameters

  • collider: ICollider

  Returns Promise<void>

applyImpulse

• applyImpulse(rb: IRigidbody, vec: Vec3, wakeup: boolean): void

  Parameters

  • rb: IRigidbody
  • vec: Vec3
  • wakeup: boolean

  Returns void

clearCaches

• clearCaches(): void

  clear all possibly cached data (e.g. mesh data when creating scaled mesh colliders)

  Returns void

getAngularVelocity

• getAngularVelocity(rb: IRigidbody): null | Vec3

  Parameters

  • rb: IRigidbody

  Returns null | Vec3

getBody

• getBody(obj: ICollider | IRigidbody): any

  Get the rapier body for a Needle component

  Parameters

  • obj: ICollider | IRigidbody

  Returns any

getComponent

• getComponent(rapierObject: object): null | IComponent

  Get the Needle Engine component for a rapier object

  Parameters

  • rapierObject: object

  Returns null | IComponent

getLinearVelocity

• getLinearVelocity(comp: ICollider | IRigidbody): null | Vec3

  Returns the linear velocity of a rigidbody or the rigidbody of a collider

  Parameters

  • comp: ICollider | IRigidbody

  Returns null | Vec3

initialize

• initialize(): Promise<boolean>

  Returns Promise<boolean>

isSleeping

• isSleeping(rb: IRigidbody): undefined | boolean

  Parameters

  • rb: IRigidbody

  Returns undefined | boolean

postStep

• postStep(): void

  Returns void

raycast

• raycast(
      origin?: Vec3 | Vec2,
      direction?: Vec3,
      options?: {
          filterGroups?: number;
          filterPredicate?: (c: ICollider) => boolean;
          maxDistance?: number;
          queryFilterFlags?: QueryFilterFlags;
          solid?: boolean;
          useIgnoreRaycastLayer?: boolean;
      },
  ): null
  | { collider: ICollider; point: Vector3 }

  Fast raycast against physics colliders

  Parameters

  • Optionalorigin: Vec3 | Vec2

    ray origin in screen or worldspace
  • Optionaldirection: Vec3

    ray direction in worldspace
  • Optionaloptions: {
        filterGroups?: number;
        filterPredicate?: (c: ICollider) => boolean;
        maxDistance?: number;
        queryFilterFlags?: QueryFilterFlags;
        solid?: boolean;
        useIgnoreRaycastLayer?: boolean;
    }

    additional options

    • OptionalfilterGroups?: number

    • OptionalfilterPredicate?: (c: ICollider) => boolean

      Return false to ignore this collider

    • OptionalmaxDistance?: number

    • OptionalqueryFilterFlags?: QueryFilterFlags

    • Optionalsolid?: boolean

      True if you want to also hit objects when the raycast starts from inside a collider

    • OptionaluseIgnoreRaycastLayer?: boolean

      When enabled the hit object's layer will be tested. If layer 2 is enabled the object will be ignored (Layer 2 == IgnoreRaycast) If not set the raycast will ignore objects in the IgnoreRaycast layer (default: true)

      Default

      undefined
      Copy

  Returns null | { collider: ICollider; point: Vector3 }

raycastAndGetNormal

• raycastAndGetNormal(
      origin?: Vec3 | Vec2,
      direction?: Vec3,
      options?: {
          filterGroups?: number;
          filterPredicate?: (c: ICollider) => boolean;
          maxDistance?: number;
          queryFilterFlags?: QueryFilterFlags;
          solid?: boolean;
          useIgnoreRaycastLayer?: boolean;
      },
  ): null
  | { collider: ICollider; normal: Vector3; point: Vector3 }

  raycast that also gets the normal vector. If you don't need it use raycast()

  Parameters

  • Optionalorigin: Vec3 | Vec2
  • Optionaldirection: Vec3
  • Optionaloptions: {
        filterGroups?: number;
        filterPredicate?: (c: ICollider) => boolean;
        maxDistance?: number;
        queryFilterFlags?: QueryFilterFlags;
        solid?: boolean;
        useIgnoreRaycastLayer?: boolean;
    }

    • OptionalfilterGroups?: number

    • OptionalfilterPredicate?: (c: ICollider) => boolean

      Return false to ignore this collider

    • OptionalmaxDistance?: number

    • OptionalqueryFilterFlags?: QueryFilterFlags

    • Optionalsolid?: boolean

      True if you want to also hit objects when the raycast starts from inside a collider

    • OptionaluseIgnoreRaycastLayer?: boolean

      When enabled the hit object's layer will be tested. If layer 2 is enabled the object will be ignored (Layer 2 == IgnoreRaycast) If not set the raycast will ignore objects in the IgnoreRaycast layer (default: true)

      Default

      undefined
      Copy

  Returns null | { collider: ICollider; normal: Vector3; point: Vector3 }

removeBody

• removeBody(obj: IComponent): void

  Parameters

  • obj: IComponent

  Returns void

resetForces

• resetForces(rb: IRigidbody, wakeup: boolean): void

  Parameters

  • rb: IRigidbody
  • wakeup: boolean

  Returns void

resetTorques

• resetTorques(rb: IRigidbody, wakeup: boolean): void

  Parameters

  • rb: IRigidbody
  • wakeup: boolean

  Returns void

setAngularVelocity

• setAngularVelocity(rb: IRigidbody, vec: Vec3, wakeup: boolean): void

  Parameters

  • rb: IRigidbody
  • vec: Vec3
  • wakeup: boolean

  Returns void

setLinearVelocity

• setLinearVelocity(rb: IRigidbody, vec: Vec3, wakeup: boolean): void

  Parameters

  • rb: IRigidbody
  • vec: Vec3
  • wakeup: boolean

  Returns void

sphereOverlap

• sphereOverlap(point: Vector3, radius: number): SphereOverlapResult[]

  Precice sphere overlap detection using rapier against colliders

  Parameters

  • point: Vector3

    center of the sphere in worldspace
  • radius: number

    radius of the sphere

  Returns SphereOverlapResult[]

  array of colliders that overlap with the sphere. Note: they currently only contain the collider and the gameobject

step

• step(dt?: number): void

  Parameters

  • Optionaldt: number

  Returns void

updateBody

• updateBody(
      comp: ICollider | IRigidbody,
      translation: boolean,
      rotation: boolean,
  ): void

  Parameters

  • comp: ICollider | IRigidbody
  • translation: boolean
  • rotation: boolean

  Returns void

updatePhysicsMaterial

• updatePhysicsMaterial(col: ICollider): void

  Parameters

  • col: ICollider

  Returns void

updateProperties

• updateProperties(obj: ICollider | IRigidbody): void

  Parameters

  • obj: ICollider | IRigidbody

  Returns void

wakeup

• wakeup(rb: IRigidbody): void

  Parameters

  • rb: IRigidbody

  Returns void