@react-three/rapier 0.15.0 → 0.16.0-canary.0

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

@@ -1,6 +1,7 @@
 import { Collider } from "@dimforge/rapier3d-compat";
 import React, { ReactNode } from "react";
-import { ColliderOptions, CuboidArgs, RoundCuboidArgs, BallArgs, CapsuleArgs, HeightfieldArgs, TrimeshArgs, ConeArgs, CylinderArgs, ConvexHullArgs } from "../types";
+import { ColliderOptions, CuboidArgs, RoundCuboidArgs, BallArgs, CapsuleArgs, HeightfieldArgs, TrimeshArgs, ConeArgs, CylinderArgs, ConvexHullArgs, RoundCylinderArgs } from "../types";
+import { RoundConeArgs } from "../types";
 export interface ColliderProps extends ColliderOptions<any> {
     children?: ReactNode;
 }
@@ -14,14 +15,6 @@ export declare type ColliderOptionsRequiredArgs<T extends unknown[]> = Omit<Coll
     children?: ReactNode;
 };
 export declare type CuboidColliderProps = ColliderOptionsRequiredArgs<CuboidArgs>;
-export declare type RoundCuboidColliderProps = ColliderOptionsRequiredArgs<RoundCuboidArgs>;
-export declare type BallColliderProps = ColliderOptionsRequiredArgs<BallArgs>;
-export declare type CapsuleColliderProps = ColliderOptionsRequiredArgs<CapsuleArgs>;
-export declare type HeightfieldColliderProps = ColliderOptionsRequiredArgs<HeightfieldArgs>;
-export declare type TrimeshColliderProps = ColliderOptionsRequiredArgs<TrimeshArgs>;
-export declare type ConeColliderProps = ColliderOptionsRequiredArgs<ConeArgs>;
-export declare type CylinderColliderProps = ColliderOptionsRequiredArgs<CylinderArgs>;
-export declare type ConvexHullColliderProps = ColliderOptionsRequiredArgs<ConvexHullArgs>;
 /**
  * A cuboid collider shape
  * @category Colliders
@@ -30,6 +23,7 @@ export declare const CuboidCollider: React.ForwardRefExoticComponent<Omit<Collid
     args: CuboidArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type RoundCuboidColliderProps = ColliderOptionsRequiredArgs<RoundCuboidArgs>;
 /**
  * A round cuboid collider shape
  * @category Colliders
@@ -38,6 +32,7 @@ export declare const RoundCuboidCollider: React.ForwardRefExoticComponent<Omit<C
     args: RoundCuboidArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type BallColliderProps = ColliderOptionsRequiredArgs<BallArgs>;
 /**
  * A ball collider shape
  * @category Colliders
@@ -46,6 +41,7 @@ export declare const BallCollider: React.ForwardRefExoticComponent<Omit<Collider
     args: BallArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type CapsuleColliderProps = ColliderOptionsRequiredArgs<CapsuleArgs>;
 /**
  * A capsule collider shape
  * @category Colliders
@@ -54,6 +50,7 @@ export declare const CapsuleCollider: React.ForwardRefExoticComponent<Omit<Colli
     args: CapsuleArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type HeightfieldColliderProps = ColliderOptionsRequiredArgs<HeightfieldArgs>;
 /**
  * A heightfield collider shape
  * @category Colliders
@@ -62,6 +59,7 @@ export declare const HeightfieldCollider: React.ForwardRefExoticComponent<Omit<C
     args: HeightfieldArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type TrimeshColliderProps = ColliderOptionsRequiredArgs<TrimeshArgs>;
 /**
  * A trimesh collider shape
  * @category Colliders
@@ -70,6 +68,7 @@ export declare const TrimeshCollider: React.ForwardRefExoticComponent<Omit<Colli
     args: TrimeshArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type ConeColliderProps = ColliderOptionsRequiredArgs<ConeArgs>;
 /**
  * A cone collider shape
  * @category Colliders
@@ -78,6 +77,16 @@ export declare const ConeCollider: React.ForwardRefExoticComponent<Omit<Collider
     args: ConeArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type RoundConeColliderProps = ColliderOptionsRequiredArgs<RoundConeArgs>;
+/**
+ * A round cylinder collider shape
+ * @category Colliders
+ */
+export declare const RoundConeCollider: React.ForwardRefExoticComponent<Omit<ColliderOptions<RoundConeArgs>, "args"> & {
+    args: RoundConeArgs;
+    children?: ReactNode;
+} & React.RefAttributes<Collider>>;
+export declare type CylinderColliderProps = ColliderOptionsRequiredArgs<CylinderArgs>;
 /**
  * A cylinder collider shape
  * @category Colliders
@@ -86,6 +95,16 @@ export declare const CylinderCollider: React.ForwardRefExoticComponent<Omit<Coll
     args: CylinderArgs;
     children?: ReactNode;
 } & React.RefAttributes<Collider>>;
+export declare type RoundCylinderColliderProps = ColliderOptionsRequiredArgs<RoundCylinderArgs>;
+/**
+ * A round cylinder collider shape
+ * @category Colliders
+ */
+export declare const RoundCylinderCollider: React.ForwardRefExoticComponent<Omit<ColliderOptions<RoundConeArgs>, "args"> & {
+    args: RoundConeArgs;
+    children?: ReactNode;
+} & React.RefAttributes<Collider>>;
+export declare type ConvexHullColliderProps = ColliderOptionsRequiredArgs<ConvexHullArgs>;
 /**
  * A convex hull collider shape
  * @category Colliders

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

@@ -2,7 +2,7 @@ import type Rapier from "@dimforge/rapier3d-compat";
 import { Collider, ColliderHandle, RigidBody, RigidBodyHandle } from "@dimforge/rapier3d-compat";
 import React, { FC, ReactNode } from "react";
 import { Matrix4, Object3D, Vector3 } from "three";
-import { CollisionEnterHandler, CollisionExitHandler, ContactForceHandler, IntersectionEnterHandler, IntersectionExitHandler, RigidBodyAutoCollider, Vector3Array } from "../types";
+import { CollisionEnterHandler, CollisionExitHandler, ContactForceHandler, IntersectionEnterHandler, IntersectionExitHandler, RigidBodyAutoCollider, Vector3Tuple } from "../types";
 import { WorldApi } from "../utils/api";
 export interface RigidBodyState {
     meshType: "instancedMesh" | "mesh";
@@ -115,7 +115,7 @@ export interface PhysicsProps {
      * Set the gravity of the physics world
      * @defaultValue [0, -9.81, 0]
      */
-    gravity?: Vector3Array;
+    gravity?: Vector3Tuple;
     /**
      * Set the base automatic colliders for this physics world
      * All Meshes inside RigidBodies will generate a collider

package/dist/declarations/src/hooks/use-imperative-instance.d.ts

@@ -1,4 +1,5 @@
+import { DependencyList } from "react";
 /**
  * Initiate an instance and return a safe getter
  */
-export declare const useImperativeInstance: <InstanceType_1>(createFn: () => InstanceType_1, destroyFn: (instance: InstanceType_1) => void) => () => InstanceType_1;
+export declare const useImperativeInstance: <InstanceType_1>(createFn: () => InstanceType_1, destroyFn: (instance: InstanceType_1) => void, dependencyList: DependencyList) => () => InstanceType_1;

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

@@ -67,14 +67,26 @@ export declare type RoundConvexMeshArgs = [
 export declare type UseBodyOptions = Omit<RigidBodyOptions, "shape">;
 export declare type RigidBodyTypeString = "fixed" | "dynamic" | "kinematicPosition" | "kinematicVelocity";
 export declare type ColliderShape = "cuboid" | "trimesh" | "ball" | "capsule" | "convexHull" | "heightfield" | "polyline" | "roundCuboid" | "cylinder" | "roundCylinder" | "cone" | "roundCone" | "convexMesh" | "roundConvexHull" | "roundConvexMesh";
-export declare type Vector3Array = [x: number, y: number, z: number];
-export declare type Vector4Array = [x: number, y: number, z: number, w: number];
-export declare type Boolean3Array = [x: boolean, y: boolean, z: boolean];
+export declare type Vector3Tuple = [x: number, y: number, z: number];
+export declare type Vector4Tuple = [x: number, y: number, z: number, w: number];
+export declare type Boolean3Tuple = [x: boolean, y: boolean, z: boolean];
 export declare type Vector3Object = {
     x: number;
     y: number;
     z: number;
 };
+/**
+ * @deprecated use Vector3Tuple instead
+ */
+export declare type Vector3Array = Vector3Tuple;
+/**
+ * @deprecated use Vector4Tuple instead
+ * */
+export declare type Vector4Array = Vector4Tuple;
+/**
+ * @deprecated use Boolean3Tuple instead
+ * */
+export declare type Boolean3Array = Boolean3Tuple;
 export interface ColliderOptions<ColliderArgs extends Array<unknown>> {
     /**
      * The optional name passed to THREE's Object3D
@@ -91,7 +103,7 @@ export interface ColliderOptions<ColliderArgs extends Array<unknown>> {
     /**
      * Principal angular inertia of this rigid body
      */
-    principalAngularInertia?: Vector3Array;
+    principalAngularInertia?: Vector3Tuple;
     /**
      * Restitution controls how elastic (aka. bouncy) a contact is. Le elasticity of a contact is controlled by the restitution coefficient
      */
@@ -241,12 +253,12 @@ export interface RigidBodyOptions extends ColliderProps {
      * The initial linear velocity of this body.
      * @defaultValue [0,0,0]
      */
-    linearVelocity?: Vector3Array;
+    linearVelocity?: Vector3Tuple;
     /**
      * The initial angular velocity of this body.
      * @defaultValue [0,0,0]
      */
-    angularVelocity?: Vector3Array;
+    angularVelocity?: Vector3Tuple;
     /**
      * The scaling factor applied to the gravity affecting the rigid-body.
      * @defaultValue 1.0
@@ -316,11 +328,11 @@ export interface RigidBodyOptions extends ColliderProps {
     /**
      * Allow rotation of this rigid-body only along specific axes.
      */
-    enabledRotations?: Boolean3Array;
+    enabledRotations?: Boolean3Tuple;
     /**
      * Allow translation of this rigid-body only along specific axes.
      */
-    enabledTranslations?: Boolean3Array;
+    enabledTranslations?: Boolean3Tuple;
     /**
      * Passed down to the object3d representing this collider.
      */
@@ -336,26 +348,26 @@ export interface RigidBodyOptions extends ColliderProps {
     transformState?: (state: RigidBodyState) => RigidBodyState;
 }
 export declare type SphericalJointParams = [
-    body1Anchor: Vector3Array,
-    body2Anchor: Vector3Array
+    body1Anchor: Vector3Tuple,
+    body2Anchor: Vector3Tuple
 ];
 export declare type FixedJointParams = [
-    body1Anchor: Vector3Array,
-    body1LocalFrame: Vector4Array,
-    body2Anchor: Vector3Array,
-    body2LocalFrame: Vector4Array
+    body1Anchor: Vector3Tuple,
+    body1LocalFrame: Vector4Tuple,
+    body2Anchor: Vector3Tuple,
+    body2LocalFrame: Vector4Tuple
 ];
 export declare type PrismaticJointParams = [
-    body1Anchor: Vector3Array,
-    body1LocalFrame: Vector3Array,
-    body2Anchor: Vector3Array,
-    body2LocalFrame: Vector3Array,
+    body1Anchor: Vector3Tuple,
+    body1LocalFrame: Vector3Tuple,
+    body2Anchor: Vector3Tuple,
+    body2LocalFrame: Vector3Tuple,
     limits?: [min: number, max: number]
 ];
 export declare type RevoluteJointParams = [
-    body1Anchor: Vector3Array,
-    body2Anchor: Vector3Array,
-    axis: Vector3Array,
+    body1Anchor: Vector3Tuple,
+    body2Anchor: Vector3Tuple,
+    axis: Vector3Tuple,
     limits?: [min: number, max: number]
 ];
 export interface UseImpulseJoint<JointParams, JointType extends ImpulseJoint> {

package/dist/declarations/src/utils/api.d.ts

@@ -1,6 +1,5 @@
 import { Collider, ColliderDesc, DebugRenderBuffers, ImpulseJoint, JointData, RigidBody, RigidBodyDesc, World } from "@dimforge/rapier3d-compat";
 import { Vector3 } from "three";
-import { RefGetter } from "../types";
 export interface WorldApi {
     raw(): World;
     getCollider(handle: number): Collider | undefined;
@@ -15,4 +14,4 @@ export interface WorldApi {
     setGravity(gravity: Vector3): void;
     debugRender(): DebugRenderBuffers;
 }
-export declare const createWorldApi: (ref: RefGetter<World>) => WorldApi;
+export declare const createWorldApi: (getWorld: () => World) => WorldApi;

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

@@ -40,8 +40,8 @@ export declare const useColliderEvents: (getCollider: () => Collider, props: Col
     contactForce?: boolean;
 }) => void;
 export declare const cleanRigidBodyPropsForCollider: (props?: RigidBodyProps) => {
-    linearVelocity?: import("..").Vector3Array | undefined;
-    angularVelocity?: import("..").Vector3Array | undefined;
+    linearVelocity?: import("..").Vector3Tuple | undefined;
+    angularVelocity?: import("..").Vector3Tuple | undefined;
     dominanceGroup?: number | undefined;
     position?: import("@react-three/fiber").Vector3 | undefined;
     rotation?: import("@react-three/fiber").Euler | undefined;
@@ -54,8 +54,8 @@ export declare const cleanRigidBodyPropsForCollider: (props?: RigidBodyProps) =>
     onWake?(): void;
     lockRotations?: boolean | undefined;
     lockTranslations?: boolean | undefined;
-    enabledRotations?: import("..").Boolean3Array | undefined;
-    enabledTranslations?: import("..").Boolean3Array | undefined;
+    enabledRotations?: import("..").Boolean3Tuple | undefined;
+    enabledTranslations?: import("..").Boolean3Tuple | undefined;
     userData?: {
         [key: string]: any;
     } | undefined;
@@ -64,7 +64,7 @@ export declare const cleanRigidBodyPropsForCollider: (props?: RigidBodyProps) =>
     name?: string | undefined;
     shape?: ColliderShape | undefined;
     args?: any;
-    principalAngularInertia?: import("..").Vector3Array | undefined;
+    principalAngularInertia?: import("..").Vector3Tuple | undefined;
     restitutionCombineRule?: import("@dimforge/rapier3d-compat").CoefficientCombineRule | undefined;
     frictionCombineRule?: import("@dimforge/rapier3d-compat").CoefficientCombineRule | undefined;
     quaternion?: import("@react-three/fiber").Quaternion | undefined;

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

@@ -14,6 +14,10 @@ interface CreateRigidBodyStateOptions {
 export declare const createRigidBodyState: ({ rigidBody, object, setMatrix, getMatrix, worldScale, meshType }: CreateRigidBodyStateOptions) => RigidBodyState;
 declare type ImmutableRigidBodyOptions = (keyof RigidBodyProps)[];
 export declare const immutableRigidBodyOptions: ImmutableRigidBodyOptions;
+declare type MutableRigidBodyOptions = {
+    [Prop in keyof RigidBodyProps]: (rb: RigidBody, value: any) => void;
+};
+export declare const mutableRigidBodyOptions: MutableRigidBodyOptions;
 export declare const setRigidBodyOptions: (rigidBody: RigidBody, options: RigidBodyProps, states: RigidBodyStateMap, updateTranslations?: boolean) => void;
 export declare const useUpdateRigidBodyOptions: (getRigidBody: () => RigidBody, props: RigidBodyProps, states: RigidBodyStateMap, updateTranslations?: boolean) => void;
 export declare const useRigidBodyEvents: (getRigidBody: () => RigidBody, props: RigidBodyProps, events: EventMap) => void;

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

@@ -1,7 +1,7 @@
 import { Quaternion as RapierQuaternion, Vector3 as RapierVector3 } from "@dimforge/rapier3d-compat";
 import { Euler, Quaternion, Vector3 } from "three";
-import { RigidBodyTypeString, Vector3Array } from "../types";
-export declare const vectorArrayToVector3: (arr: Vector3Array) => Vector3;
+import { RigidBodyTypeString, Vector3Tuple } from "../types";
+export declare const vectorArrayToVector3: (arr: Vector3Tuple) => Vector3;
 export declare const tupleToObject: <T extends readonly any[], K extends readonly string[]>(tuple: T, keys: K) => { [Key in K[number]]: T[number]; };
 export declare const vector3ToQuaternion: (v: Vector3) => Quaternion;
 export declare const rapierVector3ToVector3: ({ x, y, z }: RapierVector3) => Vector3;