@react-three/rapier 1.3.1 → 1.4.0

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

@@ -202,6 +202,15 @@ export interface PhysicsProps {
      * @defaultValue 0.8
      */
     erp?: number;
+    /**
+     * The approximate size of most dynamic objects in the scene.
+     *
+     * This value is used internally to estimate some length-based tolerance.
+     * This value can be understood as the number of units-per-meter in your physical world compared to a human-sized world in meter.
+     *
+     * @defaultValue 1
+     */
+    lengthUnit?: number;
     /**
      * Set the base automatic colliders for this physics world
      * All Meshes inside RigidBodies will generate a collider

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

@@ -1,12 +1,12 @@
 import { MutableRefObject, RefObject } from "react";
-import { CoefficientCombineRule, Collider as RapierCollider, ImpulseJoint, InteractionGroups, RigidBody as RapierRigidBody, TempContactManifold } from "@dimforge/rapier3d-compat";
+import { ActiveCollisionTypes, CoefficientCombineRule, ImpulseJoint, InteractionGroups, Collider as RapierCollider, RigidBody as RapierRigidBody, TempContactManifold } from "@dimforge/rapier3d-compat";
 import { Rotation, Vector } from "@dimforge/rapier3d-compat/math";
-import { Object3DProps, Vector3, Quaternion } from "@react-three/fiber";
+import { Object3DProps, Quaternion, Vector3 } from "@react-three/fiber";
 import { Object3D } from "three";
 import { ColliderProps } from ".";
 import { RigidBodyState } from "./components/Physics";
 export { CoefficientCombineRule as CoefficientCombineRule } from "@dimforge/rapier3d-compat";
-export { RapierRigidBody, RapierCollider };
+export { RapierCollider, RapierRigidBody };
 export declare type RefGetter<T> = MutableRefObject<() => T | undefined>;
 export declare type RigidBodyAutoCollider = "ball" | "cuboid" | "hull" | "trimesh" | false;
 export declare type CuboidArgs = [
@@ -139,7 +139,7 @@ export interface ColliderOptions<ColliderArgs extends Array<unknown>> {
      */
     scale?: Object3DProps["scale"];
     /**
-     * Callback when this collider collides with another collider.
+     * Callback when this collider collideas with another collider.
      */
     onCollisionEnter?: CollisionEnterHandler;
     /**
@@ -166,6 +166,15 @@ export interface ColliderOptions<ColliderArgs extends Array<unknown>> {
      * The bit mask configuring the groups and mask for solver handling.
      */
     solverGroups?: InteractionGroups;
+    /**
+     * The collision types active for this collider.
+     *
+     * Use `ActiveCollisionTypes` to specify which collision types should be active for this collider.
+     *
+     * @see https://rapier.rs/javascript3d/classes/Collider.html#setActiveCollisionTypes
+     * @see https://rapier.rs/javascript3d/enums/ActiveCollisionTypes.html
+     */
+    activeCollisionTypes?: ActiveCollisionTypes;
     /**
      * Sets the uniform density of this collider.
      * If this is set, other mass-properties like the angular inertia tensor are computed
@@ -192,6 +201,18 @@ export interface ColliderOptions<ColliderArgs extends Array<unknown>> {
         principalAngularInertia: Vector;
         angularInertiaLocalFrame: Rotation;
     };
+    /**
+     * The contact skin of the collider.
+     *
+     * The contact skin acts as if the collider was enlarged with a skin of width contactSkin around it, keeping objects further apart when colliding.
+     *
+     * A non-zero contact skin can increase performance, and in some cases, stability.
+     * However it creates a small gap between colliding object (equal to the sum of their skin).
+     * If the skin is sufficiently small, this might not be visually significant or can be hidden by the rendering assets.
+     *
+     * @defaultValue 0
+     */
+    contactSkin?: number;
     /**
      * Sets whether or not this collider is a sensor.
      */
@@ -277,6 +298,20 @@ export interface RigidBodyOptions extends ColliderProps {
      * @defaultValue false
      */
     ccd?: boolean;
+    /**
+     * The maximum prediction distance Soft Continuous Collision-Detection.
+     *
+     * When set to 0, soft-CCD is disabled.
+     *
+     * Soft-CCD helps prevent tunneling especially of slow-but-thin to moderately fast objects.
+     * The soft CCD prediction distance indicates how far in the object’s path the CCD algorithm is allowed to inspect.
+     * Large values can impact performance badly by increasing the work needed from the broad-phase.
+     *
+     * It is a generally cheaper variant of regular CCD since it relies on predictive constraints instead of shape-cast and substeps.
+     *
+     * @defaultValue 0
+     */
+    softCcdPrediction?: number;
     /**
      * Initial position of the RigidBody
      */
@@ -325,6 +360,16 @@ export interface RigidBodyOptions extends ColliderProps {
      * Can be customized per-collider.
      */
     solverGroups?: InteractionGroups;
+    /**
+     * The default active collision types for all colliders in this rigid body.
+     * Can be customized per-collider.
+     *
+     * Use `ActiveCollisionTypes` to specify which collision types should be active for this collider.
+     *
+     * @see https://rapier.rs/javascript3d/classes/Collider.html#setActiveCollisionTypes
+     * @see https://rapier.rs/javascript3d/enums/ActiveCollisionTypes.html
+     */
+    activeCollisionTypes?: ActiveCollisionTypes;
     onSleep?(): void;
     onWake?(): void;
     /**
@@ -357,10 +402,7 @@ export interface RigidBodyOptions extends ColliderProps {
      */
     transformState?: (state: RigidBodyState) => RigidBodyState;
 }
-export declare type SphericalJointParams = [
-    body1Anchor: Vector3,
-    body2Anchor: Vector3
-];
+export declare type SphericalJointParams = [body1Anchor: Vector3, body2Anchor: Vector3];
 export declare type FixedJointParams = [
     body1Anchor: Vector3,
     body1LocalFrame: Quaternion,

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

@@ -50,6 +50,7 @@ export declare const cleanRigidBodyPropsForCollider: (props?: RigidBodyProps) =>
     additionalSolverIterations?: number | undefined;
     collisionGroups?: number | undefined;
     solverGroups?: number | undefined;
+    activeCollisionTypes?: import("@dimforge/rapier3d-compat").ActiveCollisionTypes | undefined;
     onSleep?(): void;
     onWake?(): void;
     lockRotations?: boolean | undefined;
@@ -76,6 +77,7 @@ export declare const cleanRigidBodyPropsForCollider: (props?: RigidBodyProps) =>
         principalAngularInertia: import("@dimforge/rapier3d-compat").Vector;
         angularInertiaLocalFrame: import("@dimforge/rapier3d-compat").Rotation;
     } | undefined;
+    contactSkin?: number | undefined;
     sensor?: boolean | undefined;
 };
 export {};

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

@@ -244,7 +244,7 @@ function _objectWithoutProperties(source, excluded) {
   return target;
 }
 
-const _excluded$2 = ["mass", "linearDamping", "angularDamping", "type", "onCollisionEnter", "onCollisionExit", "onIntersectionEnter", "onIntersectionExit", "onContactForce", "children", "canSleep", "ccd", "gravityScale"];
+const _excluded$2 = ["mass", "linearDamping", "angularDamping", "type", "onCollisionEnter", "onCollisionExit", "onIntersectionEnter", "onIntersectionExit", "onContactForce", "children", "canSleep", "ccd", "gravityScale", "softCcdPrediction"];
 const scaleColliderArgs = (shape, args, scale) => {
   const newArgs = args.slice(); // Heightfield uses a vector
 
@@ -321,6 +321,12 @@ const mutableColliderOptions = {
   restitutionCombineRule: (collider, value) => {
     collider.setRestitutionCombineRule(value);
   },
+  activeCollisionTypes: (collider, value) => {
+    collider.setActiveCollisionTypes(value);
+  },
+  contactSkin: (collider, value) => {
+    collider.setContactSkin(value);
+  },
   // To make sure the options all mutable options are listed
   quaternion: () => {},
   position: () => {},
@@ -762,7 +768,8 @@ const Physics = props => {
     numInternalPgsIterations = 1,
     minIslandSize = 128,
     maxCcdSubsteps = 1,
-    erp = 0.8
+    erp = 0.8,
+    lengthUnit = 1
   } = props;
   const rapier = suspendReact.suspend(importRapier, ["@react-thee/rapier", importRapier]);
   const {
@@ -798,12 +805,13 @@ const Physics = props => {
     worldProxy.integrationParameters.numSolverIterations = numSolverIterations;
     worldProxy.integrationParameters.numAdditionalFrictionIterations = numAdditionalFrictionIterations;
     worldProxy.integrationParameters.numInternalPgsIterations = numInternalPgsIterations;
-    worldProxy.integrationParameters.allowedLinearError = allowedLinearError;
+    worldProxy.integrationParameters.normalizedAllowedLinearError = allowedLinearError;
     worldProxy.integrationParameters.minIslandSize = minIslandSize;
     worldProxy.integrationParameters.maxCcdSubsteps = maxCcdSubsteps;
-    worldProxy.integrationParameters.predictionDistance = predictionDistance;
+    worldProxy.integrationParameters.normalizedPredictionDistance = predictionDistance;
     worldProxy.integrationParameters.erp = erp;
-  }, [worldProxy, ...gravity, numSolverIterations, numAdditionalFrictionIterations, numInternalPgsIterations, allowedLinearError, minIslandSize, maxCcdSubsteps, predictionDistance, erp]);
+    worldProxy.lengthUnit = lengthUnit;
+  }, [worldProxy, ...gravity, numSolverIterations, numAdditionalFrictionIterations, numInternalPgsIterations, allowedLinearError, minIslandSize, maxCcdSubsteps, predictionDistance, erp, lengthUnit]);
   const getSourceFromColliderHandle = React.useCallback(handle => {
     var _collider$parent;
 
@@ -1435,6 +1443,9 @@ const mutableRigidBodyOptions = {
   ccd: (rb, value) => {
     rb.enableCcd(value);
   },
+  softCcdPrediction: (rb, value) => {
+    rb.setSoftCcdPrediction(value);
+  },
   userData: (rb, value) => {
     rb.userData = value;
   },

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

@@ -244,7 +244,7 @@ function _objectWithoutProperties(source, excluded) {
   return target;
 }
 
-const _excluded$2 = ["mass", "linearDamping", "angularDamping", "type", "onCollisionEnter", "onCollisionExit", "onIntersectionEnter", "onIntersectionExit", "onContactForce", "children", "canSleep", "ccd", "gravityScale"];
+const _excluded$2 = ["mass", "linearDamping", "angularDamping", "type", "onCollisionEnter", "onCollisionExit", "onIntersectionEnter", "onIntersectionExit", "onContactForce", "children", "canSleep", "ccd", "gravityScale", "softCcdPrediction"];
 const scaleColliderArgs = (shape, args, scale) => {
   const newArgs = args.slice(); // Heightfield uses a vector
 
@@ -321,6 +321,12 @@ const mutableColliderOptions = {
   restitutionCombineRule: (collider, value) => {
     collider.setRestitutionCombineRule(value);
   },
+  activeCollisionTypes: (collider, value) => {
+    collider.setActiveCollisionTypes(value);
+  },
+  contactSkin: (collider, value) => {
+    collider.setContactSkin(value);
+  },
   // To make sure the options all mutable options are listed
   quaternion: () => {},
   position: () => {},
@@ -762,7 +768,8 @@ const Physics = props => {
     numInternalPgsIterations = 1,
     minIslandSize = 128,
     maxCcdSubsteps = 1,
-    erp = 0.8
+    erp = 0.8,
+    lengthUnit = 1
   } = props;
   const rapier = suspendReact.suspend(importRapier, ["@react-thee/rapier", importRapier]);
   const {
@@ -798,12 +805,13 @@ const Physics = props => {
     worldProxy.integrationParameters.numSolverIterations = numSolverIterations;
     worldProxy.integrationParameters.numAdditionalFrictionIterations = numAdditionalFrictionIterations;
     worldProxy.integrationParameters.numInternalPgsIterations = numInternalPgsIterations;
-    worldProxy.integrationParameters.allowedLinearError = allowedLinearError;
+    worldProxy.integrationParameters.normalizedAllowedLinearError = allowedLinearError;
     worldProxy.integrationParameters.minIslandSize = minIslandSize;
     worldProxy.integrationParameters.maxCcdSubsteps = maxCcdSubsteps;
-    worldProxy.integrationParameters.predictionDistance = predictionDistance;
+    worldProxy.integrationParameters.normalizedPredictionDistance = predictionDistance;
     worldProxy.integrationParameters.erp = erp;
-  }, [worldProxy, ...gravity, numSolverIterations, numAdditionalFrictionIterations, numInternalPgsIterations, allowedLinearError, minIslandSize, maxCcdSubsteps, predictionDistance, erp]);
+    worldProxy.lengthUnit = lengthUnit;
+  }, [worldProxy, ...gravity, numSolverIterations, numAdditionalFrictionIterations, numInternalPgsIterations, allowedLinearError, minIslandSize, maxCcdSubsteps, predictionDistance, erp, lengthUnit]);
   const getSourceFromColliderHandle = React.useCallback(handle => {
     var _collider$parent;
 
@@ -1435,6 +1443,9 @@ const mutableRigidBodyOptions = {
   ccd: (rb, value) => {
     rb.enableCcd(value);
   },
+  softCcdPrediction: (rb, value) => {
+    rb.setSoftCcdPrediction(value);
+  },
   userData: (rb, value) => {
     rb.userData = value;
   },

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

@@ -219,7 +219,7 @@ function _objectWithoutProperties(source, excluded) {
   return target;
 }
 
-const _excluded$2 = ["mass", "linearDamping", "angularDamping", "type", "onCollisionEnter", "onCollisionExit", "onIntersectionEnter", "onIntersectionExit", "onContactForce", "children", "canSleep", "ccd", "gravityScale"];
+const _excluded$2 = ["mass", "linearDamping", "angularDamping", "type", "onCollisionEnter", "onCollisionExit", "onIntersectionEnter", "onIntersectionExit", "onContactForce", "children", "canSleep", "ccd", "gravityScale", "softCcdPrediction"];
 const scaleColliderArgs = (shape, args, scale) => {
   const newArgs = args.slice(); // Heightfield uses a vector
 
@@ -296,6 +296,12 @@ const mutableColliderOptions = {
   restitutionCombineRule: (collider, value) => {
     collider.setRestitutionCombineRule(value);
   },
+  activeCollisionTypes: (collider, value) => {
+    collider.setActiveCollisionTypes(value);
+  },
+  contactSkin: (collider, value) => {
+    collider.setContactSkin(value);
+  },
   // To make sure the options all mutable options are listed
   quaternion: () => {},
   position: () => {},
@@ -737,7 +743,8 @@ const Physics = props => {
     numInternalPgsIterations = 1,
     minIslandSize = 128,
     maxCcdSubsteps = 1,
-    erp = 0.8
+    erp = 0.8,
+    lengthUnit = 1
   } = props;
   const rapier = suspend(importRapier, ["@react-thee/rapier", importRapier]);
   const {
@@ -773,12 +780,13 @@ const Physics = props => {
     worldProxy.integrationParameters.numSolverIterations = numSolverIterations;
     worldProxy.integrationParameters.numAdditionalFrictionIterations = numAdditionalFrictionIterations;
     worldProxy.integrationParameters.numInternalPgsIterations = numInternalPgsIterations;
-    worldProxy.integrationParameters.allowedLinearError = allowedLinearError;
+    worldProxy.integrationParameters.normalizedAllowedLinearError = allowedLinearError;
     worldProxy.integrationParameters.minIslandSize = minIslandSize;
     worldProxy.integrationParameters.maxCcdSubsteps = maxCcdSubsteps;
-    worldProxy.integrationParameters.predictionDistance = predictionDistance;
+    worldProxy.integrationParameters.normalizedPredictionDistance = predictionDistance;
     worldProxy.integrationParameters.erp = erp;
-  }, [worldProxy, ...gravity, numSolverIterations, numAdditionalFrictionIterations, numInternalPgsIterations, allowedLinearError, minIslandSize, maxCcdSubsteps, predictionDistance, erp]);
+    worldProxy.lengthUnit = lengthUnit;
+  }, [worldProxy, ...gravity, numSolverIterations, numAdditionalFrictionIterations, numInternalPgsIterations, allowedLinearError, minIslandSize, maxCcdSubsteps, predictionDistance, erp, lengthUnit]);
   const getSourceFromColliderHandle = useCallback(handle => {
     var _collider$parent;
 
@@ -1410,6 +1418,9 @@ const mutableRigidBodyOptions = {
   ccd: (rb, value) => {
     rb.enableCcd(value);
   },
+  softCcdPrediction: (rb, value) => {
+    rb.setSoftCcdPrediction(value);
+  },
   userData: (rb, value) => {
     rb.userData = value;
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-three/rapier",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "source": "src/index.ts",
   "main": "dist/react-three-rapier.cjs.js",
   "module": "dist/react-three-rapier.esm.js",
@@ -29,7 +29,7 @@
     "three": ">=0.139.0"
   },
   "dependencies": {
-    "@dimforge/rapier3d-compat": "0.12.0",
+    "@dimforge/rapier3d-compat": "0.13.1",
     "suspend-react": "^0.1.3",
     "three-stdlib": "2.23.9"
   },