@threlte/rapier 3.0.0-next.0 → 3.0.0-next.10

package/dist/lib/createRapierContext.js

@@ -1,7 +1,10 @@
 import RAPIER from '@dimforge/rapier3d-compat';
-import { readable, writable } from 'svelte/store';
-export const createRapierContext = (...args) => {
-    const world = new RAPIER.World(...args);
+import { currentWritable } from '@threlte/core';
+import { derived, writable } from 'svelte/store';
+import { createPhysicsStages } from './createPhysicsStages';
+import { createPhysicsTasks } from './createPhysicsTasks';
+export const createRapierContext = (worldArgs, options) => {
+    const world = new RAPIER.World(...worldArgs);
     const colliderObjects = new Map();
     const rigidBodyObjects = new Map();
     const rigidBodyEventDispatchers = new Map();
@@ -12,9 +15,9 @@ export const createRapierContext = (...args) => {
      * @param object
      * @param eventDispatcher
      */
-    const addColliderToContext = (collider, object, events) => {
+    const addColliderToContext = (collider, object, props) => {
         colliderObjects.set(collider.handle, object);
-        colliderEventDispatchers.set(collider.handle, events);
+        colliderEventDispatchers.set(collider.handle, props);
     };
     /**
      * Removes the collider from the context
@@ -42,11 +45,17 @@ export const createRapierContext = (...args) => {
         rigidBodyObjects.delete(rigidBody.handle);
         rigidBodyEventDispatchers.delete(rigidBody.handle);
     };
-    // Dummy functions, will be replaced by useFrameHandler fn
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    const pause = () => { };
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    const resume = () => { };
+    const framerate = currentWritable(options.framerate ?? 'varying');
+    const simulationOffset = currentWritable(1);
+    const updateRigidBodySimulationData = currentWritable(framerate.current === 'varying');
+    const { simulationStage, synchronizationStage } = createPhysicsStages(framerate, simulationOffset, updateRigidBodySimulationData, options);
+    const autostart = options.autoStart ?? true;
+    const paused = writable(!autostart);
+    if (!autostart) {
+        simulationStage.stop();
+        synchronizationStage.stop();
+    }
+    const { simulationTask, synchronizationTask } = createPhysicsTasks(world, framerate, simulationOffset, rigidBodyObjects, updateRigidBodySimulationData, colliderEventDispatchers, rigidBodyEventDispatchers, simulationStage, synchronizationStage);
     return {
         rapier: RAPIER,
         world,
@@ -59,8 +68,23 @@ export const createRapierContext = (...args) => {
         addRigidBodyToContext,
         removeRigidBodyFromContext,
         debug: writable(false),
-        pause,
-        resume,
-        paused: readable(false)
+        pause: () => {
+            paused.set(true);
+            simulationStage.stop();
+            synchronizationStage.stop();
+        },
+        resume: () => {
+            paused.set(false);
+            simulationStage.start();
+            synchronizationStage.start();
+        },
+        paused: derived(paused, (a) => a),
+        framerate,
+        simulationOffset,
+        simulationStage,
+        synchronizationStage,
+        updateRigidBodySimulationData,
+        simulationTask,
+        synchronizationTask
     };
 };

package/dist/lib/initRapier.svelte.d.ts

@@ -0,0 +1 @@
+export declare const initRapier: () => true | Promise<void>;

package/dist/lib/initRapier.svelte.js

@@ -0,0 +1,16 @@
+import RAPIER from '@dimforge/rapier3d-compat';
+let initialized = false;
+let promise;
+export const initRapier = () => {
+    if (initialized)
+        return true;
+    if (!promise) {
+        promise = new Promise((resolve) => {
+            RAPIER.init().then(() => {
+                initialized = true;
+                resolve();
+            });
+        });
+    }
+    return promise;
+};

package/dist/lib/keys.d.ts

@@ -0,0 +1,2 @@
+export declare const simulationKey: unique symbol;
+export declare const synchronizationKey: unique symbol;

package/dist/lib/keys.js

@@ -0,0 +1,2 @@
+export const simulationKey = Symbol('simulation');
+export const synchronizationKey = Symbol('synchronization');

package/dist/lib/rigidBodyObjectContext.d.ts

@@ -1,2 +1,3 @@
-export declare const useParentRigidbodyObject: () => THREE.Object3D | undefined;
-export declare const setParentRigidbodyObject: (object3d: THREE.Object3D) => void;
+import type { Object3D } from 'three';
+export declare const useParentRigidbodyObject: () => Object3D | undefined;
+export declare const setParentRigidbodyObject: (object3d: Object3D) => void;

package/dist/lib/useCreateEvent.d.ts

@@ -1,3 +1,4 @@
-export declare const useCreateEvent: <T>(events: Record<string, (arg: unknown) => void>) => {
+import type { ColliderEvents } from '../types/types';
+export declare const useCreateEvent: <T>(oncreate?: ColliderEvents['oncreate']) => {
     updateRef: (newRef: T) => void;
 };

package/dist/lib/useCreateEvent.js

@@ -1,7 +1,7 @@
 import { onDestroy } from 'svelte';
-export const useCreateEvent = (events) => {
+export const useCreateEvent = (oncreate) => {
     const cleanupFunctions = [];
-    let ref = undefined;
+    let ref;
     const dispatchCreateEvent = () => {
         // call every cleanup function
         cleanupFunctions.forEach((cleanup) => cleanup());
@@ -13,7 +13,7 @@ export const useCreateEvent = (events) => {
         };
         if (ref === undefined)
             return;
-        events?.create?.({ ref, cleanup });
+        oncreate?.({ ref, cleanup });
     };
     const updateRef = (newRef) => {
         ref = newRef;

package/dist/recipes/BasicPlayerController.svelte

@@ -1,4 +1,4 @@
-<script lang="ts">import { createRawEventDispatcher, T, useTask } from '@threlte/core';
+<script lang="ts">import { T, useTask } from '@threlte/core';
 import { Vector2, Vector3 } from 'three';
 import Collider from '../components/Colliders/Collider.svelte';
 import CollisionGroups from '../components/CollisionGroups/CollisionGroups.svelte';
@@ -10,6 +10,8 @@ export let speed = 1;
 export let jumpStrength = 3;
 export let playerCollisionGroups = [0];
 export let groundCollisionGroups = [15];
+export let ongroundenter = undefined;
+export let ongroundexit = undefined;
 let rigidBody;
 const keys = {
     up: false,
@@ -19,7 +21,6 @@ const keys = {
 };
 const t = new Vector3();
 const t2 = new Vector2();
-const dispatch = createRawEventDispatcher();
 let grounded = false;
 let groundsSensored = 0;
 $: {
@@ -28,7 +29,7 @@ $: {
     else
         grounded = true;
 }
-$: grounded ? dispatch('groundenter') : dispatch('groundexit');
+$: grounded ? ongroundenter?.() : ongroundexit?.();
 const { start } = useTask(() => {
     t.set(0, 0, 0);
     if (keys.down)
@@ -126,8 +127,8 @@ const onKeyUp = (e) => {
       <T.Group position={[0, -height / 2 + radius, 0]}>
         <Collider
           sensor
-          on:sensorenter={() => (groundsSensored += 1)}
-          on:sensorexit={() => (groundsSensored -= 1)}
+          onsensorenter={() => (groundsSensored += 1)}
+          onsensorexit={() => (groundsSensored -= 1)}
           shape={'ball'}
           args={[radius * 1.2]}
         />

package/dist/recipes/BasicPlayerController.svelte.d.ts

@@ -10,9 +10,9 @@ declare const __propDef: {
         jumpStrength?: number | undefined;
         playerCollisionGroups?: CollisionGroupsBitMask | undefined;
         groundCollisionGroups?: CollisionGroupsBitMask | undefined;
-        children?: ((this: void) => typeof import("svelte").SnippetReturn & {
-            _: "functions passed to {@render ...} tags must use the `Snippet` type imported from \"svelte\"";
-        }) | undefined;
+        ongroundenter?: (() => void) | undefined;
+        ongroundexit?: (() => void) | undefined;
+        children?: import("svelte").Snippet<[]> | undefined;
     };
     events: {
         [evt: string]: CustomEvent<any>;

package/dist/types/types.d.ts

@@ -1,56 +1,55 @@
 /// <reference types="svelte" />
-import type { Collider, ColliderHandle, RigidBody, RigidBodyHandle, TempContactManifold, Vector } from '@dimforge/rapier3d-compat';
-import type { Writable } from 'svelte/store';
-import type { createRapierContext } from '../lib/createRapierContext';
+import { World, type Collider, type RigidBody, type TempContactManifold, type Vector } from '@dimforge/rapier3d-compat';
+import RAPIER from '@dimforge/rapier3d-compat';
+import type { CurrentWritable, Stage, Task } from '@threlte/core';
+import type { Readable, Writable } from 'svelte/store';
+import type { Object3D } from 'three';
 export type ColliderShapes = 'ball' | 'capsule' | 'segment' | 'triangle' | 'roundTriangle' | 'polyline' | 'trimesh' | 'cuboid' | 'roundCuboid' | 'heightfield' | 'cylinder' | 'roundCylinder' | 'cone' | 'roundCone' | 'convexHull' | 'convexMesh' | 'roundConvexHull' | 'roundConvexMesh';
 export type AutoCollidersShapes = 'cuboid' | 'ball' | 'trimesh' | 'convexHull' | 'capsule';
-export type ColliderEventMap = {
-    create: {
+export type ColliderEvents = {
+    oncreate?: (event: {
         ref: Collider;
         cleanup: (callback: () => void) => void;
-    };
-    collisionenter: {
+    }) => void;
+    oncollisionenter?: (event: {
         targetCollider: Collider;
         targetRigidBody: RigidBody | null;
         manifold: TempContactManifold;
         flipped: boolean;
-    };
-    collisionexit: {
+    }) => void;
+    oncollisionexit?: (event: {
         targetCollider: Collider;
         targetRigidBody: RigidBody | null;
-    };
-    sensorenter: {
+    }) => void;
+    onsensorenter?: (event: {
         targetCollider: Collider;
         targetRigidBody: RigidBody | null;
-    };
-    sensorexit: {
+    }) => void;
+    onsensorexit?: (event: {
         targetCollider: Collider;
         targetRigidBody: RigidBody | null;
-    };
-    contact: {
+    }) => void;
+    oncontact?: (event: {
         targetCollider: Collider;
         targetRigidBody: RigidBody | null;
         maxForceDirection: Vector;
         maxForceMagnitude: number;
         totalForce: Vector;
         totalForceMagnitude: number;
-    };
+    }) => void;
 };
-export type CollisionEnterEvent = ColliderEventMap['collisionenter'];
-export type CollisionExitEvent = ColliderEventMap['collisionexit'];
-export type SensorEnterEvent = ColliderEventMap['sensorenter'];
-export type SensorExitEvent = ColliderEventMap['sensorexit'];
-export type ContactEvent = ColliderEventMap['contact'];
-export type RigidBodyEventMap = ColliderEventMap & {
-    sleep: void;
-    wake: void;
+export type CollisionEnterEvent = ColliderEvents['oncollisionenter'];
+export type CollisionExitEvent = ColliderEvents['oncollisionexit'];
+export type SensorEnterEvent = ColliderEvents['onsensorenter'];
+export type SensorExitEvent = ColliderEvents['onsensorexit'];
+export type ContactEvent = ColliderEvents['oncontact'];
+export type RigidBodyEvents = ColliderEvents & {
+    onsleep?: () => void;
+    onwake?: () => void;
 };
-export type RigidBodyEventDispatchers = Map<RigidBodyHandle, Record<string, (arg: unknown) => void>>;
-export type ColliderEventDispatchers = Map<ColliderHandle, Record<string, (arg: unknown) => void>>;
-export type RapierContext = ReturnType<typeof createRapierContext>;
 export type CollisionGroupsContext = Writable<number> | undefined;
 export type RigidBodyUserData = {
-    events?: Record<string, (arg: unknown) => void>;
+    events?: RigidBodyEvents;
 };
 export type ThrelteRigidBody = RigidBody & {
     userData?: RigidBodyUserData;
@@ -61,3 +60,31 @@ export type CollisionGroupsBitMask = (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
  * Used in the <Attractor> component
  */
 export type GravityType = 'static' | 'linear' | 'newtonian';
+export type Framerate = number | 'varying';
+export type RapierContext = {
+    rapier: typeof RAPIER;
+    world: World;
+    colliderObjects: Map<number, Object3D>;
+    rigidBodyObjects: Map<number, Object3D>;
+    rigidBodyEventDispatchers: Map<number, RigidBodyEvents>;
+    colliderEventDispatchers: Map<number, ColliderEvents>;
+    addColliderToContext: (collider: Collider, object: Object3D, props: ColliderEvents) => void;
+    removeColliderFromContext: (collider: Collider) => void;
+    addRigidBodyToContext: (rigidBody: RigidBody, object: Object3D, events: RigidBodyEvents) => void;
+    removeRigidBodyFromContext: (rigidBody: RigidBody) => void;
+    debug: Writable<boolean>;
+    pause: () => void;
+    resume: () => void;
+    paused: Readable<boolean>;
+    framerate: CurrentWritable<Framerate>;
+    simulationStage: Stage;
+    simulationTask: Task;
+    synchronizationStage: Stage;
+    synchronizationTask: Task;
+    /**
+     * This number tells us how far we're off in the simulation stage as opposed
+     * to the render stage
+     */
+    simulationOffset: CurrentWritable<number>;
+    updateRigidBodySimulationData: CurrentWritable<boolean>;
+};

package/package.json

@@ -1,43 +1,62 @@
 {
   "name": "@threlte/rapier",
-  "version": "3.0.0-next.0",
+  "version": "3.0.0-next.10",
   "author": "Grischa Erbe <hello@legrisch.com> (https://legrisch.com)",
   "license": "MIT",
+  "description": "Components and hooks to use the Rapier physics engine in Threlte",
   "devDependencies": {
-    "@dimforge/rapier3d-compat": "^0.12.0",
+    "@dimforge/rapier3d-compat": "^0.14.0",
     "@sveltejs/adapter-auto": "^3.2.0",
     "@sveltejs/kit": "^2.5.5",
     "@sveltejs/package": "^2.3.1",
-    "@sveltejs/vite-plugin-svelte": "^3.0.2",
-    "@types/node": "^20.12.4",
-    "@types/three": "^0.163.0",
-    "@typescript-eslint/eslint-plugin": "^7.5.0",
-    "@typescript-eslint/parser": "^7.5.0",
+    "@sveltejs/vite-plugin-svelte": "^3.1.0",
+    "@types/node": "^20.12.7",
+    "@types/three": "^0.166.0",
+    "@typescript-eslint/eslint-plugin": "^7.6.0",
+    "@typescript-eslint/parser": "^7.6.0",
     "@yushijinhun/three-minifier-rollup": "^0.4.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-svelte": "^2.35.1",
+    "eslint-plugin-svelte": "^2.36.0",
     "prettier": "^3.2.5",
     "prettier-plugin-svelte": "^3.2.2",
     "publint": "^0.2.7",
     "rimraf": "^5.0.5",
-    "svelte": "5.0.0-next.94",
+    "svelte": "5.0.0-next.181",
     "svelte-check": "^3.6.9",
     "svelte-preprocess": "^5.1.3",
     "svelte2tsx": "^0.7.6",
-    "three": "^0.163.0",
+    "three": "^0.166.1",
     "tslib": "^2.6.2",
     "type-fest": "^4.15.0",
-    "typescript": "^5.4.4",
+    "typescript": "^5.4.5",
     "vite": "^5.2.8",
-    "@threlte/core": "8.0.0-next.0"
+    "@threlte/core": "8.0.0-next.17"
   },
   "peerDependencies": {
-    "@dimforge/rapier3d-compat": ">=0.11",
-    "svelte": ">=4",
+    "@dimforge/rapier3d-compat": ">=0.14",
+    "svelte": ">=5",
     "three": ">=0.152"
   },
   "type": "module",
+  "keywords": [
+    "threlte",
+    "rapier",
+    "svelte",
+    "three",
+    "three.js",
+    "3d",
+    "physics"
+  ],
+  "homepage": "https://threlte.xyz",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/threlte/threlte.git",
+    "directory": "packages/rapier"
+  },
+  "bugs": {
+    "url": "https://github.com/threlte/threlte/issues"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -54,8 +73,8 @@
     "package": "svelte-kit sync && svelte-package && node ./scripts/cleanupPackage.js && publint",
     "check": "svelte-check --tsconfig ./tsconfig.json",
     "check:watch": "svelte-check --tsconfig ./tsconfig.json --watch",
-    "lint": "prettier --check --plugin-search-dir=. . && eslint .",
-    "format": "prettier --write --plugin-search-dir=. .",
+    "lint": "prettier --check .",
+    "format": "prettier --write .",
     "cleanup": "rimraf node_modules .svelte-kit dist"
   }
 }

package/dist/hooks/useFixedJoint.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="svelte" />
-import type { FixedImpulseJoint } from '@dimforge/rapier3d-compat';
-import { Euler } from 'three';
-export declare const useFixedJoint: (anchorA: [x: number, y: number, z: number], frameA: Parameters<Euler['set']> | Euler, anchorB: [x: number, y: number, z: number], frameB: Parameters<Euler['set']> | Euler) => {
-    joint: import("svelte/store").Writable<FixedImpulseJoint>;
-    rigidBodyA: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-    rigidBodyB: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-};

package/dist/hooks/useFrameHandler.d.ts

@@ -1,3 +0,0 @@
-import { type Stage, type Key } from '@threlte/core';
-import type { RapierContext } from '../types/types';
-export declare const useFrameHandler: (ctx: RapierContext, stage?: Stage | Key) => void;

package/dist/hooks/useHasEventListener.d.ts

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

package/dist/hooks/useHasEventListener.js

@@ -1,11 +0,0 @@
-export const useHasEventListeners = () => {
-    // const component = get_current_component()
-    const hasEventListeners = (type) => {
-        // const callbacks = component.$$.callbacks
-        return true;
-        // return type in callbacks && (callbacks[type] as any[]).length > 0
-    };
-    return {
-        hasEventListeners
-    };
-};

package/dist/hooks/useJoint.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="svelte" />
-import { MultibodyJoint, type ImpulseJoint, type RigidBody } from '@dimforge/rapier3d-compat';
-import type { RapierContext } from '../types/types';
-export declare const useJoint: <T extends ImpulseJoint | MultibodyJoint>(initializeJoint: (rigidBodyA: RigidBody, rigidBodyB: RigidBody, ctx: RapierContext) => T) => {
-    joint: import("svelte/store").Writable<T>;
-    rigidBodyA: import("svelte/store").Writable<RigidBody | undefined>;
-    rigidBodyB: import("svelte/store").Writable<RigidBody | undefined>;
-};

package/dist/hooks/usePrismaticJoint.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="svelte" />
-import type { PrismaticImpulseJoint } from '@dimforge/rapier3d-compat';
-import { Vector3 } from 'three';
-export declare const usePrismaticJoint: (anchorA: Parameters<Vector3['set']> | Vector3, anchorB: Parameters<Vector3['set']> | Vector3, axis: Parameters<Vector3['set']> | Vector3, limits?: [min: number, max: number]) => {
-    joint: import("svelte/store").Writable<PrismaticImpulseJoint>;
-    rigidBodyA: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-    rigidBodyB: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-};

package/dist/hooks/useRevoluteJoint.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="svelte" />
-import type { RevoluteImpulseJoint } from '@dimforge/rapier3d-compat';
-import { Vector3 } from 'three';
-export declare const useRevoluteJoint: (anchorA: Parameters<Vector3['set']> | Vector3, anchorB: Parameters<Vector3['set']> | Vector3, axis: Parameters<Vector3['set']> | Vector3, limits?: [min: number, max: number]) => {
-    joint: import("svelte/store").Writable<RevoluteImpulseJoint>;
-    rigidBodyA: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-    rigidBodyB: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-};

package/dist/hooks/useSphericalJoint.d.ts

@@ -1,8 +0,0 @@
-/// <reference types="svelte" />
-import type { SphericalImpulseJoint } from '@dimforge/rapier3d-compat';
-import { Vector3 } from 'three';
-export declare const useSphericalJoint: (anchorA: Parameters<Vector3['set']> | Vector3, anchorB: Parameters<Vector3['set']> | Vector3) => {
-    joint: import("svelte/store").Writable<SphericalImpulseJoint>;
-    rigidBodyA: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-    rigidBodyB: import("svelte/store").Writable<import("@dimforge/rapier3d-compat").RigidBody | undefined>;
-};