@threlte/rapier 0.5.0 → 1.0.0-next.1

package/dist/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @threlte/extras
 
+## 1.0.0-next.1
+
+### Major Changes
+
+- 4b67b473: Removed transform properties on rapier components Collider, AutoColliders and RigidBody
+
+## 1.0.0-next.0
+
+### Major Changes
+
+- d41cb6cf: Adapted rapier package to Threlte v6 syntax
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/components/Attractor/Attractor.svelte

@@ -1,14 +1,13 @@
-<script>import { Mesh, useFrame, Object3DInstance } from '@threlte/core';
-import { SphereBufferGeometry, MeshBasicMaterial, Vector3, Object3D } from 'three';
+<script>import { T, useFrame } from '@threlte/core';
+import { Group, Vector3 } from 'three';
 import { useRapier } from '../../hooks/useRapier';
-export let position = undefined;
 export let strength = 1;
 export let range = 50;
 export let gravityType = 'static';
 export let gravitationalConstant = 6.673e-11;
 const { world, debug } = useRapier();
 const gravitySource = new Vector3();
-let obj = new Object3D();
+let obj = new Group();
 const calcForceByType = {
     static: (s, m2, r, d, G) => s,
     linear: (s, m2, r, d, G) => s * (d / r),
@@ -35,16 +34,21 @@ useFrame(() => {
 });
 </script>
 
-<Object3DInstance
-  bind:object={obj}
-  {position}
+<T
+  let:ref
+  is={obj}
+  {...$$restProps}
 >
-  <slot />
+  <slot {ref} />
 
   {#if $debug}
-    <Mesh
-      geometry={new SphereBufferGeometry(range)}
-      material={new MeshBasicMaterial({ wireframe: true, transparent: true, opacity: 0.25 })}
-    />
+    <T.Mesh>
+      <T.SphereGeometry args={[range]} />
+      <T.MeshBasicMaterial
+        wireframe
+        transparent
+        opacity={0.25}
+      />
+    </T.Mesh>
   {/if}
-</Object3DInstance>
+</T>

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

@@ -1,23 +1,21 @@
-import { SvelteComponentTyped } from "svelte";
-import type { AttractorProperties } from '../../types/components';
-declare const __propDef: {
-    props: {
-        position?: AttractorProperties['position'];
-        strength?: number | undefined;
-        range?: number | undefined;
-        gravityType?: import("../../types/components").GravityType | undefined;
-        gravitationalConstant?: number | undefined;
-    };
-    events: {
-        [evt: string]: CustomEvent<any>;
-    };
-    slots: {
-        default: {};
-    };
-};
-export declare type AttractorProps = typeof __propDef.props;
-export declare type AttractorEvents = typeof __propDef.events;
-export declare type AttractorSlots = typeof __propDef.slots;
-export default class Attractor extends SvelteComponentTyped<AttractorProps, AttractorEvents, AttractorSlots> {
+import { SvelteComponentTyped } from 'svelte'
+import type { AttractorProperties } from '../../types/components'
+import { Props, type Events, type Slots } from '@threlte/core'
+import type { Group } from 'three'
+
+type AttractorProps = Props<Group> & {
+  strength?: NonNullable<AttractorProperties['strength']>
+  range?: NonNullable<AttractorProperties['range']>
+  gravityType?: NonNullable<AttractorProperties['gravityType']>
+  gravitationalConstant?: NonNullable<AttractorProperties['gravitationalConstant']>
 }
-export {};
+
+type AttractorEvents = Events<Group>
+
+type AttractorSlots = Slots<Group>
+
+export default class Attractor extends SvelteComponentTyped<
+  AttractorProps,
+  AttractorEvents,
+  AttractorSlots
+> {}

package/dist/components/Colliders/AutoColliders.svelte

@@ -1,21 +1,15 @@
-<script>import { ActiveCollisionTypes, ActiveEvents, CoefficientCombineRule } from '@dimforge/rapier3d-compat';
-import { SceneGraphObject } from '@threlte/core';
-import { createEventDispatcher, onDestroy, onMount } from 'svelte';
-import { Object3D } from 'three';
+<script>import { ActiveCollisionTypes, CoefficientCombineRule } from '@dimforge/rapier3d-compat';
+import { createRawEventDispatcher, SceneGraphObject } from '@threlte/core';
+import { onDestroy, onMount } from 'svelte';
+import { Group } 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';
-import { rotationToQuaternion } from '../../lib/rotationToQuaternion';
+import { eulerToQuaternion } from '../../lib/eulerToQuaternion';
 export let shape = 'convexHull';
-export let position = undefined;
-export let rotation = undefined;
-export let scale = undefined;
-export let lookAt = undefined;
 export let restitution = undefined;
 export let restitutionCombineRule = undefined;
 export let friction = undefined;
@@ -24,56 +18,64 @@ export let sensor = undefined;
 export let contactForceEventThreshold = undefined;
 export let density = undefined;
 export let mass = undefined;
-export let massProperties = undefined;
-const object = new Object3D();
-/**
- * Immediately apply transforms
- */
-applyTransforms(object, position, rotation, scale, lookAt);
-object.updateWorldMatrix(true, false);
+export let centerOfMass = undefined;
+export let principalAngularInertia = undefined;
+export let angularInertiaLocalFrame = undefined;
+const group = new Group();
 const rigidBody = useRigidBody();
 const { world, addColliderToContext, removeColliderFromContext } = useRapier();
 export let colliders = [];
 const collisionGroups = useCollisionGroups();
-const dispatcher = createEventDispatcher();
+const dispatcher = createRawEventDispatcher();
 const { hasEventListeners: colliderHasEventListeners } = useHasEventListeners();
-onMount(() => {
-    colliders = createCollidersFromChildren(object, shape ?? 'convexHull', world, rigidBody);
-    colliders.forEach((c) => addColliderToContext(c, object, dispatcher));
-    collisionGroups.registerColliders(colliders);
-});
-$: {
-    if (colliders.length > 0) {
-        colliders.forEach((collider) => {
-            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)
-                collider.setMass(mass);
-            if (massProperties)
-                collider.setMassProperties(massProperties.mass, positionToVector3(massProperties.centerOfMass), positionToVector3(massProperties.principalAngularInertia), rotationToQuaternion(massProperties.angularInertiaLocalFrame));
-        });
-    }
-}
-/**
- * Cleanup
- */
-onDestroy(() => {
+const cleanup = () => {
     collisionGroups.removeColliders(colliders);
     colliders.forEach((c) => {
         removeColliderFromContext(c);
         world.removeCollider(c, true);
     });
+    colliders.length = 0;
+};
+export const create = () => {
+    cleanup();
+    colliders = createCollidersFromChildren(group, shape ?? 'convexHull', world, rigidBody);
+    colliders.forEach((c) => addColliderToContext(c, group, dispatcher));
+    collisionGroups.registerColliders(colliders);
+    colliders.forEach((collider) => {
+        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) {
+            if (centerOfMass && principalAngularInertia && angularInertiaLocalFrame)
+                collider.setMassProperties(mass, { x: centerOfMass[0], y: centerOfMass[1], z: centerOfMass[2] }, {
+                    x: principalAngularInertia[0],
+                    y: principalAngularInertia[1],
+                    z: principalAngularInertia[2]
+                }, eulerToQuaternion(angularInertiaLocalFrame));
+            else
+                collider.setMass(mass);
+        }
+    });
+};
+onMount(() => {
+    create();
 });
+export const refresh = () => {
+    create();
+};
+/**
+ * Cleanup
+ */
+onDestroy(cleanup);
 </script>
 
-<SceneGraphObject {object}>
-  <slot />
+<SceneGraphObject object={group}>
+  <slot {colliders} {refresh} />
 </SceneGraphObject>

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

@@ -0,0 +1,80 @@
+import type { CoefficientCombineRule, Collider } from '@dimforge/rapier3d-compat'
+import { SvelteComponentTyped } from 'svelte'
+import type { Euler, Vector3 } from 'three'
+import type { AutoCollidersShapes, ColliderEventMap } from '../../types/types'
+
+// ------------------ BASE ------------------
+
+type BaseProps = {
+  shape?: AutoCollidersShapes
+  restitution?: number
+  restitutionCombineRule?: CoefficientCombineRule
+  friction?: number
+  frictionCombineRule?: CoefficientCombineRule
+  sensor?: boolean
+  colliders?: Collider[]
+  contactForceEventThreshold?: number
+  refresh?: () => void
+}
+
+// ------------------ MASS ------------------
+
+type Density = {
+  density: number
+
+  mass?: never
+  centerOfMass?: never
+  principalAngularInertia?: never
+  angularInertiaLocalFrame?: never
+}
+
+type Mass = {
+  mass: number
+  density?: never
+  centerOfMass?: never
+  principalAngularInertia?: never
+  angularInertiaLocalFrame?: never
+}
+
+type MassProperties = {
+  mass: number
+  centerOfMass: Parameters<Vector3['set']>
+  principalAngularInertia: Parameters<Vector3['set']>
+  angularInertiaLocalFrame: Parameters<Euler['set']>
+  density?: never
+}
+
+type NoMassProperties = {
+  density?: never
+  mass?: never
+  centerOfMass?: never
+  principalAngularInertia?: never
+  angularInertiaLocalFrame?: never
+}
+
+export type MassDef = Density | Mass | MassProperties | NoMassProperties
+
+type MassProps<TMassDef extends MassDef> = TMassDef extends Density
+  ? Density
+  : TMassDef extends MassProperties
+  ? MassProperties
+  : TMassDef extends Mass
+  ? Mass
+  : NoMassProperties
+
+// ------------------ COLLIDER ------------------
+
+export type AutoCollidersProps<TMassDef extends MassDef> = BaseProps & MassProps<TMassDef>
+
+type AutoCollidersSlots = {
+  default: {
+    colliders: Collider[]
+    refresh: () => void
+  }
+}
+
+export default class AutoColliders<TMassDef extends MassDef> extends SvelteComponentTyped<
+  AutoCollidersProps<TMassDef>,
+  ColliderEventMap,
+  AutoCollidersSlots
+> {}

package/dist/components/Colliders/Collider.svelte

@@ -1,23 +1,18 @@
-<script>import { ActiveCollisionTypes, ActiveEvents, CoefficientCombineRule, Collider, ColliderDesc } from '@dimforge/rapier3d-compat';
-import { SceneGraphObject, TransformableObject, useFrame } from '@threlte/core';
-import { createEventDispatcher, onDestroy, onMount, tick } from 'svelte';
+<script>import { ActiveCollisionTypes, CoefficientCombineRule, Collider, ColliderDesc } from '@dimforge/rapier3d-compat';
+import { createRawEventDispatcher, SceneGraphObject, useFrame } from '@threlte/core';
+import { 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 { eulerToQuaternion } from '../../lib/eulerToQuaternion';
 import { getWorldPosition, getWorldQuaternion } from '../../lib/getWorldTransforms';
-import { positionToVector3 } from '../../lib/positionToVector3';
-import { rotationToQuaternion } from '../../lib/rotationToQuaternion';
 import { scaleColliderArgs } from '../../lib/scaleColliderArgs';
 export let shape;
 export let args;
-export let position = undefined;
-export let rotation = undefined;
-export let scale = undefined;
-export let lookAt = undefined;
+export let type = undefined;
 export let restitution = undefined;
 export let restitutionCombineRule = undefined;
 export let friction = undefined;
@@ -26,20 +21,17 @@ export let sensor = undefined;
 export let contactForceEventThreshold = undefined;
 export let density = undefined;
 export let mass = undefined;
-export let massProperties = undefined;
+export let centerOfMass = undefined;
+export let principalAngularInertia = undefined;
+export let angularInertiaLocalFrame = undefined;
 const object = new Object3D();
-/**
- * Immediately apply transforms
- */
-applyTransforms(object, position, rotation, scale, lookAt);
-object.updateWorldMatrix(true, false);
 const rigidBody = useRigidBody();
-const isAttached = !!rigidBody;
+const hasRigidBodyParent = !!rigidBody;
 const rapierContext = useRapier();
 const { world } = rapierContext;
 export let collider = undefined;
 const collisionGroups = useCollisionGroups();
-const dispatcher = createEventDispatcher();
+const dispatcher = createRawEventDispatcher();
 /**
  * Actual collider setup happens onMount as only then
  * the transforms are finished.
@@ -59,7 +51,7 @@ onMount(async () => {
      * For use in conjunction with component <CollisionGroups>
      */
     collisionGroups.registerColliders([collider]);
-    if (isAttached) {
+    if (hasRigidBodyParent) {
         const rigidBodyWorldPos = new Vector3();
         const rigidBodyWorldQuatInversed = new Quaternion();
         object.traverseAncestors((child) => {
@@ -95,20 +87,41 @@ $: {
         collider.setContactForceEventThreshold(contactForceEventThreshold ?? 0);
         if (density)
             collider.setDensity(density);
-        if (mass)
-            collider.setMass(mass);
-        if (massProperties)
-            collider.setMassProperties(massProperties.mass, positionToVector3(massProperties.centerOfMass), positionToVector3(massProperties.principalAngularInertia), rotationToQuaternion(massProperties.angularInertiaLocalFrame));
+        if (mass) {
+            if (centerOfMass && principalAngularInertia && angularInertiaLocalFrame) {
+                collider.setMassProperties(mass, { x: centerOfMass[0], y: centerOfMass[1], z: centerOfMass[2] }, {
+                    x: principalAngularInertia[0],
+                    y: principalAngularInertia[1],
+                    z: principalAngularInertia[2]
+                }, eulerToQuaternion(angularInertiaLocalFrame));
+            }
+            else {
+                collider.setMass(mass);
+            }
+        }
     }
 }
-useFrame(() => {
+export const refresh = () => {
     if (!collider)
         return;
     collider.setTranslation(getWorldPosition(object));
     collider.setRotation(getWorldQuaternion(object));
+};
+/**
+ * If the Collider isAttached (i.e. NOT child of a RigidBody), update the
+ * transforms on every frame.
+ */
+const { start, stop } = useFrame(() => {
+    refresh();
 }, {
-    autostart: !isAttached
+    autostart: !hasRigidBodyParent && type === 'dynamic'
 });
+$: {
+    if (!hasRigidBodyParent && type === 'dynamic')
+        start();
+    else
+        stop();
+}
 /**
  * Cleanup
  */
@@ -118,13 +131,10 @@ onDestroy(() => {
     rapierContext.removeColliderFromContext(collider);
     collisionGroups.removeColliders([collider]);
     world.removeCollider(collider, true);
+    collider = undefined;
 });
 </script>
 
 <SceneGraphObject {object}>
-  <slot />
+  <slot {collider} />
 </SceneGraphObject>
-
-{#if !isAttached}
-  <TransformableObject {object} {position} {rotation} {scale} />
-{/if}