@react-three/rapier 0.13.2 → 0.14.0-rc.0

package/dist/declarations/src/components/Attractor.d.ts

@@ -12,13 +12,13 @@ export interface AttractorProps {
      * The strength of the attractor.
      * Positive values attract, negative values repel.
      *
-     * @default 1
+     * @defaultValue 1
      */
     strength?: number;
     /**
      * The range of the attractor. Will not affect objects outside of this range.
      *
-     * @default 10
+     * @defaultValue 10
      * @min 0
      */
     range?: number;
@@ -27,12 +27,12 @@ export interface AttractorProps {
      * - static: The gravity is constant and does not change over time.
      * - linear: The gravity is linearly interpolated the closer the object is to the attractor.
      * - newtonian: The gravity is calculated using the newtonian gravity formula.
-     * @default "static"
+     * @defaultValue "static"
      */
     type?: AttractorGravityType;
     /**
      * The mass of the attractor. Used when type is `newtonian`.
-     * @default 6.673e-11
+     * @defaultValue 6.673e-11
      */
     gravitationalConstant?: number;
     /**

package/dist/declarations/src/components/Physics.d.ts

@@ -140,18 +140,11 @@ export interface PhysicsProps {
      * @defaultValue false
      */
     paused?: boolean;
-    /**
-     * The update priority at which the physics simulation should run.
-     *
-     * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#taking-over-the-render-loop
-     * @defaultValue undefined
-     */
-    updatePriority?: number;
     /**
      * Interpolate the world transform using the frame delta times.
      * Has no effect if timeStep is set to "vary".
      *
-     * @default true
+     * @defaultValue true
      **/
     interpolate?: boolean;
 }

package/dist/declarations/src/types.d.ts

@@ -228,31 +228,41 @@ export interface RigidBodyOptions extends ColliderProps {
      * Specify the type of this rigid body
      */
     type?: RigidBodyTypeString;
-    /** Whether or not this body can sleep.
-     * default: true
+    /**
+     * Whether or not this body can sleep.
+     * @defaultValue true
      */
     canSleep?: boolean;
     /** The linear damping coefficient of this rigid-body.*/
     linearDamping?: number;
     /** The angular damping coefficient of this rigid-body.*/
     angularDamping?: number;
-    /** The initial linear velocity of this body.
-     * default: zero velocity
+    /**
+     * The initial linear velocity of this body.
+     * @defaultValue [0,0,0]
      */
     linearVelocity?: Vector3Array;
-    /** The initial angular velocity of this body.
-     * Default: zero velocity.
+    /**
+     * The initial angular velocity of this body.
+     * @defaultValue [0,0,0]
      */
     angularVelocity?: Vector3Array;
     /**
      * The scaling factor applied to the gravity affecting the rigid-body.
-     * Default: 1.0
+     * @defaultValue 1.0
      */
     gravityScale?: number;
+    /**
+     * The dominance group of this RigidBody. If a rigid body has a higher domiance group,
+     * on collision it will be immune to forces originating from the other bodies.
+     * https://rapier.rs/docs/user_guides/javascript/rigid_bodies#dominance
+     * Default: 0
+     */
+    dominanceGroup?: number;
     /**
      * Whether or not Continous Collision Detection is enabled for this rigid-body.
      * https://rapier.rs/docs/user_guides/javascript/rigid_bodies#continuous-collision-detection
-     * @default false
+     * @defaultValue false
      */
     ccd?: boolean;
     /**
@@ -308,7 +318,7 @@ export interface RigidBodyOptions extends ColliderProps {
      */
     enabledRotations?: Boolean3Array;
     /**
-     * Allow rotation of this rigid-body only along specific axes.
+     * Allow translation of this rigid-body only along specific axes.
      */
     enabledTranslations?: Boolean3Array;
     /**

package/dist/declarations/src/utils/utils-physics.d.ts

@@ -0,0 +1 @@
+export declare const useRaf: (callback: (dt: number) => void) => void;

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

@@ -178,6 +178,27 @@ function useConst(initialValue) {
   return ref.current.value;
 }
 
+const useRaf = callback => {
+  const cb = React.useRef(callback);
+  const raf = React.useRef(0);
+  const lastFrame = React.useRef(0);
+  React.useEffect(() => {
+    cb.current = callback;
+  }, [callback]);
+  React.useEffect(() => {
+    const loop = () => {
+      const now = performance.now();
+      const delta = now - lastFrame.current;
+      raf.current = requestAnimationFrame(loop);
+      cb.current(delta / 1000);
+      lastFrame.current = now;
+    };
+
+    raf.current = requestAnimationFrame(loop);
+    return () => cancelAnimationFrame(raf.current);
+  }, []);
+};
+
 const scaleColliderArgs = (shape, args, scale) => {
   const newArgs = args.slice(); // Heightfield uses a vector
 
@@ -675,10 +696,12 @@ const Physics = ({
   children,
   timeStep: _timeStep = 1 / 60,
   paused: _paused = false,
-  updatePriority,
   interpolate: _interpolate = true
 }) => {
   const rapier = useAsset.useAsset(importRapier);
+  const {
+    invalidate
+  } = fiber.useThree();
   const worldRef = React.useRef();
   const getWorldRef = React.useRef(() => {
     if (!worldRef.current) {
@@ -959,10 +982,13 @@ const Physics = ({
         maxForceMagnitude: event.maxForceMagnitude()
       }));
     });
+    world.forEachActiveRigidBody(body => {
+      invalidate();
+    });
   }, [_paused, _timeStep, _interpolate]);
-  fiber.useFrame((_, dt) => {
+  useRaf(dt => {
     if (!_paused) step(dt);
-  }, updatePriority);
+  });
   const context = React.useMemo(() => ({
     rapier,
     world: api,
@@ -1312,6 +1338,9 @@ const mutableRigidBodyOptions = {
   angularDamping: (rb, value) => {
     rb.setAngularDamping(value);
   },
+  dominanceGroup: (rb, value) => {
+    rb.setDominanceGroup(value);
+  },
   enabledRotations: (rb, [x, y, z]) => {
     rb.setEnabledRotations(x, y, z, true);
   },

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

@@ -178,6 +178,27 @@ function useConst(initialValue) {
   return ref.current.value;
 }
 
+const useRaf = callback => {
+  const cb = React.useRef(callback);
+  const raf = React.useRef(0);
+  const lastFrame = React.useRef(0);
+  React.useEffect(() => {
+    cb.current = callback;
+  }, [callback]);
+  React.useEffect(() => {
+    const loop = () => {
+      const now = performance.now();
+      const delta = now - lastFrame.current;
+      raf.current = requestAnimationFrame(loop);
+      cb.current(delta / 1000);
+      lastFrame.current = now;
+    };
+
+    raf.current = requestAnimationFrame(loop);
+    return () => cancelAnimationFrame(raf.current);
+  }, []);
+};
+
 const scaleColliderArgs = (shape, args, scale) => {
   const newArgs = args.slice(); // Heightfield uses a vector
 
@@ -675,10 +696,12 @@ const Physics = ({
   children,
   timeStep: _timeStep = 1 / 60,
   paused: _paused = false,
-  updatePriority,
   interpolate: _interpolate = true
 }) => {
   const rapier = useAsset.useAsset(importRapier);
+  const {
+    invalidate
+  } = fiber.useThree();
   const worldRef = React.useRef();
   const getWorldRef = React.useRef(() => {
     if (!worldRef.current) {
@@ -959,10 +982,13 @@ const Physics = ({
         maxForceMagnitude: event.maxForceMagnitude()
       }));
     });
+    world.forEachActiveRigidBody(body => {
+      invalidate();
+    });
   }, [_paused, _timeStep, _interpolate]);
-  fiber.useFrame((_, dt) => {
+  useRaf(dt => {
     if (!_paused) step(dt);
-  }, updatePriority);
+  });
   const context = React.useMemo(() => ({
     rapier,
     world: api,
@@ -1312,6 +1338,9 @@ const mutableRigidBodyOptions = {
   angularDamping: (rb, value) => {
     rb.setAngularDamping(value);
   },
+  dominanceGroup: (rb, value) => {
+    rb.setDominanceGroup(value);
+  },
   enabledRotations: (rb, [x, y, z]) => {
     rb.setEnabledRotations(x, y, z, true);
   },

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

@@ -1,7 +1,7 @@
 import { ActiveEvents, ColliderDesc, EventQueue, RigidBodyDesc } from '@dimforge/rapier3d-compat';
 export { CoefficientCombineRule, Collider as RapierCollider, RigidBody as RapierRigidBody } from '@dimforge/rapier3d-compat';
-import { useFrame, useThree } from '@react-three/fiber';
-import React, { useRef, useMemo, useEffect, useContext, useState, memo, createContext, useCallback, forwardRef, useImperativeHandle, Fragment } from 'react';
+import { useThree, useFrame } from '@react-three/fiber';
+import React, { useRef, useEffect, useMemo, useContext, useState, memo, createContext, useCallback, forwardRef, useImperativeHandle, Fragment } from 'react';
 import { Quaternion, Euler, Vector3, Object3D, Matrix4, MathUtils, BufferAttribute, DynamicDrawUsage } from 'three';
 import { useAsset } from 'use-asset';
 import { mergeVertices, VertexNormalsHelper } from 'three-stdlib';
@@ -153,6 +153,27 @@ function useConst(initialValue) {
   return ref.current.value;
 }
 
+const useRaf = callback => {
+  const cb = useRef(callback);
+  const raf = useRef(0);
+  const lastFrame = useRef(0);
+  useEffect(() => {
+    cb.current = callback;
+  }, [callback]);
+  useEffect(() => {
+    const loop = () => {
+      const now = performance.now();
+      const delta = now - lastFrame.current;
+      raf.current = requestAnimationFrame(loop);
+      cb.current(delta / 1000);
+      lastFrame.current = now;
+    };
+
+    raf.current = requestAnimationFrame(loop);
+    return () => cancelAnimationFrame(raf.current);
+  }, []);
+};
+
 const scaleColliderArgs = (shape, args, scale) => {
   const newArgs = args.slice(); // Heightfield uses a vector
 
@@ -650,10 +671,12 @@ const Physics = ({
   children,
   timeStep: _timeStep = 1 / 60,
   paused: _paused = false,
-  updatePriority,
   interpolate: _interpolate = true
 }) => {
   const rapier = useAsset(importRapier);
+  const {
+    invalidate
+  } = useThree();
   const worldRef = useRef();
   const getWorldRef = useRef(() => {
     if (!worldRef.current) {
@@ -934,10 +957,13 @@ const Physics = ({
         maxForceMagnitude: event.maxForceMagnitude()
       }));
     });
+    world.forEachActiveRigidBody(body => {
+      invalidate();
+    });
   }, [_paused, _timeStep, _interpolate]);
-  useFrame((_, dt) => {
+  useRaf(dt => {
     if (!_paused) step(dt);
-  }, updatePriority);
+  });
   const context = useMemo(() => ({
     rapier,
     world: api,
@@ -1287,6 +1313,9 @@ const mutableRigidBodyOptions = {
   angularDamping: (rb, value) => {
     rb.setAngularDamping(value);
   },
+  dominanceGroup: (rb, value) => {
+    rb.setDominanceGroup(value);
+  },
   enabledRotations: (rb, [x, y, z]) => {
     rb.setEnabledRotations(x, y, z, true);
   },

package/package.json

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

package/readme.md

@@ -84,6 +84,7 @@ For full API outline and documentation, see 🧩 [API Docs](https://pmndrs.githu
   - [🖼 Joints Example](#-joints-example)
 - [Advanced hooks usage](#advanced-hooks-usage)
   - [Manual stepping](#manual-stepping)
+  - [On-demand rendering](#on-demand-rendering)
 
 ---
 
@@ -131,7 +132,7 @@ Supported values:
 
 - `"cuboid"`, creates a CuboidCollider based on the bounding box of the mesh
 - `"ball"`, creates a SphereCollider based on the bounding sphere of the mesh
-- `"trimesh"`, creates a TrimeshCollider based on the mesh's geometry -- note trimeshes are massless by default (https://rapier.rs/docs/user_guides/javascript/common_mistakes#rigid-body-isnt-affected-by-gravity)
+- `"trimesh"`, creates a TrimeshCollider based on the mesh's geometry
 - `"hull"`, creates a ConvexHullCollider based on the mesh's geometry
 - `false`, disables auto-generation
 
@@ -758,7 +759,7 @@ const JointedThing = () => {
     [
       [0, 0, 0], // Position of the joint in bodyA's local space    
       [0, 0, 0], // Position of the joint in bodyB's local space
-      [0, 0, 0], // Axis of the joint, expressed in the local-space of the rigid-bodies it is attached to.
+      [0, 1, 0], // Axis of the joint, expressed in the local-space of the rigid-bodies it is attached to. Cannot be [0,0,0].
     ]);
 
   useEffect(() => {
@@ -793,7 +794,7 @@ const JointedThing = () => {
     [
       [0, 0, 0], // Position of the joint in bodyA's local space    
       [0, 0, 0], // Position of the joint in bodyB's local space
-      [0, 0, 0], // Axis of the joint, expressed in the local-space of the rigid-bodies it is attached to.
+      [0, 1, 0], // Axis of the joint, expressed in the local-space of the rigid-bodies it is attached to. Cannot be [0,0,0].
     ]);
 
   return (
@@ -834,4 +835,7 @@ You can manually step the physics simulation by calling the `step` method from t
 const { step } = useRapier();
 
 step(1 / 60);
-```
+```
+
+### On-demand rendering
+`@react-three/rapier` runs the physics simulation independently from the render loop, and will tell `@react-three/fiber` to render if the scene has active (non-sleeping) RigidBodies. This allows you to use the `<Canvas frameloop="demand" />` (https://docs.pmnd.rs/react-three-fiber/advanced/scaling-performance#on-demand-rendering) strategy to only render the scene when needed.