@react-three/rapier 0.2.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @react-three/rapier
 
+## 0.4.0
+
+### Minor Changes
+
+- dd535aa: Update to @dimforge/rapier3d-compat@0.8.1, pinned version
+
+### Patch Changes
+
+- dd535aa: Better <Physics /> lifecycle making reinitialization more stable
+
+## 0.3.1
+
+### Patch Changes
+
+- 37d2621: Pin rapier3d version to 0.8.0-alpha.2
+
+## 0.3.0
+
+### Minor Changes
+
+- 7e36172: Add collision and sleep/awake events
+
 ## 0.2.0
 
 ### Minor Changes

package/dist/declarations/src/Physics.d.ts

@@ -1,7 +1,7 @@
 import React, { FC, ReactNode } from "react";
 import type Rapier from "@dimforge/rapier3d-compat";
 import { RigidBodyAutoCollider, Vector3Array, WorldApi } from "./types";
-import { ColliderHandle } from "@dimforge/rapier3d-compat";
+import { ColliderHandle, RigidBody, RigidBodyHandle, TempContactManifold } from "@dimforge/rapier3d-compat";
 import { Object3D } from "three";
 export interface RapierContext {
     rapier: typeof Rapier;
@@ -11,8 +11,21 @@ export interface RapierContext {
     physicsOptions: {
         colliders: RigidBodyAutoCollider;
     };
+    rigidBodyEvents: EventMap;
 }
 export declare const RapierContext: React.Context<RapierContext | undefined>;
+declare type EventMap = Map<ColliderHandle | RigidBodyHandle, {
+    onSleep?(): void;
+    onWake?(): void;
+    onCollisionEnter?({ target, manifold, flipped }: {
+        target: RigidBody;
+        manifold: TempContactManifold;
+        flipped: boolean;
+    }): void;
+    onCollisionExit?({ target }: {
+        target: RigidBody;
+    }): void;
+}>;
 interface RapierWorldProps {
     gravity?: Vector3Array;
     colliders?: RigidBodyAutoCollider;

package/dist/declarations/src/api.d.ts

@@ -8,6 +8,8 @@ export declare const createRigidBodyApi: (ref: RefGetter<RigidBody>) => {
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 };
 export declare const createColliderApi: (ref: RefGetter<Collider>) => {
     raw: () => Collider | undefined;
@@ -18,7 +20,7 @@ export declare const createWorldApi: (ref: RefGetter<World>) => {
     getCollider: (handle: number) => Collider;
     getRigidBody: (handle: number) => RigidBody;
     createRigidBody: (desc: RigidBodyDesc) => RigidBody;
-    createCollider: (desc: ColliderDesc, rigidBodyHandle: number) => Collider;
+    createCollider: (desc: ColliderDesc, rigidBody: RigidBody) => Collider;
     removeRigidBody: (rigidBody: RigidBody) => void;
     removeCollider: (collider: Collider) => void;
     createImpulseJoint: (params: JointData, rigidBodyA: RigidBody, rigidBodyB: RigidBody) => ImpulseJoint;

package/dist/declarations/src/components.d.ts

@@ -1,10 +1,9 @@
 import React from "react";
 import { ReactNode } from "react";
 import { Vector3 } from "three";
-import { BallArgs, CapsuleArgs, ConeArgs, ConvexHullArgs, CuboidArgs, CylinderArgs, HeightfieldArgs, RigidBodyAutoCollider, RoundCuboidArgs, TrimeshArgs, UseColliderOptions, UseRigidBodyOptions } from "./types";
+import { BallArgs, CapsuleArgs, ConeArgs, ConvexHullArgs, CuboidArgs, CylinderArgs, HeightfieldArgs, RoundCuboidArgs, TrimeshArgs, UseColliderOptions, UseRigidBodyOptions } from "./types";
 interface RigidBodyProps extends UseRigidBodyOptions {
     children?: ReactNode;
-    colliders?: RigidBodyAutoCollider | false;
 }
 export declare const RigidBody: React.ForwardRefExoticComponent<RigidBodyProps & React.RefAttributes<{
     raw: () => import("@dimforge/rapier3d-compat/dynamics/rigid_body").RigidBody | undefined;
@@ -13,6 +12,8 @@ export declare const RigidBody: React.ForwardRefExoticComponent<RigidBodyProps &
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): import("three").Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }>>;
 declare type UseColliderOptionsRequiredArgs<T> = Omit<UseColliderOptions<T>, "args"> & {
     args: T;

package/dist/declarations/src/hooks.d.ts

@@ -12,6 +12,8 @@ export declare const useRigidBody: <O extends Object3D<import("three").Event>>(o
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useCollider: <A>(body: RigidBodyApi, options?: UseColliderOptions<A>) => (React.MutableRefObject<Object3D<import("three").Event> | undefined> | {
     raw: () => Rapier.Collider | undefined;
@@ -24,6 +26,8 @@ export declare const useRigidBodyWithCollider: <A, O extends Object3D<import("th
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useCuboid: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<CuboidArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -32,6 +36,8 @@ export declare const useCuboid: <T extends Object3D<import("three").Event>>(rigi
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useBall: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<BallArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -40,6 +46,8 @@ export declare const useBall: <T extends Object3D<import("three").Event>>(rigidB
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useCapsule: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<CapsuleArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -48,6 +56,8 @@ export declare const useCapsule: <T extends Object3D<import("three").Event>>(rig
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useHeightfield: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<HeightfieldArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -56,6 +66,8 @@ export declare const useHeightfield: <T extends Object3D<import("three").Event>>
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 /**
  * Create a trimesh collider and rigid body.
@@ -71,6 +83,8 @@ export declare const useTrimesh: {
         applyTorqueImpulse({ x, y, z }: Vector3): void;
         translation(): Vector3;
         rotation(): Quaternion;
+        setNextKinematicRotation({ x, y, z }: Vector3): void;
+        setNextKinematicTranslation({ x, y, z }: Vector3): void;
     }];
     fromMesh<T_1 extends Object3D<import("three").Event>>(mesh: Mesh, rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<TrimeshArgs>): [ref: React.MutableRefObject<T_1>, rigidBody: {
         raw: () => Rapier.RigidBody | undefined;
@@ -79,6 +93,8 @@ export declare const useTrimesh: {
         applyTorqueImpulse({ x, y, z }: Vector3): void;
         translation(): Vector3;
         rotation(): Quaternion;
+        setNextKinematicRotation({ x, y, z }: Vector3): void;
+        setNextKinematicTranslation({ x, y, z }: Vector3): void;
     }];
 };
 export declare const usePolyline: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<PolylineArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
@@ -88,6 +104,8 @@ export declare const usePolyline: <T extends Object3D<import("three").Event>>(ri
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useRoundCuboid: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<RoundCuboidArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -96,6 +114,8 @@ export declare const useRoundCuboid: <T extends Object3D<import("three").Event>>
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useCylinder: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<CylinderArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -104,6 +124,8 @@ export declare const useCylinder: <T extends Object3D<import("three").Event>>(ri
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useRoundCylinder: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<RoundCylinderArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -112,6 +134,8 @@ export declare const useRoundCylinder: <T extends Object3D<import("three").Event
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useCone: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<ConeArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -120,6 +144,8 @@ export declare const useCone: <T extends Object3D<import("three").Event>>(rigidB
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useRoundCone: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<RoundCone>) => [ref: React.MutableRefObject<T>, rigidBody: {
     raw: () => Rapier.RigidBody | undefined;
@@ -128,6 +154,8 @@ export declare const useRoundCone: <T extends Object3D<import("three").Event>>(r
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useConvexHull: {
     <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<ConvexHullArgs>): [ref: React.MutableRefObject<T>, rigidBody: {
@@ -137,6 +165,8 @@ export declare const useConvexHull: {
         applyTorqueImpulse({ x, y, z }: Vector3): void;
         translation(): Vector3;
         rotation(): Quaternion;
+        setNextKinematicRotation({ x, y, z }: Vector3): void;
+        setNextKinematicTranslation({ x, y, z }: Vector3): void;
     }];
     fromMesh<T_1 extends Object3D<import("three").Event>>(mesh: Mesh, rigidBodyOptions?: UseBodyOptions, colliderOptions?: Omit<UseColliderOptions<ConvexHullArgs>, "colliderArgs">): [ref: React.MutableRefObject<T_1>, rigidBody: {
         raw: () => Rapier.RigidBody | undefined;
@@ -145,6 +175,8 @@ export declare const useConvexHull: {
         applyTorqueImpulse({ x, y, z }: Vector3): void;
         translation(): Vector3;
         rotation(): Quaternion;
+        setNextKinematicRotation({ x, y, z }: Vector3): void;
+        setNextKinematicTranslation({ x, y, z }: Vector3): void;
     }];
 };
 export declare const useRoundConvexHull: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<RoundConvexHullArgs>) => [ref: React.MutableRefObject<T>, rigidBody: {
@@ -154,6 +186,8 @@ export declare const useRoundConvexHull: <T extends Object3D<import("three").Eve
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useConvexMesh: {
     <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<ConvexMeshArgs>): [ref: React.MutableRefObject<Object3D<import("three").Event>>, rigidBody: {
@@ -163,6 +197,8 @@ export declare const useConvexMesh: {
         applyTorqueImpulse({ x, y, z }: Vector3): void;
         translation(): Vector3;
         rotation(): Quaternion;
+        setNextKinematicRotation({ x, y, z }: Vector3): void;
+        setNextKinematicTranslation({ x, y, z }: Vector3): void;
     }];
     fromMesh<T_1 extends Object3D<import("three").Event>>(mesh: Mesh, rigidBodyOptions?: UseBodyOptions, colliderOptions?: Omit<UseColliderOptions<ConvexMeshArgs>, "colliderArgs">): [ref: React.MutableRefObject<Object3D<import("three").Event>>, rigidBody: {
         raw: () => Rapier.RigidBody | undefined;
@@ -171,6 +207,8 @@ export declare const useConvexMesh: {
         applyTorqueImpulse({ x, y, z }: Vector3): void;
         translation(): Vector3;
         rotation(): Quaternion;
+        setNextKinematicRotation({ x, y, z }: Vector3): void;
+        setNextKinematicTranslation({ x, y, z }: Vector3): void;
     }];
 };
 export declare const useRoundConvexMesh: <T extends Object3D<import("three").Event>>(rigidBodyOptions?: UseBodyOptions, colliderOptions?: UseColliderOptions<RoundConvexMeshArgs>) => [ref: React.MutableRefObject<Object3D<import("three").Event>>, rigidBody: {
@@ -180,6 +218,8 @@ export declare const useRoundConvexMesh: <T extends Object3D<import("three").Eve
     applyTorqueImpulse({ x, y, z }: Vector3): void;
     translation(): Vector3;
     rotation(): Quaternion;
+    setNextKinematicRotation({ x, y, z }: Vector3): void;
+    setNextKinematicTranslation({ x, y, z }: Vector3): void;
 }];
 export declare const useImpulseJoint: <T extends Rapier.ImpulseJoint>(body1: MutableRefObject<RapierRigidBody | undefined | null> | RigidBodyApi, body2: MutableRefObject<RapierRigidBody | undefined | null> | RigidBodyApi, params: Rapier.JointData) => {
     raw: () => Rapier.ImpulseJoint | undefined;

package/dist/declarations/src/types.d.ts

@@ -1,5 +1,5 @@
 import { MutableRefObject } from "react";
-import { CoefficientCombineRule, RigidBody as RapierRigidBody, Collider as RapierCollider } from "@dimforge/rapier3d-compat";
+import { CoefficientCombineRule, RigidBody as RapierRigidBody, Collider as RapierCollider, TempContactManifold } from "@dimforge/rapier3d-compat";
 import { createColliderApi, createJointApi, createRigidBodyApi, createWorldApi } from "./api";
 export { RapierRigidBody, RapierCollider };
 export { CoefficientCombineRule as CoefficientCombineRule, } from "@dimforge/rapier3d-compat";
@@ -162,6 +162,22 @@ export interface UseRigidBodyOptions {
      * Setting this to false will disable automatic colliders.
      */
     colliders?: RigidBodyAutoCollider | false;
+    /**
+     * Callback when this rigidbody collides with another rigidbody
+     */
+    onCollisionEnter?({}: {
+        target: RapierRigidBody;
+        manifold: TempContactManifold;
+        flipped: boolean;
+    }): void;
+    /**
+     * Callback when this rigidbody stops colliding with another rigidbody
+     */
+    onCollisionExit?({}: {
+        target: RapierRigidBody;
+    }): void;
+    onSleep?(): void;
+    onWake?(): void;
 }
 export declare type SphericalJointParams = [
     body1Anchor: Vector3Array,

package/dist/declarations/src/utils.d.ts

@@ -1,6 +1,6 @@
-import { Collider } from "@dimforge/rapier3d-compat";
+import { Collider, RigidBody } from "@dimforge/rapier3d-compat";
 import { Object3D, Vector3 } from "three";
-import { RapierRigidBody, RigidBodyAutoCollider, RigidBodyShape, RigidBodyTypeString, UseColliderOptions, Vector3Array, WorldApi } from "./types";
+import { RigidBodyAutoCollider, RigidBodyShape, RigidBodyTypeString, UseColliderOptions, Vector3Array, WorldApi } from "./types";
 export declare const vectorArrayToObject: (arr: Vector3Array) => {
     x: number;
     y: number;
@@ -8,10 +8,10 @@ export declare const vectorArrayToObject: (arr: Vector3Array) => {
 };
 export declare const rigidBodyTypeFromString: (type: RigidBodyTypeString) => number;
 export declare const scaleColliderArgs: (shape: RigidBodyShape, args: (number | ArrayLike<number>)[], scale: Vector3) => (number | ArrayLike<number>)[];
-export declare const createColliderFromOptions: <A>(options: UseColliderOptions<A>, world: WorldApi, rigidBodyHandle: number, scale?: {
+export declare const createColliderFromOptions: <A>(options: UseColliderOptions<A>, world: WorldApi, rigidBody: RigidBody, scale?: {
     x: number;
     y: number;
     z: number;
-}) => Collider;
-export declare const createCollidersFromChildren: (object: Object3D, rigidBody: RapierRigidBody, type: RigidBodyAutoCollider, world: WorldApi) => Collider[];
+}, hasCollisionEvents?: boolean) => Collider;
+export declare const createCollidersFromChildren: (object: Object3D, rigidBody: RigidBody, type: RigidBodyAutoCollider, world: WorldApi, hasCollisionEvents?: boolean) => Collider[];
 export declare const scaleVertices: (vertices: ArrayLike<number>, scale: Vector3) => number[];