@babylonjs/core 6.39.0 → 6.40.0

package/Physics/v2/Plugins/havokPlugin.d.ts

@@ -90,7 +90,6 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
      *
      * @param delta The time delta in seconds since the last step.
      * @param physicsBodies An array of physics bodies to be simulated.
-     * @returns void
      *
      * This method is useful for simulating the physics engine. It sets the physics body transformation,
      * steps the world, syncs the physics body, and notifies collisions. This allows for the physics engine
@@ -233,6 +232,7 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
      * Gets the motion type of a physics body.
      * @param body - The physics body to get the motion type from.
      * @param instanceIndex - The index of the instance to get the motion type from. If not specified, the motion type of the first instance will be returned.
+     * @returns The motion type of the physics body.
      */
     getMotionType(body: PhysicsBody, instanceIndex?: number): PhysicsMotionType;
     private _internalComputeMassProperties;
@@ -241,6 +241,7 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
      *
      * @param body - The physics body to copmute the mass properties of
      * @param instanceIndex - The index of the instance to compute the mass properties of.
+     * @returns The mass properties of the physics body.
      */
     computeMassProperties(body: PhysicsBody, instanceIndex?: number): PhysicsMassProperties;
     /**
@@ -458,6 +459,12 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
      *
      */
     setMaterial(shape: PhysicsShape, material: PhysicsMaterial): void;
+    /**
+     * Gets the material associated with a physics shape.
+     * @param shape - The shape to get the material from.
+     * @returns The material associated with the shape.
+     */
+    getMaterial(shape: PhysicsShape): PhysicsMaterial;
     /**
      * Sets the density of a physics shape.
      * @param shape - The physics shape to set the density of.
@@ -475,11 +482,11 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
     getDensity(shape: PhysicsShape): number;
     /**
      * Gets the transform infos of a given transform node.
-     * @param node - The transform node.
-     * @returns An array containing the position and orientation of the node.
      * This code is useful for getting the position and orientation of a given transform node.
      * It first checks if the node has a rotation quaternion, and if not, it creates one from the node's rotation.
      * It then creates an array containing the position and orientation of the node and returns it.
+     * @param node - The transform node.
+     * @returns An array containing the position and orientation of the node.
      */
     private _getTransformInfos;
     /**
@@ -542,7 +549,6 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
      * Releases a physics shape from the physics engine.
      *
      * @param shape - The physics shape to be released.
-     * @returns void
      *
      * This method is useful for releasing a physics shape from the physics engine, freeing up resources and preventing memory leaks.
      */
@@ -609,7 +615,6 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
      * @param constraint - The constraint to set the friction of.
      * @param axis - The axis of the constraint to set the friction of.
      * @param friction - The friction to set.
-     * @returns void
      *
      */
     setAxisFriction(constraint: PhysicsConstraint, axis: PhysicsConstraintAxis, friction: number): void;
@@ -676,7 +681,6 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
      * @param constraint - The constraint to set the motor type of.
      * @param axis - The axis of the constraint to set the motor type of.
      * @param motorType - The motor type to set.
-     * @returns void
      *
      */
     setAxisMotorType(constraint: PhysicsConstraint, axis: PhysicsConstraintAxis, motorType: PhysicsConstraintMotorType): void;
@@ -747,6 +751,7 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
     /**
      * Return the collision observable for a particular physics body.
      * @param body the physics body
+     * @returns the collision observable for the body
      */
     getCollisionObservable(body: PhysicsBody): Observable<IPhysicsCollisionEvent>;
     /**
@@ -786,6 +791,7 @@ export declare class HavokPlugin implements IPhysicsEnginePluginV2 {
     private _constraintMotorTypeToNative;
     private _nativeToMotorType;
     private _materialCombineToNative;
+    private _nativeToMaterialCombine;
     private _constraintAxisToNative;
     private _nativeToLimitMode;
     private _limitModeToNative;

package/Physics/v2/Plugins/havokPlugin.js

@@ -103,6 +103,7 @@ class MeshAccumulator {
     /**
      * Allocate and populate the vertex positions inside the physics plugin.
      *
+     * @param plugin - The plugin to allocate the memory in.
      * @returns An array of floats, whose backing memory is inside the plugin. The array contains the
      * positions of the mesh vertices, where a position is defined by three floats. You must call
      * freeBuffer() on the returned array once you have finished with it, in order to free the
@@ -127,6 +128,7 @@ class MeshAccumulator {
     /**
      * Allocate and populate the triangle indices inside the physics plugin
      *
+     * @param plugin - The plugin to allocate the memory in.
      * @returns A new Int32Array, whose backing memory is inside the plugin. The array contains the indices
      * of the triangle positions, where a single triangle is defined by three indices. You must call
      * freeBuffer() on this array once you have finished with it, to free the memory inside the plugin..
@@ -289,7 +291,6 @@ export class HavokPlugin {
      *
      * @param delta The time delta in seconds since the last step.
      * @param physicsBodies An array of physics bodies to be simulated.
-     * @returns void
      *
      * This method is useful for simulating the physics engine. It sets the physics body transformation,
      * steps the world, syncs the physics body, and notifies collisions. This allows for the physics engine
@@ -682,6 +683,7 @@ export class HavokPlugin {
      * Gets the motion type of a physics body.
      * @param body - The physics body to get the motion type from.
      * @param instanceIndex - The index of the instance to get the motion type from. If not specified, the motion type of the first instance will be returned.
+     * @returns The motion type of the physics body.
      */
     getMotionType(body, instanceIndex) {
         const pluginRef = this._getPluginReference(body, instanceIndex);
@@ -712,6 +714,7 @@ export class HavokPlugin {
      *
      * @param body - The physics body to copmute the mass properties of
      * @param instanceIndex - The index of the instance to compute the mass properties of.
+     * @returns The mass properties of the physics body.
      */
     computeMassProperties(body, instanceIndex) {
         const pluginRef = this._getPluginReference(body, instanceIndex);
@@ -1118,6 +1121,21 @@ export class HavokPlugin {
         const hpMaterial = [staticFriction, dynamicFriction, restitution, this._materialCombineToNative(frictionCombine), this._materialCombineToNative(restitutionCombine)];
         this._hknp.HP_Shape_SetMaterial(shape._pluginData, hpMaterial);
     }
+    /**
+     * Gets the material associated with a physics shape.
+     * @param shape - The shape to get the material from.
+     * @returns The material associated with the shape.
+     */
+    getMaterial(shape) {
+        const hkMaterial = this._hknp.HP_Shape_GetMaterial(shape._pluginData)[1];
+        return {
+            staticFriction: hkMaterial[0],
+            friction: hkMaterial[1],
+            restitution: hkMaterial[2],
+            frictionCombine: this._nativeToMaterialCombine(hkMaterial[3]),
+            restitutionCombine: this._nativeToMaterialCombine(hkMaterial[4]),
+        };
+    }
     /**
      * Sets the density of a physics shape.
      * @param shape - The physics shape to set the density of.
@@ -1139,11 +1157,11 @@ export class HavokPlugin {
     }
     /**
      * Gets the transform infos of a given transform node.
-     * @param node - The transform node.
-     * @returns An array containing the position and orientation of the node.
      * This code is useful for getting the position and orientation of a given transform node.
      * It first checks if the node has a rotation quaternion, and if not, it creates one from the node's rotation.
      * It then creates an array containing the position and orientation of the node and returns it.
+     * @param node - The transform node.
+     * @returns An array containing the position and orientation of the node.
      */
     _getTransformInfos(node) {
         if (node.parent) {
@@ -1247,7 +1265,6 @@ export class HavokPlugin {
      * Releases a physics shape from the physics engine.
      *
      * @param shape - The physics shape to be released.
-     * @returns void
      *
      * This method is useful for releasing a physics shape from the physics engine, freeing up resources and preventing memory leaks.
      */
@@ -1479,7 +1496,6 @@ export class HavokPlugin {
      * @param constraint - The constraint to set the friction of.
      * @param axis - The axis of the constraint to set the friction of.
      * @param friction - The friction to set.
-     * @returns void
      *
      */
     setAxisFriction(constraint, axis, friction) {
@@ -1587,7 +1603,6 @@ export class HavokPlugin {
      * @param constraint - The constraint to set the motor type of.
      * @param axis - The axis of the constraint to set the motor type of.
      * @param motorType - The motor type to set.
-     * @returns void
      *
      */
     setAxisMotorType(constraint, axis, motorType) {
@@ -1714,6 +1729,7 @@ export class HavokPlugin {
     /**
      * Return the collision observable for a particular physics body.
      * @param body the physics body
+     * @returns the collision observable for the body
      */
     getCollisionObservable(body) {
         const bodyId = body._pluginData.hpBodyId[0];
@@ -1924,6 +1940,22 @@ export class HavokPlugin {
                 return this._hknp.MaterialCombine.MULTIPLY;
         }
     }
+    _nativeToMaterialCombine(mat) {
+        switch (mat) {
+            case this._hknp.MaterialCombine.GEOMETRIC_MEAN:
+                return PhysicsMaterialCombineMode.GEOMETRIC_MEAN;
+            case this._hknp.MaterialCombine.MINIMUM:
+                return PhysicsMaterialCombineMode.MINIMUM;
+            case this._hknp.MaterialCombine.MAXIMUM:
+                return PhysicsMaterialCombineMode.MAXIMUM;
+            case this._hknp.MaterialCombine.ARITHMETIC_MEAN:
+                return PhysicsMaterialCombineMode.ARITHMETIC_MEAN;
+            case this._hknp.MaterialCombine.MULTIPLY:
+                return PhysicsMaterialCombineMode.MULTIPLY;
+            default:
+                return undefined;
+        }
+    }
     _constraintAxisToNative(axId) {
         switch (axId) {
             case PhysicsConstraintAxis.LINEAR_X: