@threlte/rapier 0.4.0 → 0.5.0

package/dist/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @threlte/extras
 
+## 0.5.0
+
+### Minor Changes
+
+- d69391a: Add Attractor component and documentation
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/components/Attractor/Attractor.svelte

@@ -0,0 +1,50 @@
+<script>import { Mesh, useFrame, Object3DInstance } from '@threlte/core';
+import { SphereBufferGeometry, MeshBasicMaterial, Vector3, Object3D } 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();
+const calcForceByType = {
+    static: (s, m2, r, d, G) => s,
+    linear: (s, m2, r, d, G) => s * (d / r),
+    newtonian: (s, m2, r, d, G) => (G * s * m2) / Math.pow(d, 2)
+};
+function applyImpulseToBodiesInRange() {
+    const impulseVector = new Vector3();
+    obj.getWorldPosition(gravitySource);
+    world.forEachRigidBody((body) => {
+        const { x, y, z } = body.translation();
+        const bodyV3 = new Vector3(x, y, z);
+        const distance = gravitySource.distanceTo(bodyV3);
+        if (distance < range) {
+            let force = calcForceByType[gravityType](strength, body.mass(), range, distance, gravitationalConstant);
+            // Prevent wild forces when Attractors collide
+            force = force === Infinity ? strength : force;
+            impulseVector.subVectors(gravitySource, bodyV3).normalize().multiplyScalar(force);
+            body.applyImpulse(impulseVector, true);
+        }
+    });
+}
+useFrame(() => {
+    applyImpulseToBodiesInRange();
+});
+</script>
+
+<Object3DInstance
+  bind:object={obj}
+  {position}
+>
+  <slot />
+
+  {#if $debug}
+    <Mesh
+      geometry={new SphereBufferGeometry(range)}
+      material={new MeshBasicMaterial({ wireframe: true, transparent: true, opacity: 0.25 })}
+    />
+  {/if}
+</Object3DInstance>

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

@@ -0,0 +1,23 @@
+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> {
+}
+export {};

package/dist/components/Debug/Debug.svelte

@@ -1,5 +1,5 @@
 <script>import { LineSegments, useFrame } from '@threlte/core';
-import { onDestroy } from 'svelte';
+import { onDestroy, } from 'svelte';
 import { BufferAttribute, BufferGeometry, LineBasicMaterial } from 'three';
 import { useRapier } from '../../hooks/useRapier';
 export let vertexColors = true;
@@ -7,13 +7,14 @@ const material = new LineBasicMaterial({
     vertexColors,
     ...$$props
 });
-const { world } = useRapier();
+const { world, debug } = useRapier();
 const buffers = world.debugRender();
 const vertices = new BufferAttribute(buffers.vertices, 3);
 const colors = new BufferAttribute(buffers.colors, 4);
 const geometry = new BufferGeometry();
 geometry.setAttribute('position', vertices);
 geometry.setAttribute('color', colors);
+debug.set(true);
 useFrame(() => {
     const buffers = world.debugRender();
     const vertices = new BufferAttribute(buffers.vertices, 3);
@@ -24,6 +25,7 @@ useFrame(() => {
 onDestroy(() => {
     geometry.dispose();
     material.dispose();
+    debug.set(false);
 });
 </script>
 

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export { default as Debug } from './components/Debug/Debug.svelte';
 export { default as Collider } from './components/Colliders/Collider.svelte';
 export { default as AutoColliders } from './components/Colliders/AutoColliders.svelte';
 export { default as CollisionGroups } from './components/CollisionGroups/CollisionGroups.svelte';
+export { default as Attractor } from './components/Attractor/Attractor.svelte';
 export { default as BasicPlayerController } from './recipes/BasicPlayerController.svelte';
-export type { AutoCollidersProperties, Boolean3Array, RigidBodyProperties, WorldProperties } from './types/components';
+export type { AutoCollidersProperties, Boolean3Array, RigidBodyProperties, WorldProperties, AttractorProperties } from './types/components';
 export type { CollisionGroupsBitMask, AutoCollidersShapes, ColliderEventDispatcher, ColliderShapes, RapierContext, RigidBodyEventDispatcher, CollisionEnterEvent, CollisionExitEvent, SensorEnterEvent, SensorExitEvent, ContactEvent } from './types/types';

package/dist/index.js

@@ -15,5 +15,6 @@ export { default as Debug } from './components/Debug/Debug.svelte';
 export { default as Collider } from './components/Colliders/Collider.svelte';
 export { default as AutoColliders } from './components/Colliders/AutoColliders.svelte';
 export { default as CollisionGroups } from './components/CollisionGroups/CollisionGroups.svelte';
+export { default as Attractor } from './components/Attractor/Attractor.svelte';
 // recipes
 export { default as BasicPlayerController } from './recipes/BasicPlayerController.svelte';

package/dist/lib/createRapierContext.d.ts

@@ -13,4 +13,5 @@ export declare const createRapierContext: (gravity: RAPIER.Vector, rawIntegratio
     removeColliderFromContext: (collider: Collider) => void;
     addRigidBodyToContext: (rigidBody: RigidBody, object: Object3D, eventDispatcher: RigidBodyEventDispatcher) => void;
     removeRigidBodyFromContext: (rigidBody: RigidBody) => void;
+    debug: import("svelte/store").Writable<boolean>;
 };

package/dist/lib/createRapierContext.js

@@ -1,4 +1,5 @@
 import RAPIER from '@dimforge/rapier3d-compat';
+import { writable } from 'svelte/store';
 export const createRapierContext = (...args) => {
     const world = new RAPIER.World(...args);
     const colliderObjects = new Map();
@@ -51,6 +52,7 @@ export const createRapierContext = (...args) => {
         addColliderToContext,
         removeColliderFromContext,
         addRigidBodyToContext,
-        removeRigidBodyFromContext
+        removeRigidBodyFromContext,
+        debug: writable(false),
     };
 };

package/dist/types/components.d.ts

@@ -5,6 +5,7 @@ import type { RigidBodyTypeString } from '../lib/parseRigidBodyType';
 import type { AutoCollidersShapes, ColliderShapes, CollisionGroupsBitMask } from './types';
 export declare type Boolean3Array = [x: boolean, y: boolean, z: boolean];
 export declare type Vector3Array = [x: number, y: number, z: number];
+export declare type GravityType = 'static' | 'linear' | 'newtonian';
 export declare type RigidBodyProperties = Omit<TransformableObjectProperties, 'object'> & {
     /**
      * Specify the type of this rigid body
@@ -144,3 +145,30 @@ export declare type CollisionGroupsProperties = {
     filter: CollisionGroupsBitMask;
     memberships: CollisionGroupsBitMask;
 };
+export declare type AttractorProperties = Omit<TransformableObjectProperties, 'object'> & {
+    /**
+     * The radius for the Attractor's sphere of influence within which rigid-bodies will be affected.
+     * Default: 10.0
+     */
+    range?: number;
+    /**
+     * The strength factor applied to the impulse affecting rigid-bodies within range. For newtonian
+     * calculations, strength is treated as m1 mass.
+     * Default: 1.0
+     */
+    strength?: number;
+    /**
+     * The method of calculating gravity on rigid bodies within range.
+     * 'static' = the same force (strength) is applied on bodies within range, regardless of distance
+     * 'linear' = force is calculated as strength * distance / range (force decreases the farther a body is from the attractor position)
+     * 'newtonian' = force is calculated as gravitationalConstant * mass1 * mass2 / Math.pow(distance, 2)
+     * Default: 'static'
+     */
+    gravityType?: GravityType;
+    /**
+     * The gravitational constant used to calculate force in newtonian calculations. Most people probably won't use this,
+     * but it provides an option for more realistic physics simulations.
+     * Default: 6.673e-11
+     */
+    gravitationalConstant?: number;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@threlte/rapier",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "author": "Grischa Erbe <hello@legrisch.com> (https://legrisch.com)",
   "license": "MIT",
   "devDependencies": {