@react-three/rapier 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @react-three/rapier
 
+## 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/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;

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

@@ -12,6 +12,6 @@ export declare const createColliderFromOptions: <A>(options: UseColliderOptions<
     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: RapierRigidBody, type: RigidBodyAutoCollider, world: WorldApi, hasCollisionEvents?: boolean) => Collider[];
 export declare const scaleVertices: (vertices: ArrayLike<number>, scale: Vector3) => number[];

package/dist/react-three-rapier.cjs.dev.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var React = require('react');
 var useAsset = require('use-asset');
 var fiber = require('@react-three/fiber');
-var three = require('three');
 var rapier3dCompat = require('@dimforge/rapier3d-compat');
+var three = require('three');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -67,7 +67,7 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
   x: 1,
   y: 1,
   z: 1
-}) => {
+}, hasCollisionEvents = false) => {
   var _options$shape, _options$args, _options$restitution, _options$restitutionC, _options$friction, _options$frictionComb;
 
   const mass = (options === null || options === void 0 ? void 0 : options.mass) || 1;
@@ -85,7 +85,12 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
     y: ry,
     z: rz,
     w: 1
-  }).setRestitution((_options$restitution = options === null || options === void 0 ? void 0 : options.restitution) !== null && _options$restitution !== void 0 ? _options$restitution : 0).setRestitutionCombineRule((_options$restitutionC = options === null || options === void 0 ? void 0 : options.restitutionCombineRule) !== null && _options$restitutionC !== void 0 ? _options$restitutionC : rapier3dCompat.CoefficientCombineRule.Average).setFriction((_options$friction = options === null || options === void 0 ? void 0 : options.friction) !== null && _options$friction !== void 0 ? _options$friction : 0.7).setFrictionCombineRule((_options$frictionComb = options === null || options === void 0 ? void 0 : options.frictionCombineRule) !== null && _options$frictionComb !== void 0 ? _options$frictionComb : rapier3dCompat.CoefficientCombineRule.Average); // If any of the mass properties are specified, add mass properties
+  }).setRestitution((_options$restitution = options === null || options === void 0 ? void 0 : options.restitution) !== null && _options$restitution !== void 0 ? _options$restitution : 0).setRestitutionCombineRule((_options$restitutionC = options === null || options === void 0 ? void 0 : options.restitutionCombineRule) !== null && _options$restitutionC !== void 0 ? _options$restitutionC : rapier3dCompat.CoefficientCombineRule.Average).setFriction((_options$friction = options === null || options === void 0 ? void 0 : options.friction) !== null && _options$friction !== void 0 ? _options$friction : 0.7).setFrictionCombineRule((_options$frictionComb = options === null || options === void 0 ? void 0 : options.frictionCombineRule) !== null && _options$frictionComb !== void 0 ? _options$frictionComb : rapier3dCompat.CoefficientCombineRule.Average);
+
+  if (hasCollisionEvents) {
+    colliderDesc = colliderDesc.setActiveEvents(rapier3dCompat.ActiveEvents.COLLISION_EVENTS);
+  } // If any of the mass properties are specified, add mass properties
+
 
   if (options !== null && options !== void 0 && options.mass || options !== null && options !== void 0 && options.centerOfMass || options !== null && options !== void 0 && options.principalAngularInertia) {
     colliderDesc.setDensity(0);
@@ -108,7 +113,7 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
   const collider = world.createCollider(colliderDesc, rigidBodyHandle);
   return collider;
 };
-const createCollidersFromChildren = (object, rigidBody, type, world) => {
+const createCollidersFromChildren = (object, rigidBody, type, world, hasCollisionEvents = false) => {
   const colliders = [];
   let desc;
   let offset = new three.Vector3();
@@ -181,6 +186,11 @@ const createCollidersFromChildren = (object, rigidBody, type, world) => {
         z: rz,
         w: rw
       });
+
+      if (hasCollisionEvents) {
+        desc.setActiveEvents(rapier3dCompat.ActiveEvents.COLLISION_EVENTS);
+      }
+
       const collider = world.createCollider(desc, rigidBody.handle);
       colliders.push(collider);
     }
@@ -316,7 +326,9 @@ const Physics = ({
     return worldRef.current;
   });
   const [colliderMeshes] = React.useState(() => new Map());
-  const [rigidBodyMeshes] = React.useState(() => new Map()); // Init world
+  const [rigidBodyMeshes] = React.useState(() => new Map());
+  const [rigidBodyEvents] = React.useState(() => new Map());
+  const [eventQueue] = React.useState(() => new rapier3dCompat.EventQueue(false)); // Init world
 
   React.useLayoutEffect(() => {
     const world = getWorldRef.current();
@@ -336,10 +348,27 @@ const Physics = ({
     const now = performance.now();
     const delta = Math.min(100, now - time.current);
     world.timestep = delta / 1000;
-    world.step(); // Update meshes
+    world.step(eventQueue); // Update meshes
 
     rigidBodyMeshes.forEach((mesh, handle) => {
       const rigidBody = world.getRigidBody(handle);
+      const events = rigidBodyEvents.get(handle);
+
+      if (events !== null && events !== void 0 && events.onSleep || events !== null && events !== void 0 && events.onWake) {
+        if (rigidBody.isSleeping() && !mesh.userData.isSleeping) {
+          var _events$onSleep;
+
+          events === null || events === void 0 ? void 0 : (_events$onSleep = events.onSleep) === null || _events$onSleep === void 0 ? void 0 : _events$onSleep.call(events);
+        }
+
+        if (!rigidBody.isSleeping() && mesh.userData.isSleeping) {
+          var _events$onWake;
+
+          events === null || events === void 0 ? void 0 : (_events$onWake = events.onWake) === null || _events$onWake === void 0 ? void 0 : _events$onWake.call(events);
+        }
+
+        mesh.userData.isSleeping = rigidBody.isSleeping();
+      }
 
       if (!rigidBody || rigidBody.isSleeping() || rigidBody.isFixed() || !mesh.parent) {
         return;
@@ -367,6 +396,48 @@ const Physics = ({
       o.updateMatrix();
       mesh.position.setFromMatrixPosition(o.matrix);
       mesh.rotation.setFromRotationMatrix(o.matrix);
+    }); // Collision events
+
+    eventQueue.drainCollisionEvents((handle1, handle2, started) => {
+      const collider1 = world.getCollider(handle1);
+      const collider2 = world.getCollider(handle2);
+      const rigidBodyHandle1 = collider1.parent();
+      const rigidBodyHandle2 = collider2.parent();
+
+      if (!collider1 || !collider2 || !rigidBodyHandle1 || !rigidBodyHandle2) {
+        return;
+      }
+
+      const rigidBody1 = world.getRigidBody(rigidBodyHandle1);
+      const rigidBody2 = world.getRigidBody(rigidBodyHandle2);
+      const events1 = rigidBodyEvents.get(rigidBodyHandle1);
+      const events2 = rigidBodyEvents.get(rigidBodyHandle2);
+
+      if (started) {
+        world.contactPair(handle1, handle2, (manifold, flipped) => {
+          var _events1$onCollisionE, _events2$onCollisionE;
+
+          events1 === null || events1 === void 0 ? void 0 : (_events1$onCollisionE = events1.onCollisionEnter) === null || _events1$onCollisionE === void 0 ? void 0 : _events1$onCollisionE.call(events1, {
+            target: rigidBody2,
+            manifold,
+            flipped
+          });
+          events2 === null || events2 === void 0 ? void 0 : (_events2$onCollisionE = events2.onCollisionEnter) === null || _events2$onCollisionE === void 0 ? void 0 : _events2$onCollisionE.call(events2, {
+            target: rigidBody1,
+            manifold,
+            flipped
+          });
+        });
+      } else {
+        var _events1$onCollisionE2, _events2$onCollisionE2;
+
+        events1 === null || events1 === void 0 ? void 0 : (_events1$onCollisionE2 = events1.onCollisionExit) === null || _events1$onCollisionE2 === void 0 ? void 0 : _events1$onCollisionE2.call(events1, {
+          target: rigidBody2
+        });
+        events2 === null || events2 === void 0 ? void 0 : (_events2$onCollisionE2 = events2.onCollisionExit) === null || _events2$onCollisionE2 === void 0 ? void 0 : _events2$onCollisionE2.call(events2, {
+          target: rigidBody1
+        });
+      }
     });
     time.current = now;
   });
@@ -379,7 +450,8 @@ const Physics = ({
       gravity: _gravity
     },
     colliderMeshes,
-    rigidBodyMeshes
+    rigidBodyMeshes,
+    rigidBodyEvents
   }), []);
   return /*#__PURE__*/React__default["default"].createElement(RapierContext.Provider, {
     value: context
@@ -435,7 +507,8 @@ const useRigidBody = (options = {}) => {
     rapier,
     world,
     rigidBodyMeshes,
-    physicsOptions
+    physicsOptions,
+    rigidBodyEvents
   } = useRapier();
   const ref = React.useRef(); // Create rigidbody
 
@@ -470,9 +543,11 @@ const useRigidBody = (options = {}) => {
 
     if (!ref.current) {
       ref.current = new three.Object3D();
-    } // Get intitial world transforms
+    } // isSleeping used for onSleep and onWake events
 
 
+    ref.current.userData.isSleeping = false; // Get intitial world transforms
+
     const worldPosition = ref.current.getWorldPosition(new three.Vector3());
     const worldRotation = ref.current.getWorldQuaternion(new three.Quaternion());
     const scale = ((_ref$current$parent = ref.current.parent) === null || _ref$current$parent === void 0 ? void 0 : _ref$current$parent.getWorldScale(new three.Vector3())) || {
@@ -500,7 +575,8 @@ const useRigidBody = (options = {}) => {
     rigidBody.resetForces(false);
     rigidBody.resetTorques(false);
     const colliderSetting = (_ref = (_options$colliders = options === null || options === void 0 ? void 0 : options.colliders) !== null && _options$colliders !== void 0 ? _options$colliders : physicsOptions.colliders) !== null && _ref !== void 0 ? _ref : false;
-    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, colliderSetting, world) : [];
+    const hasCollisionEvents = !!(options.onCollisionEnter || options.onCollisionExit);
+    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, colliderSetting, world, hasCollisionEvents) : [];
     rigidBody.wakeUp();
     rigidBodyMeshes.set(rigidBody.handle, ref.current);
     return () => {
@@ -509,7 +585,20 @@ const useRigidBody = (options = {}) => {
       rigidBodyRef.current = undefined;
       rigidBodyMeshes.delete(rigidBody.handle);
     };
-  }, []);
+  }, []); // Events
+
+  React.useEffect(() => {
+    const rigidBody = getRigidBodyRef.current();
+    rigidBodyEvents.set(rigidBody.handle, {
+      onCollisionEnter: options === null || options === void 0 ? void 0 : options.onCollisionEnter,
+      onCollisionExit: options === null || options === void 0 ? void 0 : options.onCollisionExit,
+      onSleep: options === null || options === void 0 ? void 0 : options.onSleep,
+      onWake: options === null || options === void 0 ? void 0 : options.onWake
+    });
+    return () => {
+      rigidBodyEvents.delete(rigidBody.handle);
+    };
+  }, [options.onCollisionEnter, options.onCollisionExit]);
   const api = React.useMemo(() => createRigidBodyApi(getRigidBodyRef), []);
   return [ref, api];
 };
@@ -823,7 +912,7 @@ const _excluded = ["children"],
       _excluded2 = ["children"];
 const RigidBodyContext = /*#__PURE__*/React.createContext(undefined);
 
-const useParentRigidBody = () => React.useContext(RigidBodyContext); // RigidBody
+const useRigidBodyContext = () => React.useContext(RigidBodyContext); // RigidBody
 
 
 const RigidBody = /*#__PURE__*/React.forwardRef((_ref, ref) => {
@@ -835,7 +924,7 @@ const RigidBody = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   const [object, rigidBody] = useRigidBody(props);
   React.useImperativeHandle(ref, () => rigidBody);
   return /*#__PURE__*/React__default["default"].createElement(RigidBodyContext.Provider, {
-    value: [object, rigidBody]
+    value: [object, rigidBody, !!(props.onCollisionEnter || props.onCollisionExit)]
   }, /*#__PURE__*/React__default["default"].createElement("object3D", {
     ref: object
   }, children));
@@ -850,11 +939,11 @@ const AnyCollider = _ref2 => {
   const {
     world
   } = useRapier();
-  const [, rigidBody] = useParentRigidBody();
+  const [, rigidBody, hasCollisionEvents] = useRigidBodyContext();
   const ref = React.useRef(null);
   React.useEffect(() => {
     const scale = ref.current.getWorldScale(new three.Vector3());
-    const collider = createColliderFromOptions(props, world, rigidBody.handle, scale);
+    const collider = createColliderFromOptions(props, world, rigidBody.handle, scale, hasCollisionEvents);
     return () => {
       world.removeCollider(collider);
     };

package/dist/react-three-rapier.cjs.prod.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var React = require('react');
 var useAsset = require('use-asset');
 var fiber = require('@react-three/fiber');
-var three = require('three');
 var rapier3dCompat = require('@dimforge/rapier3d-compat');
+var three = require('three');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -67,7 +67,7 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
   x: 1,
   y: 1,
   z: 1
-}) => {
+}, hasCollisionEvents = false) => {
   var _options$shape, _options$args, _options$restitution, _options$restitutionC, _options$friction, _options$frictionComb;
 
   const mass = (options === null || options === void 0 ? void 0 : options.mass) || 1;
@@ -85,7 +85,12 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
     y: ry,
     z: rz,
     w: 1
-  }).setRestitution((_options$restitution = options === null || options === void 0 ? void 0 : options.restitution) !== null && _options$restitution !== void 0 ? _options$restitution : 0).setRestitutionCombineRule((_options$restitutionC = options === null || options === void 0 ? void 0 : options.restitutionCombineRule) !== null && _options$restitutionC !== void 0 ? _options$restitutionC : rapier3dCompat.CoefficientCombineRule.Average).setFriction((_options$friction = options === null || options === void 0 ? void 0 : options.friction) !== null && _options$friction !== void 0 ? _options$friction : 0.7).setFrictionCombineRule((_options$frictionComb = options === null || options === void 0 ? void 0 : options.frictionCombineRule) !== null && _options$frictionComb !== void 0 ? _options$frictionComb : rapier3dCompat.CoefficientCombineRule.Average); // If any of the mass properties are specified, add mass properties
+  }).setRestitution((_options$restitution = options === null || options === void 0 ? void 0 : options.restitution) !== null && _options$restitution !== void 0 ? _options$restitution : 0).setRestitutionCombineRule((_options$restitutionC = options === null || options === void 0 ? void 0 : options.restitutionCombineRule) !== null && _options$restitutionC !== void 0 ? _options$restitutionC : rapier3dCompat.CoefficientCombineRule.Average).setFriction((_options$friction = options === null || options === void 0 ? void 0 : options.friction) !== null && _options$friction !== void 0 ? _options$friction : 0.7).setFrictionCombineRule((_options$frictionComb = options === null || options === void 0 ? void 0 : options.frictionCombineRule) !== null && _options$frictionComb !== void 0 ? _options$frictionComb : rapier3dCompat.CoefficientCombineRule.Average);
+
+  if (hasCollisionEvents) {
+    colliderDesc = colliderDesc.setActiveEvents(rapier3dCompat.ActiveEvents.COLLISION_EVENTS);
+  } // If any of the mass properties are specified, add mass properties
+
 
   if (options !== null && options !== void 0 && options.mass || options !== null && options !== void 0 && options.centerOfMass || options !== null && options !== void 0 && options.principalAngularInertia) {
     colliderDesc.setDensity(0);
@@ -108,7 +113,7 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
   const collider = world.createCollider(colliderDesc, rigidBodyHandle);
   return collider;
 };
-const createCollidersFromChildren = (object, rigidBody, type, world) => {
+const createCollidersFromChildren = (object, rigidBody, type, world, hasCollisionEvents = false) => {
   const colliders = [];
   let desc;
   let offset = new three.Vector3();
@@ -181,6 +186,11 @@ const createCollidersFromChildren = (object, rigidBody, type, world) => {
         z: rz,
         w: rw
       });
+
+      if (hasCollisionEvents) {
+        desc.setActiveEvents(rapier3dCompat.ActiveEvents.COLLISION_EVENTS);
+      }
+
       const collider = world.createCollider(desc, rigidBody.handle);
       colliders.push(collider);
     }
@@ -316,7 +326,9 @@ const Physics = ({
     return worldRef.current;
   });
   const [colliderMeshes] = React.useState(() => new Map());
-  const [rigidBodyMeshes] = React.useState(() => new Map()); // Init world
+  const [rigidBodyMeshes] = React.useState(() => new Map());
+  const [rigidBodyEvents] = React.useState(() => new Map());
+  const [eventQueue] = React.useState(() => new rapier3dCompat.EventQueue(false)); // Init world
 
   React.useLayoutEffect(() => {
     const world = getWorldRef.current();
@@ -336,10 +348,27 @@ const Physics = ({
     const now = performance.now();
     const delta = Math.min(100, now - time.current);
     world.timestep = delta / 1000;
-    world.step(); // Update meshes
+    world.step(eventQueue); // Update meshes
 
     rigidBodyMeshes.forEach((mesh, handle) => {
       const rigidBody = world.getRigidBody(handle);
+      const events = rigidBodyEvents.get(handle);
+
+      if (events !== null && events !== void 0 && events.onSleep || events !== null && events !== void 0 && events.onWake) {
+        if (rigidBody.isSleeping() && !mesh.userData.isSleeping) {
+          var _events$onSleep;
+
+          events === null || events === void 0 ? void 0 : (_events$onSleep = events.onSleep) === null || _events$onSleep === void 0 ? void 0 : _events$onSleep.call(events);
+        }
+
+        if (!rigidBody.isSleeping() && mesh.userData.isSleeping) {
+          var _events$onWake;
+
+          events === null || events === void 0 ? void 0 : (_events$onWake = events.onWake) === null || _events$onWake === void 0 ? void 0 : _events$onWake.call(events);
+        }
+
+        mesh.userData.isSleeping = rigidBody.isSleeping();
+      }
 
       if (!rigidBody || rigidBody.isSleeping() || rigidBody.isFixed() || !mesh.parent) {
         return;
@@ -367,6 +396,48 @@ const Physics = ({
       o.updateMatrix();
       mesh.position.setFromMatrixPosition(o.matrix);
       mesh.rotation.setFromRotationMatrix(o.matrix);
+    }); // Collision events
+
+    eventQueue.drainCollisionEvents((handle1, handle2, started) => {
+      const collider1 = world.getCollider(handle1);
+      const collider2 = world.getCollider(handle2);
+      const rigidBodyHandle1 = collider1.parent();
+      const rigidBodyHandle2 = collider2.parent();
+
+      if (!collider1 || !collider2 || !rigidBodyHandle1 || !rigidBodyHandle2) {
+        return;
+      }
+
+      const rigidBody1 = world.getRigidBody(rigidBodyHandle1);
+      const rigidBody2 = world.getRigidBody(rigidBodyHandle2);
+      const events1 = rigidBodyEvents.get(rigidBodyHandle1);
+      const events2 = rigidBodyEvents.get(rigidBodyHandle2);
+
+      if (started) {
+        world.contactPair(handle1, handle2, (manifold, flipped) => {
+          var _events1$onCollisionE, _events2$onCollisionE;
+
+          events1 === null || events1 === void 0 ? void 0 : (_events1$onCollisionE = events1.onCollisionEnter) === null || _events1$onCollisionE === void 0 ? void 0 : _events1$onCollisionE.call(events1, {
+            target: rigidBody2,
+            manifold,
+            flipped
+          });
+          events2 === null || events2 === void 0 ? void 0 : (_events2$onCollisionE = events2.onCollisionEnter) === null || _events2$onCollisionE === void 0 ? void 0 : _events2$onCollisionE.call(events2, {
+            target: rigidBody1,
+            manifold,
+            flipped
+          });
+        });
+      } else {
+        var _events1$onCollisionE2, _events2$onCollisionE2;
+
+        events1 === null || events1 === void 0 ? void 0 : (_events1$onCollisionE2 = events1.onCollisionExit) === null || _events1$onCollisionE2 === void 0 ? void 0 : _events1$onCollisionE2.call(events1, {
+          target: rigidBody2
+        });
+        events2 === null || events2 === void 0 ? void 0 : (_events2$onCollisionE2 = events2.onCollisionExit) === null || _events2$onCollisionE2 === void 0 ? void 0 : _events2$onCollisionE2.call(events2, {
+          target: rigidBody1
+        });
+      }
     });
     time.current = now;
   });
@@ -379,7 +450,8 @@ const Physics = ({
       gravity: _gravity
     },
     colliderMeshes,
-    rigidBodyMeshes
+    rigidBodyMeshes,
+    rigidBodyEvents
   }), []);
   return /*#__PURE__*/React__default["default"].createElement(RapierContext.Provider, {
     value: context
@@ -435,7 +507,8 @@ const useRigidBody = (options = {}) => {
     rapier,
     world,
     rigidBodyMeshes,
-    physicsOptions
+    physicsOptions,
+    rigidBodyEvents
   } = useRapier();
   const ref = React.useRef(); // Create rigidbody
 
@@ -470,9 +543,11 @@ const useRigidBody = (options = {}) => {
 
     if (!ref.current) {
       ref.current = new three.Object3D();
-    } // Get intitial world transforms
+    } // isSleeping used for onSleep and onWake events
 
 
+    ref.current.userData.isSleeping = false; // Get intitial world transforms
+
     const worldPosition = ref.current.getWorldPosition(new three.Vector3());
     const worldRotation = ref.current.getWorldQuaternion(new three.Quaternion());
     const scale = ((_ref$current$parent = ref.current.parent) === null || _ref$current$parent === void 0 ? void 0 : _ref$current$parent.getWorldScale(new three.Vector3())) || {
@@ -500,7 +575,8 @@ const useRigidBody = (options = {}) => {
     rigidBody.resetForces(false);
     rigidBody.resetTorques(false);
     const colliderSetting = (_ref = (_options$colliders = options === null || options === void 0 ? void 0 : options.colliders) !== null && _options$colliders !== void 0 ? _options$colliders : physicsOptions.colliders) !== null && _ref !== void 0 ? _ref : false;
-    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, colliderSetting, world) : [];
+    const hasCollisionEvents = !!(options.onCollisionEnter || options.onCollisionExit);
+    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, colliderSetting, world, hasCollisionEvents) : [];
     rigidBody.wakeUp();
     rigidBodyMeshes.set(rigidBody.handle, ref.current);
     return () => {
@@ -509,7 +585,20 @@ const useRigidBody = (options = {}) => {
       rigidBodyRef.current = undefined;
       rigidBodyMeshes.delete(rigidBody.handle);
     };
-  }, []);
+  }, []); // Events
+
+  React.useEffect(() => {
+    const rigidBody = getRigidBodyRef.current();
+    rigidBodyEvents.set(rigidBody.handle, {
+      onCollisionEnter: options === null || options === void 0 ? void 0 : options.onCollisionEnter,
+      onCollisionExit: options === null || options === void 0 ? void 0 : options.onCollisionExit,
+      onSleep: options === null || options === void 0 ? void 0 : options.onSleep,
+      onWake: options === null || options === void 0 ? void 0 : options.onWake
+    });
+    return () => {
+      rigidBodyEvents.delete(rigidBody.handle);
+    };
+  }, [options.onCollisionEnter, options.onCollisionExit]);
   const api = React.useMemo(() => createRigidBodyApi(getRigidBodyRef), []);
   return [ref, api];
 };
@@ -823,7 +912,7 @@ const _excluded = ["children"],
       _excluded2 = ["children"];
 const RigidBodyContext = /*#__PURE__*/React.createContext(undefined);
 
-const useParentRigidBody = () => React.useContext(RigidBodyContext); // RigidBody
+const useRigidBodyContext = () => React.useContext(RigidBodyContext); // RigidBody
 
 
 const RigidBody = /*#__PURE__*/React.forwardRef((_ref, ref) => {
@@ -835,7 +924,7 @@ const RigidBody = /*#__PURE__*/React.forwardRef((_ref, ref) => {
   const [object, rigidBody] = useRigidBody(props);
   React.useImperativeHandle(ref, () => rigidBody);
   return /*#__PURE__*/React__default["default"].createElement(RigidBodyContext.Provider, {
-    value: [object, rigidBody]
+    value: [object, rigidBody, !!(props.onCollisionEnter || props.onCollisionExit)]
   }, /*#__PURE__*/React__default["default"].createElement("object3D", {
     ref: object
   }, children));
@@ -850,11 +939,11 @@ const AnyCollider = _ref2 => {
   const {
     world
   } = useRapier();
-  const [, rigidBody] = useParentRigidBody();
+  const [, rigidBody, hasCollisionEvents] = useRigidBodyContext();
   const ref = React.useRef(null);
   React.useEffect(() => {
     const scale = ref.current.getWorldScale(new three.Vector3());
-    const collider = createColliderFromOptions(props, world, rigidBody.handle, scale);
+    const collider = createColliderFromOptions(props, world, rigidBody.handle, scale, hasCollisionEvents);
     return () => {
       world.removeCollider(collider);
     };

package/dist/react-three-rapier.esm.js

@@ -1,9 +1,9 @@
 import React, { useRef, useState, useLayoutEffect, useMemo, createContext, useContext, useEffect, forwardRef, useImperativeHandle, memo } from 'react';
 import { useAsset } from 'use-asset';
 import { useFrame } from '@react-three/fiber';
-import { Vector3, Quaternion, Object3D, Euler, CylinderBufferGeometry, BufferGeometry, BufferAttribute, SphereBufferGeometry, BoxBufferGeometry } from 'three';
-import { ColliderDesc, CoefficientCombineRule, ShapeType } from '@dimforge/rapier3d-compat';
+import { ColliderDesc, CoefficientCombineRule, ActiveEvents, EventQueue, ShapeType } from '@dimforge/rapier3d-compat';
 export { CoefficientCombineRule, Collider as RapierCollider, RigidBody as RapierRigidBody } from '@dimforge/rapier3d-compat';
+import { Vector3, Quaternion, Object3D, Euler, CylinderBufferGeometry, BufferGeometry, BufferAttribute, SphereBufferGeometry, BoxBufferGeometry } from 'three';
 
 const vectorArrayToObject = arr => {
   const [x, y, z] = arr;
@@ -42,7 +42,7 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
   x: 1,
   y: 1,
   z: 1
-}) => {
+}, hasCollisionEvents = false) => {
   var _options$shape, _options$args, _options$restitution, _options$restitutionC, _options$friction, _options$frictionComb;
 
   const mass = (options === null || options === void 0 ? void 0 : options.mass) || 1;
@@ -60,7 +60,12 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
     y: ry,
     z: rz,
     w: 1
-  }).setRestitution((_options$restitution = options === null || options === void 0 ? void 0 : options.restitution) !== null && _options$restitution !== void 0 ? _options$restitution : 0).setRestitutionCombineRule((_options$restitutionC = options === null || options === void 0 ? void 0 : options.restitutionCombineRule) !== null && _options$restitutionC !== void 0 ? _options$restitutionC : CoefficientCombineRule.Average).setFriction((_options$friction = options === null || options === void 0 ? void 0 : options.friction) !== null && _options$friction !== void 0 ? _options$friction : 0.7).setFrictionCombineRule((_options$frictionComb = options === null || options === void 0 ? void 0 : options.frictionCombineRule) !== null && _options$frictionComb !== void 0 ? _options$frictionComb : CoefficientCombineRule.Average); // If any of the mass properties are specified, add mass properties
+  }).setRestitution((_options$restitution = options === null || options === void 0 ? void 0 : options.restitution) !== null && _options$restitution !== void 0 ? _options$restitution : 0).setRestitutionCombineRule((_options$restitutionC = options === null || options === void 0 ? void 0 : options.restitutionCombineRule) !== null && _options$restitutionC !== void 0 ? _options$restitutionC : CoefficientCombineRule.Average).setFriction((_options$friction = options === null || options === void 0 ? void 0 : options.friction) !== null && _options$friction !== void 0 ? _options$friction : 0.7).setFrictionCombineRule((_options$frictionComb = options === null || options === void 0 ? void 0 : options.frictionCombineRule) !== null && _options$frictionComb !== void 0 ? _options$frictionComb : CoefficientCombineRule.Average);
+
+  if (hasCollisionEvents) {
+    colliderDesc = colliderDesc.setActiveEvents(ActiveEvents.COLLISION_EVENTS);
+  } // If any of the mass properties are specified, add mass properties
+
 
   if (options !== null && options !== void 0 && options.mass || options !== null && options !== void 0 && options.centerOfMass || options !== null && options !== void 0 && options.principalAngularInertia) {
     colliderDesc.setDensity(0);
@@ -83,7 +88,7 @@ const createColliderFromOptions = (options, world, rigidBodyHandle, scale = {
   const collider = world.createCollider(colliderDesc, rigidBodyHandle);
   return collider;
 };
-const createCollidersFromChildren = (object, rigidBody, type, world) => {
+const createCollidersFromChildren = (object, rigidBody, type, world, hasCollisionEvents = false) => {
   const colliders = [];
   let desc;
   let offset = new Vector3();
@@ -156,6 +161,11 @@ const createCollidersFromChildren = (object, rigidBody, type, world) => {
         z: rz,
         w: rw
       });
+
+      if (hasCollisionEvents) {
+        desc.setActiveEvents(ActiveEvents.COLLISION_EVENTS);
+      }
+
       const collider = world.createCollider(desc, rigidBody.handle);
       colliders.push(collider);
     }
@@ -291,7 +301,9 @@ const Physics = ({
     return worldRef.current;
   });
   const [colliderMeshes] = useState(() => new Map());
-  const [rigidBodyMeshes] = useState(() => new Map()); // Init world
+  const [rigidBodyMeshes] = useState(() => new Map());
+  const [rigidBodyEvents] = useState(() => new Map());
+  const [eventQueue] = useState(() => new EventQueue(false)); // Init world
 
   useLayoutEffect(() => {
     const world = getWorldRef.current();
@@ -311,10 +323,27 @@ const Physics = ({
     const now = performance.now();
     const delta = Math.min(100, now - time.current);
     world.timestep = delta / 1000;
-    world.step(); // Update meshes
+    world.step(eventQueue); // Update meshes
 
     rigidBodyMeshes.forEach((mesh, handle) => {
       const rigidBody = world.getRigidBody(handle);
+      const events = rigidBodyEvents.get(handle);
+
+      if (events !== null && events !== void 0 && events.onSleep || events !== null && events !== void 0 && events.onWake) {
+        if (rigidBody.isSleeping() && !mesh.userData.isSleeping) {
+          var _events$onSleep;
+
+          events === null || events === void 0 ? void 0 : (_events$onSleep = events.onSleep) === null || _events$onSleep === void 0 ? void 0 : _events$onSleep.call(events);
+        }
+
+        if (!rigidBody.isSleeping() && mesh.userData.isSleeping) {
+          var _events$onWake;
+
+          events === null || events === void 0 ? void 0 : (_events$onWake = events.onWake) === null || _events$onWake === void 0 ? void 0 : _events$onWake.call(events);
+        }
+
+        mesh.userData.isSleeping = rigidBody.isSleeping();
+      }
 
       if (!rigidBody || rigidBody.isSleeping() || rigidBody.isFixed() || !mesh.parent) {
         return;
@@ -342,6 +371,48 @@ const Physics = ({
       o.updateMatrix();
       mesh.position.setFromMatrixPosition(o.matrix);
       mesh.rotation.setFromRotationMatrix(o.matrix);
+    }); // Collision events
+
+    eventQueue.drainCollisionEvents((handle1, handle2, started) => {
+      const collider1 = world.getCollider(handle1);
+      const collider2 = world.getCollider(handle2);
+      const rigidBodyHandle1 = collider1.parent();
+      const rigidBodyHandle2 = collider2.parent();
+
+      if (!collider1 || !collider2 || !rigidBodyHandle1 || !rigidBodyHandle2) {
+        return;
+      }
+
+      const rigidBody1 = world.getRigidBody(rigidBodyHandle1);
+      const rigidBody2 = world.getRigidBody(rigidBodyHandle2);
+      const events1 = rigidBodyEvents.get(rigidBodyHandle1);
+      const events2 = rigidBodyEvents.get(rigidBodyHandle2);
+
+      if (started) {
+        world.contactPair(handle1, handle2, (manifold, flipped) => {
+          var _events1$onCollisionE, _events2$onCollisionE;
+
+          events1 === null || events1 === void 0 ? void 0 : (_events1$onCollisionE = events1.onCollisionEnter) === null || _events1$onCollisionE === void 0 ? void 0 : _events1$onCollisionE.call(events1, {
+            target: rigidBody2,
+            manifold,
+            flipped
+          });
+          events2 === null || events2 === void 0 ? void 0 : (_events2$onCollisionE = events2.onCollisionEnter) === null || _events2$onCollisionE === void 0 ? void 0 : _events2$onCollisionE.call(events2, {
+            target: rigidBody1,
+            manifold,
+            flipped
+          });
+        });
+      } else {
+        var _events1$onCollisionE2, _events2$onCollisionE2;
+
+        events1 === null || events1 === void 0 ? void 0 : (_events1$onCollisionE2 = events1.onCollisionExit) === null || _events1$onCollisionE2 === void 0 ? void 0 : _events1$onCollisionE2.call(events1, {
+          target: rigidBody2
+        });
+        events2 === null || events2 === void 0 ? void 0 : (_events2$onCollisionE2 = events2.onCollisionExit) === null || _events2$onCollisionE2 === void 0 ? void 0 : _events2$onCollisionE2.call(events2, {
+          target: rigidBody1
+        });
+      }
     });
     time.current = now;
   });
@@ -354,7 +425,8 @@ const Physics = ({
       gravity: _gravity
     },
     colliderMeshes,
-    rigidBodyMeshes
+    rigidBodyMeshes,
+    rigidBodyEvents
   }), []);
   return /*#__PURE__*/React.createElement(RapierContext.Provider, {
     value: context
@@ -410,7 +482,8 @@ const useRigidBody = (options = {}) => {
     rapier,
     world,
     rigidBodyMeshes,
-    physicsOptions
+    physicsOptions,
+    rigidBodyEvents
   } = useRapier();
   const ref = useRef(); // Create rigidbody
 
@@ -445,8 +518,10 @@ const useRigidBody = (options = {}) => {
 
     if (!ref.current) {
       ref.current = new Object3D();
-    } // Get intitial world transforms
+    } // isSleeping used for onSleep and onWake events
+
 
+    ref.current.userData.isSleeping = false; // Get intitial world transforms
 
     const worldPosition = ref.current.getWorldPosition(new Vector3());
     const worldRotation = ref.current.getWorldQuaternion(new Quaternion());
@@ -475,7 +550,8 @@ const useRigidBody = (options = {}) => {
     rigidBody.resetForces(false);
     rigidBody.resetTorques(false);
     const colliderSetting = (_ref = (_options$colliders = options === null || options === void 0 ? void 0 : options.colliders) !== null && _options$colliders !== void 0 ? _options$colliders : physicsOptions.colliders) !== null && _ref !== void 0 ? _ref : false;
-    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, colliderSetting, world) : [];
+    const hasCollisionEvents = !!(options.onCollisionEnter || options.onCollisionExit);
+    const autoColliders = colliderSetting !== false ? createCollidersFromChildren(ref.current, rigidBody, colliderSetting, world, hasCollisionEvents) : [];
     rigidBody.wakeUp();
     rigidBodyMeshes.set(rigidBody.handle, ref.current);
     return () => {
@@ -484,7 +560,20 @@ const useRigidBody = (options = {}) => {
       rigidBodyRef.current = undefined;
       rigidBodyMeshes.delete(rigidBody.handle);
     };
-  }, []);
+  }, []); // Events
+
+  useEffect(() => {
+    const rigidBody = getRigidBodyRef.current();
+    rigidBodyEvents.set(rigidBody.handle, {
+      onCollisionEnter: options === null || options === void 0 ? void 0 : options.onCollisionEnter,
+      onCollisionExit: options === null || options === void 0 ? void 0 : options.onCollisionExit,
+      onSleep: options === null || options === void 0 ? void 0 : options.onSleep,
+      onWake: options === null || options === void 0 ? void 0 : options.onWake
+    });
+    return () => {
+      rigidBodyEvents.delete(rigidBody.handle);
+    };
+  }, [options.onCollisionEnter, options.onCollisionExit]);
   const api = useMemo(() => createRigidBodyApi(getRigidBodyRef), []);
   return [ref, api];
 };
@@ -798,7 +887,7 @@ const _excluded = ["children"],
       _excluded2 = ["children"];
 const RigidBodyContext = /*#__PURE__*/createContext(undefined);
 
-const useParentRigidBody = () => useContext(RigidBodyContext); // RigidBody
+const useRigidBodyContext = () => useContext(RigidBodyContext); // RigidBody
 
 
 const RigidBody = /*#__PURE__*/forwardRef((_ref, ref) => {
@@ -810,7 +899,7 @@ const RigidBody = /*#__PURE__*/forwardRef((_ref, ref) => {
   const [object, rigidBody] = useRigidBody(props);
   useImperativeHandle(ref, () => rigidBody);
   return /*#__PURE__*/React.createElement(RigidBodyContext.Provider, {
-    value: [object, rigidBody]
+    value: [object, rigidBody, !!(props.onCollisionEnter || props.onCollisionExit)]
   }, /*#__PURE__*/React.createElement("object3D", {
     ref: object
   }, children));
@@ -825,11 +914,11 @@ const AnyCollider = _ref2 => {
   const {
     world
   } = useRapier();
-  const [, rigidBody] = useParentRigidBody();
+  const [, rigidBody, hasCollisionEvents] = useRigidBodyContext();
   const ref = useRef(null);
   useEffect(() => {
     const scale = ref.current.getWorldScale(new Vector3());
-    const collider = createColliderFromOptions(props, world, rigidBody.handle, scale);
+    const collider = createColliderFromOptions(props, world, rigidBody.handle, scale, hasCollisionEvents);
     return () => {
       world.removeCollider(collider);
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-three/rapier",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "source": "src/index.ts",
   "main": "dist/react-three-rapier.cjs.js",
   "module": "dist/react-three-rapier.esm.js",