@threlte/rapier 0.1.0 → 0.2.0

package/dist/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @threlte/extras
 
+## 0.2.0
+
+### Minor Changes
+
+- 73b533d: Added contact force events and streamlined event management
+
+### Patch Changes
+
+- 7d46de2: sensors need events too!
+
 ## 0.1.0
 
 ### Minor Changes

package/dist/components/Colliders/AutoColliders.svelte

@@ -3,8 +3,10 @@ import { SceneGraphObject } from '@threlte/core';
 import { createEventDispatcher, onDestroy, onMount } from 'svelte';
 import { Object3D } from 'three';
 import { useCollisionGroups } from '../../hooks/useCollisionGroups';
+import { useHasEventListeners } from '../../hooks/useHasEventListener';
 import { useRapier } from '../../hooks/useRapier';
 import { useRigidBody } from '../../hooks/useRigidBody';
+import { applyColliderActiveEvents } from '../../lib/applyColliderActiveEvents';
 import { applyTransforms } from '../../lib/applyTransforms';
 import { createCollidersFromChildren } from '../../lib/createCollidersFromChildren';
 import { positionToVector3 } from '../../lib/positionToVector3';
@@ -19,6 +21,7 @@ export let restitutionCombineRule = undefined;
 export let friction = undefined;
 export let frictionCombineRule = undefined;
 export let sensor = undefined;
+export let contactForceEventThreshold = undefined;
 export let density = undefined;
 export let mass = undefined;
 export let massProperties = undefined;
@@ -33,6 +36,7 @@ const { world, addColliderToContext, removeColliderFromContext } = useRapier();
 export let colliders = [];
 const collisionGroups = useCollisionGroups();
 const dispatcher = createEventDispatcher();
+const { hasEventListeners: colliderHasEventListeners } = useHasEventListeners();
 onMount(() => {
     colliders = createCollidersFromChildren(object, shape ?? 'convexHull', world, rigidBody);
     colliders.forEach((c) => addColliderToContext(c, object, dispatcher));
@@ -41,13 +45,14 @@ onMount(() => {
 $: {
     if (colliders.length > 0) {
         colliders.forEach((collider) => {
-            collider.setActiveEvents(ActiveEvents.COLLISION_EVENTS);
+            applyColliderActiveEvents(collider, colliderHasEventListeners, rigidBody?.userData?.hasEventListeners);
             collider.setActiveCollisionTypes(ActiveCollisionTypes.ALL);
             collider.setRestitution(restitution ?? 0);
             collider.setRestitutionCombineRule(restitutionCombineRule ?? CoefficientCombineRule.Average);
             collider.setFriction(friction ?? 0.7);
             collider.setFrictionCombineRule(frictionCombineRule ?? CoefficientCombineRule.Average);
             collider.setSensor(sensor ?? false);
+            collider.setContactForceEventThreshold(contactForceEventThreshold ?? 0);
             if (density)
                 collider.setDensity(density);
             if (mass)

package/dist/components/Colliders/Collider.svelte

@@ -3,8 +3,10 @@ import { SceneGraphObject, TransformableObject, useFrame } from '@threlte/core';
 import { createEventDispatcher, onDestroy, onMount, tick } from 'svelte';
 import { Object3D, Quaternion, Vector3 } from 'three';
 import { useCollisionGroups } from '../../hooks/useCollisionGroups';
+import { useHasEventListeners } from '../../hooks/useHasEventListener';
 import { useRapier } from '../../hooks/useRapier';
 import { useRigidBody } from '../../hooks/useRigidBody';
+import { applyColliderActiveEvents } from '../../lib/applyColliderActiveEvents';
 import { applyTransforms } from '../../lib/applyTransforms';
 import { getWorldPosition, getWorldQuaternion } from '../../lib/getWorldTransforms';
 import { positionToVector3 } from '../../lib/positionToVector3';
@@ -21,6 +23,7 @@ export let restitutionCombineRule = undefined;
 export let friction = undefined;
 export let frictionCombineRule = undefined;
 export let sensor = undefined;
+export let contactForceEventThreshold = undefined;
 export let density = undefined;
 export let mass = undefined;
 export let massProperties = undefined;
@@ -78,15 +81,18 @@ onMount(async () => {
         collider.setRotation(object.getWorldQuaternion(new Quaternion()));
     }
 });
+const { hasEventListeners: colliderHasEventListeners } = useHasEventListeners();
 $: {
     if (collider) {
-        collider.setActiveEvents(ActiveEvents.COLLISION_EVENTS);
+        applyColliderActiveEvents(collider, colliderHasEventListeners, rigidBody?.userData?.hasEventListeners);
         collider.setActiveCollisionTypes(ActiveCollisionTypes.ALL);
         collider.setRestitution(restitution ?? 0);
+        collider.setContactForceEventThreshold(1);
         collider.setRestitutionCombineRule(restitutionCombineRule ?? CoefficientCombineRule.Average);
         collider.setFriction(friction ?? 0.7);
         collider.setFrictionCombineRule(frictionCombineRule ?? CoefficientCombineRule.Average);
         collider.setSensor(sensor ?? false);
+        collider.setContactForceEventThreshold(contactForceEventThreshold ?? 0);
         if (density)
             collider.setDensity(density);
         if (mass)

package/dist/components/Colliders/Collider.svelte.d.ts

@@ -1,7 +1,6 @@
 import { SvelteComponentTyped } from "svelte";
-import { CoefficientCombineRule, Collider, ColliderDesc } from '@dimforge/rapier3d-compat';
+import { CoefficientCombineRule, Collider, ColliderDesc, type RigidBody } from '@dimforge/rapier3d-compat';
 import { type Position, type Rotation } from '@threlte/core';
-import type { ColliderEventMap } from '../../types/types';
 declare class __sveltets_Render<Shape extends 'ball' | 'capsule' | 'segment' | 'triangle' | 'roundTriangle' | 'polyline' | 'trimesh' | 'cuboid' | 'roundCuboid' | 'heightfield' | 'cylinder' | 'roundCylinder' | 'cone' | 'roundCone' | 'convexHull' | 'convexMesh' | 'roundConvexHull' | 'roundConvexMesh', Args extends Parameters<typeof ColliderDesc[Shape]>, Density extends number | undefined, Mass extends Density extends undefined ? number | undefined : undefined, MassProperties extends Density extends undefined ? Mass extends undefined ? {
     mass: number;
     centerOfMass: Position;
@@ -21,6 +20,7 @@ declare class __sveltets_Render<Shape extends 'ball' | 'capsule' | 'segment' | '
         frictionCombineRule?: CoefficientCombineRule | undefined;
         sensor?: boolean | undefined;
         collider?: Collider | undefined;
+        contactForceEventThreshold?: number | undefined;
         density?: Density | undefined;
     } | {
         shape: Shape;
@@ -35,6 +35,7 @@ declare class __sveltets_Render<Shape extends 'ball' | 'capsule' | 'segment' | '
         frictionCombineRule?: CoefficientCombineRule | undefined;
         sensor?: boolean | undefined;
         collider?: Collider | undefined;
+        contactForceEventThreshold?: number | undefined;
         mass?: Mass | undefined;
     } | {
         shape: Shape;
@@ -49,10 +50,40 @@ declare class __sveltets_Render<Shape extends 'ball' | 'capsule' | 'segment' | '
         frictionCombineRule?: CoefficientCombineRule | undefined;
         sensor?: boolean | undefined;
         collider?: Collider | undefined;
+        contactForceEventThreshold?: number | undefined;
         mass?: Mass | undefined;
         massProperties?: MassProperties | undefined;
     };
-    events(): ColliderEventMap;
+    events(): {
+        collisionenter: CustomEvent<{
+            targetCollider: Collider;
+            targetRigidBody: RigidBody | null;
+            manifold: import("@dimforge/rapier3d-compat").TempContactManifold;
+            flipped: boolean;
+        }>;
+        collisionexit: CustomEvent<{
+            targetCollider: Collider;
+            targetRigidBody: RigidBody | null;
+        }>;
+        sensorenter: CustomEvent<{
+            targetCollider: Collider;
+            targetRigidBody: RigidBody | null;
+        }>;
+        sensorexit: CustomEvent<{
+            targetCollider: Collider;
+            targetRigidBody: RigidBody | null;
+        }>;
+        contact: CustomEvent<{
+            targetCollider: Collider;
+            targetRigidBody: RigidBody | null;
+            manifold: import("@dimforge/rapier3d-compat").TempContactManifold;
+            flipped: boolean;
+            maxForceDirection: import("@dimforge/rapier3d-compat").Vector;
+            maxForceMagnitude: number;
+            totalForce: import("@dimforge/rapier3d-compat").Vector;
+            totalForceMagnitude: number;
+        }>;
+    };
     slots(): {
         default: {};
     };

package/dist/components/RigidBody/RigidBody.svelte

@@ -1,6 +1,7 @@
 <script>import { LayerableObject, SceneGraphObject } from '@threlte/core';
 import { createEventDispatcher, onDestroy, setContext, tick } from 'svelte';
 import { Object3D, Vector3 } from 'three';
+import { useHasEventListeners } from '../../hooks/useHasEventListener';
 import { useRapier } from '../../hooks/useRapier';
 import { applyTransforms } from '../../lib/applyTransforms';
 import { getWorldPosition, getWorldQuaternion, getWorldScale } from '../../lib/getWorldTransforms';
@@ -58,11 +59,14 @@ object.updateWorldMatrix(true, false);
  * RigidBody Description
  */
 const desc = new rapier.RigidBodyDesc(parseRigidBodyType(type)).setCanSleep(canSleep);
+/**
+ * Export the rigidBody only after positional initialization
+ */
 export let rigidBody = undefined;
 /**
- * RigidBody init
+ * Temporary RigidBody init
  */
-export const rigidBodyTemp = world.createRigidBody(desc);
+const rigidBodyTemp = world.createRigidBody(desc);
 /**
  * Apply transforms after the parent component added "object" to itself
  */
@@ -104,6 +108,13 @@ $: {
     rigidBodyTemp.setEnabledRotations(...enabledRotations, true);
     rigidBodyTemp.setEnabledTranslations(...enabledTranslations, true);
 }
+/**
+ * Add userData to the rigidBody
+ */
+const { hasEventListeners } = useHasEventListeners();
+rigidBodyTemp.userData = {
+    hasEventListeners
+};
 /**
  * Setting the RigidBody context so that colliders can
  * hook onto.

package/dist/components/RigidBody/RigidBody.svelte.d.ts

@@ -1,7 +1,6 @@
 import { SvelteComponentTyped } from "svelte";
 import type { RigidBody } from '@dimforge/rapier3d-compat';
 import type { RigidBodyProperties } from '../../types/components';
-import type { RigidBodyEventMap } from '../../types/types';
 declare const __propDef: {
     props: {
         debug?: boolean | undefined;
@@ -20,23 +19,50 @@ declare const __propDef: {
         enabledRotations?: import("../../types/components").Boolean3Array | undefined;
         enabledTranslations?: import("../../types/components").Boolean3Array | undefined;
         dominance?: number | undefined;
-        rigidBody?: RigidBody | undefined;
         /**
-           * RigidBody init
-           */ rigidBodyTemp?: RigidBody | undefined;
+           * Export the rigidBody only after positional initialization
+           */ rigidBody?: RigidBody | undefined;
     };
     slots: {
         default: {};
     };
-    getters: {
-        rigidBodyTemp: RigidBody;
+    getters: {};
+    events: {
+        collisionenter: CustomEvent<{
+            targetCollider: import("@dimforge/rapier3d-compat").Collider;
+            targetRigidBody: RigidBody | null;
+            manifold: import("@dimforge/rapier3d-compat").TempContactManifold;
+            flipped: boolean;
+        }>;
+        collisionexit: CustomEvent<{
+            targetCollider: import("@dimforge/rapier3d-compat").Collider;
+            targetRigidBody: RigidBody | null;
+        }>;
+        sensorenter: CustomEvent<{
+            targetCollider: import("@dimforge/rapier3d-compat").Collider;
+            targetRigidBody: RigidBody | null;
+        }>;
+        sensorexit: CustomEvent<{
+            targetCollider: import("@dimforge/rapier3d-compat").Collider;
+            targetRigidBody: RigidBody | null;
+        }>;
+        contact: CustomEvent<{
+            targetCollider: import("@dimforge/rapier3d-compat").Collider;
+            targetRigidBody: RigidBody | null;
+            manifold: import("@dimforge/rapier3d-compat").TempContactManifold;
+            flipped: boolean;
+            maxForceDirection: import("@dimforge/rapier3d-compat").Vector;
+            maxForceMagnitude: number;
+            totalForce: import("@dimforge/rapier3d-compat").Vector;
+            totalForceMagnitude: number;
+        }>;
+        sleep: CustomEvent<void>;
+        wake: CustomEvent<void>;
     };
-    events: RigidBodyEventMap;
 };
 export declare type RigidBodyProps = typeof __propDef.props;
 export declare type RigidBodyEvents = typeof __propDef.events;
 export declare type RigidBodySlots = typeof __propDef.slots;
 export default class RigidBody extends SvelteComponentTyped<RigidBodyProps, RigidBodyEvents, RigidBodySlots> {
-    get rigidBodyTemp(): RigidBody;
 }
 export {};

package/dist/hooks/useFrameHandler.js

@@ -1,9 +1,27 @@
-import { EventQueue } from '@dimforge/rapier3d-compat';
+import { Collider, EventQueue } from '@dimforge/rapier3d-compat';
 import { useFrame } from '@threlte/core';
 import { Object3D, Quaternion, Vector3 } from 'three';
 const tempObject = new Object3D();
 const tempVector3 = new Vector3();
 const tempQuaternion = new Quaternion();
+const getEventDispatchers = (ctx, collider1, collider2) => {
+    const colliderDispatcher1 = ctx.colliderEventDispatchers.get(collider1.handle);
+    const colliderDispatcher2 = ctx.colliderEventDispatchers.get(collider2.handle);
+    const rigidBody1 = collider1.parent();
+    const rigidBody2 = collider2.parent();
+    const rigidBodyDispatcher1 = rigidBody1
+        ? ctx.rigidBodyEventDispatchers.get(rigidBody1.handle)
+        : undefined;
+    const rigidBodyDispatcher2 = rigidBody2
+        ? ctx.rigidBodyEventDispatchers.get(rigidBody2.handle)
+        : undefined;
+    return {
+        colliderDispatcher1,
+        colliderDispatcher2,
+        rigidBodyDispatcher1,
+        rigidBodyDispatcher2
+    };
+};
 export const useFrameHandler = (ctx) => {
     const eventQueue = new EventQueue(false);
     let time = performance.now();
@@ -52,6 +70,61 @@ export const useFrameHandler = (ctx) => {
             mesh.position.setFromMatrixPosition(tempObject.matrix);
             mesh.rotation.setFromRotationMatrix(tempObject.matrix);
         });
+        eventQueue.drainContactForceEvents((e) => {
+            const collider1 = world.getCollider(e.collider1());
+            const collider2 = world.getCollider(e.collider2());
+            // Sanity check
+            if (!collider1 || !collider2) {
+                return;
+            }
+            const { colliderDispatcher1, colliderDispatcher2, rigidBodyDispatcher1, rigidBodyDispatcher2 } = getEventDispatchers(ctx, collider1, collider2);
+            const rigidBody1 = collider1.parent();
+            const rigidBody2 = collider2.parent();
+            world.contactPair(collider1, collider2, (manifold, flipped) => {
+                // Collider events
+                colliderDispatcher1?.('contact', {
+                    flipped,
+                    manifold,
+                    targetCollider: collider2,
+                    targetRigidBody: rigidBody2,
+                    maxForceDirection: e.maxForceDirection(),
+                    maxForceMagnitude: e.maxForceMagnitude(),
+                    totalForce: e.totalForce(),
+                    totalForceMagnitude: e.totalForceMagnitude()
+                });
+                colliderDispatcher2?.('contact', {
+                    flipped,
+                    manifold,
+                    targetCollider: collider1,
+                    targetRigidBody: rigidBody1,
+                    maxForceDirection: e.maxForceDirection(),
+                    maxForceMagnitude: e.maxForceMagnitude(),
+                    totalForce: e.totalForce(),
+                    totalForceMagnitude: e.totalForceMagnitude()
+                });
+                // RigidBody Events
+                rigidBodyDispatcher1?.('contact', {
+                    flipped,
+                    manifold,
+                    targetCollider: collider2,
+                    targetRigidBody: rigidBody2,
+                    maxForceDirection: e.maxForceDirection(),
+                    maxForceMagnitude: e.maxForceMagnitude(),
+                    totalForce: e.totalForce(),
+                    totalForceMagnitude: e.totalForceMagnitude()
+                });
+                rigidBodyDispatcher2?.('contact', {
+                    flipped,
+                    manifold,
+                    targetCollider: collider1,
+                    targetRigidBody: rigidBody1,
+                    maxForceDirection: e.maxForceDirection(),
+                    maxForceMagnitude: e.maxForceMagnitude(),
+                    totalForce: e.totalForce(),
+                    totalForceMagnitude: e.totalForceMagnitude()
+                });
+            });
+        });
         // Collision events
         eventQueue.drainCollisionEvents((handle1, handle2, started) => {
             const collider1 = world.getCollider(handle1);
@@ -60,16 +133,9 @@ export const useFrameHandler = (ctx) => {
             if (!collider1 || !collider2) {
                 return;
             }
-            const colliderDispatcher1 = ctx.colliderEventDispatchers.get(collider1.handle);
-            const colliderDispatcher2 = ctx.colliderEventDispatchers.get(collider2.handle);
+            const { colliderDispatcher1, colliderDispatcher2, rigidBodyDispatcher1, rigidBodyDispatcher2 } = getEventDispatchers(ctx, collider1, collider2);
             const rigidBody1 = collider1.parent();
             const rigidBody2 = collider2.parent();
-            const rigidBodyDispatcher1 = rigidBody1
-                ? ctx.rigidBodyEventDispatchers.get(rigidBody1.handle)
-                : undefined;
-            const rigidBodyDispatcher2 = rigidBody2
-                ? ctx.rigidBodyEventDispatchers.get(rigidBody2.handle)
-                : undefined;
             if (started) {
                 // intersections are triggered by sensors
                 const isIntersection = world.intersectionPair(collider1, collider2);

package/dist/hooks/useHasEventListener.d.ts

@@ -0,0 +1,3 @@
+export declare const useHasEventListeners: <T extends (type: any) => any = any>() => {
+    hasEventListeners: (type: Parameters<T>[0]) => boolean;
+};

package/dist/hooks/useHasEventListener.js

@@ -0,0 +1,11 @@
+import { get_current_component } from 'svelte/internal';
+export const useHasEventListeners = () => {
+    const component = get_current_component();
+    const hasEventListeners = (type) => {
+        const callbacks = component.$$.callbacks;
+        return type in callbacks && callbacks[type].length > 0;
+    };
+    return {
+        hasEventListeners
+    };
+};

package/dist/hooks/useRigidBody.d.ts

@@ -1,2 +1,2 @@
 import type { RigidBodyContext } from '../types/types';
-export declare const useRigidBody: () => RigidBodyContext;
+export declare const useRigidBody: () => RigidBodyContext | undefined;

package/dist/lib/applyColliderActiveEvents.d.ts

@@ -0,0 +1,4 @@
+import { type Collider } from '@dimforge/rapier3d-compat';
+import type { useHasEventListeners } from '../hooks/useHasEventListener';
+import type { ColliderEventDispatcher, RigidBodyEventDispatcher } from '../types/types';
+export declare const applyColliderActiveEvents: (collider: Collider, colliderHasEventListeners: ReturnType<typeof useHasEventListeners<ColliderEventDispatcher>>['hasEventListeners'], rigidBodyHasEventListeners?: ReturnType<typeof useHasEventListeners<RigidBodyEventDispatcher>>['hasEventListeners']) => void;

package/dist/lib/applyColliderActiveEvents.js

@@ -0,0 +1,20 @@
+import { ActiveEvents } from '@dimforge/rapier3d-compat';
+export const applyColliderActiveEvents = (collider, colliderHasEventListeners, rigidBodyHasEventListeners) => {
+    let events = 0;
+    if (colliderHasEventListeners('collisionenter') ||
+        colliderHasEventListeners('collisionexit') ||
+        rigidBodyHasEventListeners?.('collisionenter') ||
+        rigidBodyHasEventListeners?.('collisionexit') ||
+        colliderHasEventListeners('sensorenter') ||
+        colliderHasEventListeners('sensorexit') ||
+        rigidBodyHasEventListeners?.('sensorenter') ||
+        rigidBodyHasEventListeners?.('sensorexit')) {
+        events = events | ActiveEvents.COLLISION_EVENTS;
+    }
+    if (colliderHasEventListeners('contact') || rigidBodyHasEventListeners?.('contact')) {
+        events = events | ActiveEvents.CONTACT_FORCE_EVENTS;
+    }
+    if (events > 0) {
+        collider.setActiveEvents(events);
+    }
+};

package/dist/types/types.d.ts

@@ -1,7 +1,8 @@
 import type { createEventDispatcher } from 'svelte';
-import type { RigidBody, RigidBodyHandle, TempContactManifold, ColliderHandle, Collider } from '@dimforge/rapier3d-compat';
+import type { RigidBody, RigidBodyHandle, TempContactManifold, ColliderHandle, Collider, Vector } from '@dimforge/rapier3d-compat';
 import type { createRapierContext } from '../lib/createRapierContext';
 import type { Writable } from 'svelte/store';
+import type { useHasEventListeners } from '../hooks/useHasEventListener';
 export declare type ColliderShapes = 'ball' | 'capsule' | 'segment' | 'triangle' | 'roundTriangle' | 'polyline' | 'trimesh' | 'cuboid' | 'roundCuboid' | 'heightfield' | 'cylinder' | 'roundCylinder' | 'cone' | 'roundCone' | 'convexHull' | 'convexMesh' | 'roundConvexHull' | 'roundConvexMesh';
 export declare type AutoCollidersShapes = 'cuboid' | 'ball' | 'trimesh' | 'convexHull' | 'capsule';
 export declare type ColliderEventMap = {
@@ -23,6 +24,16 @@ export declare type ColliderEventMap = {
         targetCollider: Collider;
         targetRigidBody: RigidBody | null;
     };
+    contact: {
+        targetCollider: Collider;
+        targetRigidBody: RigidBody | null;
+        manifold: TempContactManifold;
+        flipped: boolean;
+        maxForceDirection: Vector;
+        maxForceMagnitude: number;
+        totalForce: Vector;
+        totalForceMagnitude: number;
+    };
 };
 export declare type RigidBodyEventMap = ColliderEventMap & {
     sleep: void;
@@ -34,5 +45,11 @@ export declare type RigidBodyEventDispatchers = Map<RigidBodyHandle, RigidBodyEv
 export declare type ColliderEventDispatchers = Map<ColliderHandle, ColliderEventDispatcher>;
 export declare type RapierContext = ReturnType<typeof createRapierContext>;
 export declare type CollisionGroupsContext = Writable<number> | undefined;
-export declare type RigidBodyContext = RigidBody;
+export declare type RigidBodyUserData = {
+    hasEventListeners?: ReturnType<typeof useHasEventListeners<RigidBodyEventDispatcher>>['hasEventListeners'];
+};
+export declare type ThrelteRigidBody = RigidBody & {
+    userData?: RigidBodyUserData;
+};
+export declare type RigidBodyContext = ThrelteRigidBody;
 export declare type CollisionGroupsBitMask = (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15)[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@threlte/rapier",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "author": "Grischa Erbe <hello@legrisch.com> (https://legrisch.com)",
   "license": "MIT",
   "devDependencies": {
@@ -8,7 +8,7 @@
     "@sveltejs/adapter-auto": "next",
     "@sveltejs/adapter-static": "^1.0.0-next.29",
     "@sveltejs/kit": "next",
-    "@threlte/core": "4.3.1",
+    "@threlte/core": "4.3.2",
     "@types/node": "^18.0.3",
     "@types/three": "^0.140.0",
     "@typescript-eslint/eslint-plugin": "^4.31.1",