@babylonjs/core 5.35.0 → 5.36.0

package/Physics/v1/physicsEngine.d.ts

@@ -0,0 +1,147 @@
+import type { Nullable } from "../../types";
+import { Vector3 } from "../../Maths/math.vector";
+import type { IPhysicsEnginePlugin } from "./IPhysicsEnginePlugin";
+import type { IPhysicsEngine } from "../IPhysicsEngine";
+import type { PhysicsImpostor, IPhysicsEnabledObject } from "./physicsImpostor";
+import type { PhysicsJoint } from "./physicsJoint";
+import type { PhysicsRaycastResult } from "../physicsRaycastResult";
+/**
+ * Class used to control physics engine
+ * @see https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine
+ */
+export declare class PhysicsEngine implements IPhysicsEngine {
+    private _physicsPlugin;
+    /**
+     * Global value used to control the smallest number supported by the simulation
+     */
+    private _impostors;
+    private _joints;
+    private _subTimeStep;
+    private _uniqueIdCounter;
+    /**
+     * Gets the gravity vector used by the simulation
+     */
+    gravity: Vector3;
+    /**
+     *
+     * @returns version
+     */
+    getPluginVersion(): number;
+    /**
+     * Factory used to create the default physics plugin.
+     * @returns The default physics plugin
+     */
+    static DefaultPluginFactory(): IPhysicsEnginePlugin;
+    /**
+     * Creates a new Physics Engine
+     * @param gravity defines the gravity vector used by the simulation
+     * @param _physicsPlugin defines the plugin to use (CannonJS by default)
+     */
+    constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
+    /**
+     * Sets the gravity vector used by the simulation
+     * @param gravity defines the gravity vector to use
+     */
+    setGravity(gravity: Vector3): void;
+    /**
+     * Set the time step of the physics engine.
+     * Default is 1/60.
+     * To slow it down, enter 1/600 for example.
+     * To speed it up, 1/30
+     * @param newTimeStep defines the new timestep to apply to this world.
+     */
+    setTimeStep(newTimeStep?: number): void;
+    /**
+     * Get the time step of the physics engine.
+     * @returns the current time step
+     */
+    getTimeStep(): number;
+    /**
+     * Set the sub time step of the physics engine.
+     * Default is 0 meaning there is no sub steps
+     * To increase physics resolution precision, set a small value (like 1 ms)
+     * @param subTimeStep defines the new sub timestep used for physics resolution.
+     */
+    setSubTimeStep(subTimeStep?: number): void;
+    /**
+     * Get the sub time step of the physics engine.
+     * @returns the current sub time step
+     */
+    getSubTimeStep(): number;
+    /**
+     * Release all resources
+     */
+    dispose(): void;
+    /**
+     * Gets the name of the current physics plugin
+     * @returns the name of the plugin
+     */
+    getPhysicsPluginName(): string;
+    /**
+     * Adding a new impostor for the impostor tracking.
+     * This will be done by the impostor itself.
+     * @param impostor the impostor to add
+     */
+    addImpostor(impostor: PhysicsImpostor): void;
+    /**
+     * Remove an impostor from the engine.
+     * This impostor and its mesh will not longer be updated by the physics engine.
+     * @param impostor the impostor to remove
+     */
+    removeImpostor(impostor: PhysicsImpostor): void;
+    /**
+     * Add a joint to the physics engine
+     * @param mainImpostor defines the main impostor to which the joint is added.
+     * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
+     * @param joint defines the joint that will connect both impostors.
+     */
+    addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
+    /**
+     * Removes a joint from the simulation
+     * @param mainImpostor defines the impostor used with the joint
+     * @param connectedImpostor defines the other impostor connected to the main one by the joint
+     * @param joint defines the joint to remove
+     */
+    removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
+    /**
+     * Called by the scene. No need to call it.
+     * @param delta defines the timespan between frames
+     */
+    _step(delta: number): void;
+    /**
+     * Gets the current plugin used to run the simulation
+     * @returns current plugin
+     */
+    getPhysicsPlugin(): IPhysicsEnginePlugin;
+    /**
+     * Gets the list of physic impostors
+     * @returns an array of PhysicsImpostor
+     */
+    getImpostors(): Array<PhysicsImpostor>;
+    /**
+     * Gets the impostor for a physics enabled object
+     * @param object defines the object impersonated by the impostor
+     * @returns the PhysicsImpostor or null if not found
+     */
+    getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
+    /**
+     * Gets the impostor for a physics body object
+     * @param body defines physics body used by the impostor
+     * @returns the PhysicsImpostor or null if not found
+     */
+    getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
+    /**
+     * Does a raycast in the physics world
+     * @param from when should the ray start?
+     * @param to when should the ray end?
+     * @returns PhysicsRaycastResult
+     */
+    raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
+    /**
+     * Does a raycast in the physics world
+     * @param from when should the ray start?
+     * @param to when should the ray end?
+     * @param result resulting PhysicsRaycastResult
+     */
+    raycastToRef(from: Vector3, to: Vector3, result: PhysicsRaycastResult): void;
+}

package/Physics/v1/physicsEngine.js

@@ -0,0 +1,237 @@
+import { Vector3 } from "../../Maths/math.vector.js";
+import { _WarnImport } from "../../Misc/devTools.js";
+/**
+ * Class used to control physics engine
+ * @see https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine
+ */
+export class PhysicsEngine {
+    /**
+     * Creates a new Physics Engine
+     * @param gravity defines the gravity vector used by the simulation
+     * @param _physicsPlugin defines the plugin to use (CannonJS by default)
+     */
+    constructor(gravity, _physicsPlugin = PhysicsEngine.DefaultPluginFactory()) {
+        this._physicsPlugin = _physicsPlugin;
+        /**
+         * Global value used to control the smallest number supported by the simulation
+         */
+        this._impostors = [];
+        this._joints = [];
+        this._subTimeStep = 0;
+        this._uniqueIdCounter = 0;
+        if (!this._physicsPlugin.isSupported()) {
+            throw new Error("Physics Engine " + this._physicsPlugin.name + " cannot be found. " + "Please make sure it is included.");
+        }
+        gravity = gravity || new Vector3(0, -9.807, 0);
+        this.setGravity(gravity);
+        this.setTimeStep();
+    }
+    /**
+     *
+     * @returns version
+     */
+    getPluginVersion() {
+        return this._physicsPlugin.getPluginVersion();
+    }
+    /**
+     * Factory used to create the default physics plugin.
+     * @returns The default physics plugin
+     */
+    static DefaultPluginFactory() {
+        throw _WarnImport("CannonJSPlugin");
+    }
+    /**
+     * Sets the gravity vector used by the simulation
+     * @param gravity defines the gravity vector to use
+     */
+    setGravity(gravity) {
+        this.gravity = gravity;
+        this._physicsPlugin.setGravity(this.gravity);
+    }
+    /**
+     * Set the time step of the physics engine.
+     * Default is 1/60.
+     * To slow it down, enter 1/600 for example.
+     * To speed it up, 1/30
+     * @param newTimeStep defines the new timestep to apply to this world.
+     */
+    setTimeStep(newTimeStep = 1 / 60) {
+        this._physicsPlugin.setTimeStep(newTimeStep);
+    }
+    /**
+     * Get the time step of the physics engine.
+     * @returns the current time step
+     */
+    getTimeStep() {
+        return this._physicsPlugin.getTimeStep();
+    }
+    /**
+     * Set the sub time step of the physics engine.
+     * Default is 0 meaning there is no sub steps
+     * To increase physics resolution precision, set a small value (like 1 ms)
+     * @param subTimeStep defines the new sub timestep used for physics resolution.
+     */
+    setSubTimeStep(subTimeStep = 0) {
+        this._subTimeStep = subTimeStep;
+    }
+    /**
+     * Get the sub time step of the physics engine.
+     * @returns the current sub time step
+     */
+    getSubTimeStep() {
+        return this._subTimeStep;
+    }
+    /**
+     * Release all resources
+     */
+    dispose() {
+        this._impostors.forEach(function (impostor) {
+            impostor.dispose();
+        });
+        this._physicsPlugin.dispose();
+    }
+    /**
+     * Gets the name of the current physics plugin
+     * @returns the name of the plugin
+     */
+    getPhysicsPluginName() {
+        return this._physicsPlugin.name;
+    }
+    /**
+     * Adding a new impostor for the impostor tracking.
+     * This will be done by the impostor itself.
+     * @param impostor the impostor to add
+     */
+    addImpostor(impostor) {
+        this._impostors.push(impostor);
+        impostor.uniqueId = this._uniqueIdCounter++;
+        //if no parent, generate the body
+        if (!impostor.parent) {
+            this._physicsPlugin.generatePhysicsBody(impostor);
+        }
+    }
+    /**
+     * Remove an impostor from the engine.
+     * This impostor and its mesh will not longer be updated by the physics engine.
+     * @param impostor the impostor to remove
+     */
+    removeImpostor(impostor) {
+        const index = this._impostors.indexOf(impostor);
+        if (index > -1) {
+            const removed = this._impostors.splice(index, 1);
+            //Is it needed?
+            if (removed.length) {
+                this.getPhysicsPlugin().removePhysicsBody(impostor);
+            }
+        }
+    }
+    /**
+     * Add a joint to the physics engine
+     * @param mainImpostor defines the main impostor to which the joint is added.
+     * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
+     * @param joint defines the joint that will connect both impostors.
+     */
+    addJoint(mainImpostor, connectedImpostor, joint) {
+        const impostorJoint = {
+            mainImpostor: mainImpostor,
+            connectedImpostor: connectedImpostor,
+            joint: joint,
+        };
+        joint.physicsPlugin = this._physicsPlugin;
+        this._joints.push(impostorJoint);
+        this._physicsPlugin.generateJoint(impostorJoint);
+    }
+    /**
+     * Removes a joint from the simulation
+     * @param mainImpostor defines the impostor used with the joint
+     * @param connectedImpostor defines the other impostor connected to the main one by the joint
+     * @param joint defines the joint to remove
+     */
+    removeJoint(mainImpostor, connectedImpostor, joint) {
+        const matchingJoints = this._joints.filter(function (impostorJoint) {
+            return impostorJoint.connectedImpostor === connectedImpostor && impostorJoint.joint === joint && impostorJoint.mainImpostor === mainImpostor;
+        });
+        if (matchingJoints.length) {
+            this._physicsPlugin.removeJoint(matchingJoints[0]);
+            //TODO remove it from the list as well
+        }
+    }
+    /**
+     * Called by the scene. No need to call it.
+     * @param delta defines the timespan between frames
+     */
+    _step(delta) {
+        //check if any mesh has no body / requires an update
+        this._impostors.forEach((impostor) => {
+            if (impostor.isBodyInitRequired()) {
+                this._physicsPlugin.generatePhysicsBody(impostor);
+            }
+        });
+        if (delta > 0.1) {
+            delta = 0.1;
+        }
+        else if (delta <= 0) {
+            delta = 1.0 / 60.0;
+        }
+        this._physicsPlugin.executeStep(delta, this._impostors);
+    }
+    /**
+     * Gets the current plugin used to run the simulation
+     * @returns current plugin
+     */
+    getPhysicsPlugin() {
+        return this._physicsPlugin;
+    }
+    /**
+     * Gets the list of physic impostors
+     * @returns an array of PhysicsImpostor
+     */
+    getImpostors() {
+        return this._impostors;
+    }
+    /**
+     * Gets the impostor for a physics enabled object
+     * @param object defines the object impersonated by the impostor
+     * @returns the PhysicsImpostor or null if not found
+     */
+    getImpostorForPhysicsObject(object) {
+        for (let i = 0; i < this._impostors.length; ++i) {
+            if (this._impostors[i].object === object) {
+                return this._impostors[i];
+            }
+        }
+        return null;
+    }
+    /**
+     * Gets the impostor for a physics body object
+     * @param body defines physics body used by the impostor
+     * @returns the PhysicsImpostor or null if not found
+     */
+    getImpostorWithPhysicsBody(body) {
+        for (let i = 0; i < this._impostors.length; ++i) {
+            if (this._impostors[i].physicsBody === body) {
+                return this._impostors[i];
+            }
+        }
+        return null;
+    }
+    /**
+     * Does a raycast in the physics world
+     * @param from when should the ray start?
+     * @param to when should the ray end?
+     * @returns PhysicsRaycastResult
+     */
+    raycast(from, to) {
+        return this._physicsPlugin.raycast(from, to);
+    }
+    /**
+     * Does a raycast in the physics world
+     * @param from when should the ray start?
+     * @param to when should the ray end?
+     * @param result resulting PhysicsRaycastResult
+     */
+    raycastToRef(from, to, result) {
+        return this._physicsPlugin.raycastToRef(from, to, result);
+    }
+}
+//# sourceMappingURL=physicsEngine.js.map

package/Physics/v1/physicsEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"physicsEngine.js","sourceRoot":"","sources":["../../../../../lts/core/generated/Physics/v1/physicsEngine.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAMlD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;;GAGG;AACH,MAAM,OAAO,aAAa;IA6BtB;;;;OAIG;IACH,YAAY,OAA0B,EAAU,iBAAuC,aAAa,CAAC,oBAAoB,EAAE;QAA3E,mBAAc,GAAd,cAAc,CAA6D;QAjC3H;;WAEG;QACK,eAAU,GAA2B,EAAE,CAAC;QACxC,YAAO,GAAgC,EAAE,CAAC;QAC1C,iBAAY,GAAW,CAAC,CAAC;QACzB,qBAAgB,GAAG,CAAC,CAAC;QA4BzB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,iBAAiB,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,oBAAoB,GAAG,kCAAkC,CAAC,CAAC;SAC7H;QACD,OAAO,GAAG,OAAO,IAAI,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACzB,IAAI,CAAC,WAAW,EAAE,CAAC;IACvB,CAAC;IA3BD;;;OAGG;IACI,gBAAgB;QACnB,OAAO,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC;IAClD,CAAC;IACD;;;OAGG;IACI,MAAM,CAAC,oBAAoB;QAC9B,MAAM,WAAW,CAAC,gBAAgB,CAAC,CAAC;IACxC,CAAC;IAgBD;;;OAGG;IACI,UAAU,CAAC,OAAgB;QAC9B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,cAAsB,CAAC,GAAG,EAAE;QAC3C,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACI,WAAW;QACd,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,cAAsB,CAAC;QACzC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,cAAc;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,UAAU,QAAQ;YACtC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,oBAAoB;QACvB,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,QAAyB;QACxC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,QAAQ,CAAC,QAAQ,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC5C,iCAAiC;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAClB,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;SACrD;IACL,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,QAAyB;QAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;YACZ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACjD,eAAe;YACf,IAAI,OAAO,CAAC,MAAM,EAAE;gBAChB,IAAI,CAAC,gBAAgB,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;aACvD;SACJ;IACL,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,YAA6B,EAAE,iBAAkC,EAAE,KAAmB;QAClG,MAAM,aAAa,GAAG;YAClB,YAAY,EAAE,YAAY;YAC1B,iBAAiB,EAAE,iBAAiB;YACpC,KAAK,EAAE,KAAK;SACf,CAAC;QACF,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,YAA6B,EAAE,iBAAkC,EAAE,KAAmB;QACrG,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,aAAa;YAC9D,OAAO,aAAa,CAAC,iBAAiB,KAAK,iBAAiB,IAAI,aAAa,CAAC,KAAK,KAAK,KAAK,IAAI,aAAa,CAAC,YAAY,KAAK,YAAY,CAAC;QACjJ,CAAC,CAAC,CAAC;QACH,IAAI,cAAc,CAAC,MAAM,EAAE;YACvB,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,sCAAsC;SACzC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAa;QACtB,oDAAoD;QACpD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjC,IAAI,QAAQ,CAAC,kBAAkB,EAAE,EAAE;gBAC/B,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;aACrD;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,KAAK,GAAG,GAAG,EAAE;YACb,KAAK,GAAG,GAAG,CAAC;SACf;aAAM,IAAI,KAAK,IAAI,CAAC,EAAE;YACnB,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC;SACtB;QAED,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,gBAAgB;QACnB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACI,YAAY;QACf,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,2BAA2B,CAAC,MAA6B;QAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,EAAE;gBACtC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aAC7B;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAAC,IAAS;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,KAAK,IAAI,EAAE;gBACzC,OAAO,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aAC7B;SACJ;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,IAAa,EAAE,EAAW;QACrC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,IAAa,EAAE,EAAW,EAAE,MAA4B;QACxE,OAAO,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;CACJ","sourcesContent":["import type { Nullable } from \"../../types\";\r\nimport { Vector3 } from \"../../Maths/math.vector\";\r\nimport type { PhysicsImpostorJoint, IPhysicsEnginePlugin } from \"./IPhysicsEnginePlugin\";\r\nimport type { IPhysicsEngine } from \"../IPhysicsEngine\";\r\nimport type { PhysicsImpostor, IPhysicsEnabledObject } from \"./physicsImpostor\";\r\nimport type { PhysicsJoint } from \"./physicsJoint\";\r\nimport type { PhysicsRaycastResult } from \"../physicsRaycastResult\";\r\nimport { _WarnImport } from \"../../Misc/devTools\";\r\n\r\n/**\r\n * Class used to control physics engine\r\n * @see https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine\r\n */\r\nexport class PhysicsEngine implements IPhysicsEngine {\r\n    /**\r\n     * Global value used to control the smallest number supported by the simulation\r\n     */\r\n    private _impostors: Array<PhysicsImpostor> = [];\r\n    private _joints: Array<PhysicsImpostorJoint> = [];\r\n    private _subTimeStep: number = 0;\r\n    private _uniqueIdCounter = 0;\r\n\r\n    /**\r\n     * Gets the gravity vector used by the simulation\r\n     */\r\n    public gravity: Vector3;\r\n\r\n    /**\r\n     *\r\n     * @returns version\r\n     */\r\n    public getPluginVersion(): number {\r\n        return this._physicsPlugin.getPluginVersion();\r\n    }\r\n    /**\r\n     * Factory used to create the default physics plugin.\r\n     * @returns The default physics plugin\r\n     */\r\n    public static DefaultPluginFactory(): IPhysicsEnginePlugin {\r\n        throw _WarnImport(\"CannonJSPlugin\");\r\n    }\r\n\r\n    /**\r\n     * Creates a new Physics Engine\r\n     * @param gravity defines the gravity vector used by the simulation\r\n     * @param _physicsPlugin defines the plugin to use (CannonJS by default)\r\n     */\r\n    constructor(gravity: Nullable<Vector3>, private _physicsPlugin: IPhysicsEnginePlugin = PhysicsEngine.DefaultPluginFactory()) {\r\n        if (!this._physicsPlugin.isSupported()) {\r\n            throw new Error(\"Physics Engine \" + this._physicsPlugin.name + \" cannot be found. \" + \"Please make sure it is included.\");\r\n        }\r\n        gravity = gravity || new Vector3(0, -9.807, 0);\r\n        this.setGravity(gravity);\r\n        this.setTimeStep();\r\n    }\r\n\r\n    /**\r\n     * Sets the gravity vector used by the simulation\r\n     * @param gravity defines the gravity vector to use\r\n     */\r\n    public setGravity(gravity: Vector3): void {\r\n        this.gravity = gravity;\r\n        this._physicsPlugin.setGravity(this.gravity);\r\n    }\r\n\r\n    /**\r\n     * Set the time step of the physics engine.\r\n     * Default is 1/60.\r\n     * To slow it down, enter 1/600 for example.\r\n     * To speed it up, 1/30\r\n     * @param newTimeStep defines the new timestep to apply to this world.\r\n     */\r\n    public setTimeStep(newTimeStep: number = 1 / 60) {\r\n        this._physicsPlugin.setTimeStep(newTimeStep);\r\n    }\r\n\r\n    /**\r\n     * Get the time step of the physics engine.\r\n     * @returns the current time step\r\n     */\r\n    public getTimeStep(): number {\r\n        return this._physicsPlugin.getTimeStep();\r\n    }\r\n\r\n    /**\r\n     * Set the sub time step of the physics engine.\r\n     * Default is 0 meaning there is no sub steps\r\n     * To increase physics resolution precision, set a small value (like 1 ms)\r\n     * @param subTimeStep defines the new sub timestep used for physics resolution.\r\n     */\r\n    public setSubTimeStep(subTimeStep: number = 0) {\r\n        this._subTimeStep = subTimeStep;\r\n    }\r\n\r\n    /**\r\n     * Get the sub time step of the physics engine.\r\n     * @returns the current sub time step\r\n     */\r\n    public getSubTimeStep() {\r\n        return this._subTimeStep;\r\n    }\r\n\r\n    /**\r\n     * Release all resources\r\n     */\r\n    public dispose(): void {\r\n        this._impostors.forEach(function (impostor) {\r\n            impostor.dispose();\r\n        });\r\n        this._physicsPlugin.dispose();\r\n    }\r\n\r\n    /**\r\n     * Gets the name of the current physics plugin\r\n     * @returns the name of the plugin\r\n     */\r\n    public getPhysicsPluginName(): string {\r\n        return this._physicsPlugin.name;\r\n    }\r\n\r\n    /**\r\n     * Adding a new impostor for the impostor tracking.\r\n     * This will be done by the impostor itself.\r\n     * @param impostor the impostor to add\r\n     */\r\n    public addImpostor(impostor: PhysicsImpostor) {\r\n        this._impostors.push(impostor);\r\n        impostor.uniqueId = this._uniqueIdCounter++;\r\n        //if no parent, generate the body\r\n        if (!impostor.parent) {\r\n            this._physicsPlugin.generatePhysicsBody(impostor);\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Remove an impostor from the engine.\r\n     * This impostor and its mesh will not longer be updated by the physics engine.\r\n     * @param impostor the impostor to remove\r\n     */\r\n    public removeImpostor(impostor: PhysicsImpostor) {\r\n        const index = this._impostors.indexOf(impostor);\r\n        if (index > -1) {\r\n            const removed = this._impostors.splice(index, 1);\r\n            //Is it needed?\r\n            if (removed.length) {\r\n                this.getPhysicsPlugin().removePhysicsBody(impostor);\r\n            }\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Add a joint to the physics engine\r\n     * @param mainImpostor defines the main impostor to which the joint is added.\r\n     * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint\r\n     * @param joint defines the joint that will connect both impostors.\r\n     */\r\n    public addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint) {\r\n        const impostorJoint = {\r\n            mainImpostor: mainImpostor,\r\n            connectedImpostor: connectedImpostor,\r\n            joint: joint,\r\n        };\r\n        joint.physicsPlugin = this._physicsPlugin;\r\n        this._joints.push(impostorJoint);\r\n        this._physicsPlugin.generateJoint(impostorJoint);\r\n    }\r\n\r\n    /**\r\n     * Removes a joint from the simulation\r\n     * @param mainImpostor defines the impostor used with the joint\r\n     * @param connectedImpostor defines the other impostor connected to the main one by the joint\r\n     * @param joint defines the joint to remove\r\n     */\r\n    public removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint) {\r\n        const matchingJoints = this._joints.filter(function (impostorJoint) {\r\n            return impostorJoint.connectedImpostor === connectedImpostor && impostorJoint.joint === joint && impostorJoint.mainImpostor === mainImpostor;\r\n        });\r\n        if (matchingJoints.length) {\r\n            this._physicsPlugin.removeJoint(matchingJoints[0]);\r\n            //TODO remove it from the list as well\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Called by the scene. No need to call it.\r\n     * @param delta defines the timespan between frames\r\n     */\r\n    public _step(delta: number) {\r\n        //check if any mesh has no body / requires an update\r\n        this._impostors.forEach((impostor) => {\r\n            if (impostor.isBodyInitRequired()) {\r\n                this._physicsPlugin.generatePhysicsBody(impostor);\r\n            }\r\n        });\r\n\r\n        if (delta > 0.1) {\r\n            delta = 0.1;\r\n        } else if (delta <= 0) {\r\n            delta = 1.0 / 60.0;\r\n        }\r\n\r\n        this._physicsPlugin.executeStep(delta, this._impostors);\r\n    }\r\n\r\n    /**\r\n     * Gets the current plugin used to run the simulation\r\n     * @returns current plugin\r\n     */\r\n    public getPhysicsPlugin(): IPhysicsEnginePlugin {\r\n        return this._physicsPlugin;\r\n    }\r\n\r\n    /**\r\n     * Gets the list of physic impostors\r\n     * @returns an array of PhysicsImpostor\r\n     */\r\n    public getImpostors(): Array<PhysicsImpostor> {\r\n        return this._impostors;\r\n    }\r\n\r\n    /**\r\n     * Gets the impostor for a physics enabled object\r\n     * @param object defines the object impersonated by the impostor\r\n     * @returns the PhysicsImpostor or null if not found\r\n     */\r\n    public getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor> {\r\n        for (let i = 0; i < this._impostors.length; ++i) {\r\n            if (this._impostors[i].object === object) {\r\n                return this._impostors[i];\r\n            }\r\n        }\r\n\r\n        return null;\r\n    }\r\n\r\n    /**\r\n     * Gets the impostor for a physics body object\r\n     * @param body defines physics body used by the impostor\r\n     * @returns the PhysicsImpostor or null if not found\r\n     */\r\n    public getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor> {\r\n        for (let i = 0; i < this._impostors.length; ++i) {\r\n            if (this._impostors[i].physicsBody === body) {\r\n                return this._impostors[i];\r\n            }\r\n        }\r\n\r\n        return null;\r\n    }\r\n\r\n    /**\r\n     * Does a raycast in the physics world\r\n     * @param from when should the ray start?\r\n     * @param to when should the ray end?\r\n     * @returns PhysicsRaycastResult\r\n     */\r\n    public raycast(from: Vector3, to: Vector3): PhysicsRaycastResult {\r\n        return this._physicsPlugin.raycast(from, to);\r\n    }\r\n\r\n    /**\r\n     * Does a raycast in the physics world\r\n     * @param from when should the ray start?\r\n     * @param to when should the ray end?\r\n     * @param result resulting PhysicsRaycastResult\r\n     */\r\n    public raycastToRef(from: Vector3, to: Vector3, result: PhysicsRaycastResult) {\r\n        return this._physicsPlugin.raycastToRef(from, to, result);\r\n    }\r\n}\r\n"]}

package/Physics/v1/physicsEngineComponent.d.ts

@@ -0,0 +1,45 @@
+import type { Nullable } from "../../types";
+import type { Observer } from "../../Misc/observable";
+import type { Vector3 } from "../../Maths/math.vector";
+import type { Mesh } from "../../Meshes/mesh";
+import type { Node } from "../../node";
+import type { PhysicsImpostor } from "./physicsImpostor";
+declare module "../../Meshes/abstractMesh" {
+    /**
+     *
+     */
+    interface AbstractMesh {
+        /** @internal */
+        _physicsImpostor: Nullable<PhysicsImpostor>;
+        /**
+         * Gets or sets impostor used for physic simulation
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/physics
+         */
+        physicsImpostor: Nullable<PhysicsImpostor>;
+        /**
+         * Gets the current physics impostor
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/physics
+         * @returns a physics impostor or null
+         */
+        getPhysicsImpostor(): Nullable<PhysicsImpostor>;
+        /** Apply a physic impulse to the mesh
+         * @param force defines the force to apply
+         * @param contactPoint defines where to apply the force
+         * @returns the current mesh
+         * @see https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine
+         */
+        applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
+        /**
+         * Creates a physic joint between two meshes
+         * @param otherMesh defines the other mesh to use
+         * @param pivot1 defines the pivot to use on this mesh
+         * @param pivot2 defines the pivot to use on the other mesh
+         * @param options defines additional options (can be plugin dependent)
+         * @returns the current mesh
+         * @see https://www.babylonjs-playground.com/#0BS5U0#0
+         */
+        setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
+        /** @internal */
+        _disposePhysicsObserver: Nullable<Observer<Node>>;
+    }
+}

package/Physics/v1/physicsEngineComponent.js

@@ -0,0 +1,70 @@
+import { AbstractMesh } from "../../Meshes/abstractMesh.js";
+import { PhysicsJoint } from "./physicsJoint.js";
+Object.defineProperty(AbstractMesh.prototype, "physicsImpostor", {
+    get: function () {
+        return this._physicsImpostor;
+    },
+    set: function (value) {
+        if (this._physicsImpostor === value) {
+            return;
+        }
+        if (this._disposePhysicsObserver) {
+            this.onDisposeObservable.remove(this._disposePhysicsObserver);
+        }
+        this._physicsImpostor = value;
+        if (value) {
+            this._disposePhysicsObserver = this.onDisposeObservable.add(() => {
+                // Physics
+                if (this.physicsImpostor) {
+                    this.physicsImpostor.dispose( /*!doNotRecurse*/);
+                    this.physicsImpostor = null;
+                }
+            });
+        }
+    },
+    enumerable: true,
+    configurable: true,
+});
+/**
+ * Gets the current physics impostor
+ * @see https://doc.babylonjs.com/features/featuresDeepDive/physics
+ * @returns a physics impostor or null
+ */
+AbstractMesh.prototype.getPhysicsImpostor = function () {
+    return this.physicsImpostor;
+};
+/**
+ * Apply a physic impulse to the mesh
+ * @param force defines the force to apply
+ * @param contactPoint defines where to apply the force
+ * @returns the current mesh
+ * @see https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine
+ */
+AbstractMesh.prototype.applyImpulse = function (force, contactPoint) {
+    if (!this.physicsImpostor) {
+        return this;
+    }
+    this.physicsImpostor.applyImpulse(force, contactPoint);
+    return this;
+};
+/**
+ * Creates a physic joint between two meshes
+ * @param otherMesh defines the other mesh to use
+ * @param pivot1 defines the pivot to use on this mesh
+ * @param pivot2 defines the pivot to use on the other mesh
+ * @param options defines additional options (can be plugin dependent)
+ * @returns the current mesh
+ * @see https://www.babylonjs-playground.com/#0BS5U0#0
+ */
+AbstractMesh.prototype.setPhysicsLinkWith = function (otherMesh, pivot1, pivot2, options) {
+    if (!this.physicsImpostor || !otherMesh.physicsImpostor) {
+        return this;
+    }
+    this.physicsImpostor.createJoint(otherMesh.physicsImpostor, PhysicsJoint.HingeJoint, {
+        mainPivot: pivot1,
+        connectedPivot: pivot2,
+        nativeParams: options,
+    });
+    return this;
+};
+//# sourceMappingURL=physicsEngineComponent.js.map

package/Physics/v1/physicsEngineComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"physicsEngineComponent.js","sourceRoot":"","sources":["../../../../../lts/core/generated/Physics/v1/physicsEngineComponent.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AA+C9C,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,SAAS,EAAE,iBAAiB,EAAE;IAC7D,GAAG,EAAE;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IACD,GAAG,EAAE,UAA8B,KAAgC;QAC/D,IAAI,IAAI,CAAC,gBAAgB,KAAK,KAAK,EAAE;YACjC,OAAO;SACV;QACD,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAC9B,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;SACjE;QAED,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;QAE9B,IAAI,KAAK,EAAE;YACP,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,EAAE;gBAC7D,UAAU;gBACV,IAAI,IAAI,CAAC,eAAe,EAAE;oBACtB,IAAI,CAAC,eAAe,CAAC,OAAO,EAAC,iBAAiB,CAAC,CAAC;oBAChD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;iBAC/B;YACL,CAAC,CAAC,CAAC;SACN;IACL,CAAC;IACD,UAAU,EAAE,IAAI;IAChB,YAAY,EAAE,IAAI;CACrB,CAAC,CAAC;AAEH;;;;GAIG;AACH,YAAY,CAAC,SAAS,CAAC,kBAAkB,GAAG;IACxC,OAAO,IAAI,CAAC,eAAe,CAAC;AAChC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,YAAY,CAAC,SAAS,CAAC,YAAY,GAAG,UAAU,KAAc,EAAE,YAAqB;IACjF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;QACvB,OAAO,IAAI,CAAC;KACf;IACD,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,YAAY,CAAC,SAAS,CAAC,kBAAkB,GAAG,UAAU,SAAe,EAAE,MAAe,EAAE,MAAe,EAAE,OAAa;IAClH,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE;QACrD,OAAO,IAAI,CAAC;KACf;IACD,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,SAAS,CAAC,eAAe,EAAE,YAAY,CAAC,UAAU,EAAE;QACjF,SAAS,EAAE,MAAM;QACjB,cAAc,EAAE,MAAM;QACtB,YAAY,EAAE,OAAO;KACxB,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AAChB,CAAC,CAAC","sourcesContent":["import type { Nullable } from \"../../types\";\r\nimport type { Observer } from \"../../Misc/observable\";\r\nimport type { Vector3 } from \"../../Maths/math.vector\";\r\nimport type { Mesh } from \"../../Meshes/mesh\";\r\nimport { AbstractMesh } from \"../../Meshes/abstractMesh\";\r\nimport type { Node } from \"../../node\";\r\nimport type { PhysicsImpostor } from \"./physicsImpostor\";\r\nimport { PhysicsJoint } from \"./physicsJoint\";\r\n\r\ndeclare module \"../../Meshes/abstractMesh\" {\r\n    /**\r\n     *\r\n     */\r\n    export interface AbstractMesh {\r\n        /** @internal */\r\n        _physicsImpostor: Nullable<PhysicsImpostor>;\r\n\r\n        /**\r\n         * Gets or sets impostor used for physic simulation\r\n         * @see https://doc.babylonjs.com/features/featuresDeepDive/physics\r\n         */\r\n        physicsImpostor: Nullable<PhysicsImpostor>;\r\n\r\n        /**\r\n         * Gets the current physics impostor\r\n         * @see https://doc.babylonjs.com/features/featuresDeepDive/physics\r\n         * @returns a physics impostor or null\r\n         */\r\n        getPhysicsImpostor(): Nullable<PhysicsImpostor>;\r\n\r\n        /** Apply a physic impulse to the mesh\r\n         * @param force defines the force to apply\r\n         * @param contactPoint defines where to apply the force\r\n         * @returns the current mesh\r\n         * @see https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine\r\n         */\r\n        applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;\r\n\r\n        /**\r\n         * Creates a physic joint between two meshes\r\n         * @param otherMesh defines the other mesh to use\r\n         * @param pivot1 defines the pivot to use on this mesh\r\n         * @param pivot2 defines the pivot to use on the other mesh\r\n         * @param options defines additional options (can be plugin dependent)\r\n         * @returns the current mesh\r\n         * @see https://www.babylonjs-playground.com/#0BS5U0#0\r\n         */\r\n        setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;\r\n\r\n        /** @internal */\r\n        _disposePhysicsObserver: Nullable<Observer<Node>>;\r\n    }\r\n}\r\n\r\nObject.defineProperty(AbstractMesh.prototype, \"physicsImpostor\", {\r\n    get: function (this: AbstractMesh) {\r\n        return this._physicsImpostor;\r\n    },\r\n    set: function (this: AbstractMesh, value: Nullable<PhysicsImpostor>) {\r\n        if (this._physicsImpostor === value) {\r\n            return;\r\n        }\r\n        if (this._disposePhysicsObserver) {\r\n            this.onDisposeObservable.remove(this._disposePhysicsObserver);\r\n        }\r\n\r\n        this._physicsImpostor = value;\r\n\r\n        if (value) {\r\n            this._disposePhysicsObserver = this.onDisposeObservable.add(() => {\r\n                // Physics\r\n                if (this.physicsImpostor) {\r\n                    this.physicsImpostor.dispose(/*!doNotRecurse*/);\r\n                    this.physicsImpostor = null;\r\n                }\r\n            });\r\n        }\r\n    },\r\n    enumerable: true,\r\n    configurable: true,\r\n});\r\n\r\n/**\r\n * Gets the current physics impostor\r\n * @see https://doc.babylonjs.com/features/featuresDeepDive/physics\r\n * @returns a physics impostor or null\r\n */\r\nAbstractMesh.prototype.getPhysicsImpostor = function (): Nullable<PhysicsImpostor> {\r\n    return this.physicsImpostor;\r\n};\r\n\r\n/**\r\n * Apply a physic impulse to the mesh\r\n * @param force defines the force to apply\r\n * @param contactPoint defines where to apply the force\r\n * @returns the current mesh\r\n * @see https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine\r\n */\r\nAbstractMesh.prototype.applyImpulse = function (force: Vector3, contactPoint: Vector3): AbstractMesh {\r\n    if (!this.physicsImpostor) {\r\n        return this;\r\n    }\r\n    this.physicsImpostor.applyImpulse(force, contactPoint);\r\n    return this;\r\n};\r\n\r\n/**\r\n * Creates a physic joint between two meshes\r\n * @param otherMesh defines the other mesh to use\r\n * @param pivot1 defines the pivot to use on this mesh\r\n * @param pivot2 defines the pivot to use on the other mesh\r\n * @param options defines additional options (can be plugin dependent)\r\n * @returns the current mesh\r\n * @see https://www.babylonjs-playground.com/#0BS5U0#0\r\n */\r\nAbstractMesh.prototype.setPhysicsLinkWith = function (otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh {\r\n    if (!this.physicsImpostor || !otherMesh.physicsImpostor) {\r\n        return this;\r\n    }\r\n    this.physicsImpostor.createJoint(otherMesh.physicsImpostor, PhysicsJoint.HingeJoint, {\r\n        mainPivot: pivot1,\r\n        connectedPivot: pivot2,\r\n        nativeParams: options,\r\n    });\r\n    return this;\r\n};\r\n"]}