@babylonjs/core 5.26.0 → 5.27.0

package/Maths/math.vector.js

@@ -11,6 +11,7 @@ const _ExtractAsInt = (value) => {
 };
 /**
  * Class representing a vector containing 2 coordinates
+ * Example Playground - Overview -  https://playground.babylonjs.com/#QYBWV4#9
  */
 export class Vector2 {
     /**
@@ -54,6 +55,7 @@ export class Vector2 {
     // Operators
     /**
      * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#15
      * @param array defines the source array
      * @param index defines the offset in source array
      * @returns the current Vector2
@@ -65,6 +67,7 @@ export class Vector2 {
     }
     /**
      * Update the current vector from an array
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#39
      * @param array defines the destination array
      * @param index defines the offset in the destination array
      * @returns the current Vector3
@@ -75,6 +78,7 @@ export class Vector2 {
     }
     /**
      * Copy the current vector to an array
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#40
      * @returns a new array with 2 elements: the Vector2 coordinates.
      */
     asArray() {
@@ -84,6 +88,7 @@ export class Vector2 {
     }
     /**
      * Sets the Vector2 coordinates with the given Vector2 coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#24
      * @param source defines the source Vector2
      * @returns the current updated Vector2
      */
@@ -94,6 +99,7 @@ export class Vector2 {
     }
     /**
      * Sets the Vector2 coordinates with the given floats
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#25
      * @param x defines the first coordinate
      * @param y defines the second coordinate
      * @returns the current updated Vector2
@@ -105,6 +111,7 @@ export class Vector2 {
     }
     /**
      * Sets the Vector2 coordinates with the given floats
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#62
      * @param x defines the first coordinate
      * @param y defines the second coordinate
      * @returns the current updated Vector2
@@ -114,6 +121,7 @@ export class Vector2 {
     }
     /**
      * Add another vector with the current one
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#11
      * @param otherVector defines the other vector
      * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
      */
@@ -122,6 +130,7 @@ export class Vector2 {
     }
     /**
      * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#12
      * @param otherVector defines the other vector
      * @param result defines the target vector
      * @returns the unmodified current Vector2
@@ -133,6 +142,7 @@ export class Vector2 {
     }
     /**
      * Set the Vector2 coordinates by adding the given Vector2 coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#13
      * @param otherVector defines the other vector
      * @returns the current updated Vector2
      */
@@ -143,6 +153,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#14
      * @param otherVector defines the other vector
      * @returns a new Vector2
      */
@@ -151,6 +162,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#61
      * @param otherVector defines the other vector
      * @returns a new Vector2
      */
@@ -159,6 +171,7 @@ export class Vector2 {
     }
     /**
      * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#63
      * @param otherVector defines the other vector
      * @param result defines the target vector
      * @returns the unmodified current Vector2
@@ -170,6 +183,7 @@ export class Vector2 {
     }
     /**
      * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#88
      * @param otherVector defines the other vector
      * @returns the current updated Vector2
      */
@@ -180,6 +194,7 @@ export class Vector2 {
     }
     /**
      * Multiplies in place the current Vector2 coordinates by the given ones
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#43
      * @param otherVector defines the other vector
      * @returns the current updated Vector2
      */
@@ -190,6 +205,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#42
      * @param otherVector defines the other vector
      * @returns a new Vector2
      */
@@ -198,6 +214,7 @@ export class Vector2 {
     }
     /**
      * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#44
      * @param otherVector defines the other vector
      * @param result defines the target vector
      * @returns the unmodified current Vector2
@@ -209,6 +226,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#89
      * @param x defines the first coordinate
      * @param y defines the second coordinate
      * @returns a new Vector2
@@ -218,6 +236,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#27
      * @param otherVector defines the other vector
      * @returns a new Vector2
      */
@@ -226,6 +245,7 @@ export class Vector2 {
     }
     /**
      * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#30
      * @param otherVector defines the other vector
      * @param result defines the target vector
      * @returns the unmodified current Vector2
@@ -237,6 +257,7 @@ export class Vector2 {
     }
     /**
      * Divides the current Vector2 coordinates by the given ones
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#28
      * @param otherVector defines the other vector
      * @returns the current updated Vector2
      */
@@ -245,6 +266,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 with current Vector2 negated coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#22
      * @returns a new Vector2
      */
     negate() {
@@ -252,6 +274,7 @@ export class Vector2 {
     }
     /**
      * Negate this vector in place
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#23
      * @returns this
      */
     negateInPlace() {
@@ -261,6 +284,7 @@ export class Vector2 {
     }
     /**
      * Negate the current Vector2 and stores the result in the given vector "result" coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#41
      * @param result defines the Vector3 object where to store the result
      * @returns the result
      */
@@ -268,7 +292,8 @@ export class Vector2 {
         return result.copyFromFloats(this.x * -1, this.y * -1);
     }
     /**
-     * Multiply the Vector2 coordinates by scale
+     * Multiply the Vector2 coordinates by
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#59
      * @param scale defines the scaling factor
      * @returns the current updated Vector2
      */
@@ -279,6 +304,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 scaled by "scale" from the current Vector2
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#52
      * @param scale defines the scaling factor
      * @returns a new Vector2
      */
@@ -289,6 +315,7 @@ export class Vector2 {
     }
     /**
      * Scale the current Vector2 values by a factor to a given Vector2
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#57
      * @param scale defines the scale factor
      * @param result defines the Vector2 object where to store the result
      * @returns the unmodified current Vector2
@@ -300,6 +327,7 @@ export class Vector2 {
     }
     /**
      * Scale the current Vector2 values by a factor and add the result to a given Vector2
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#58
      * @param scale defines the scale factor
      * @param result defines the Vector2 object where to store the result
      * @returns the unmodified current Vector2
@@ -311,6 +339,7 @@ export class Vector2 {
     }
     /**
      * Gets a boolean if two vectors are equals
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#31
      * @param otherVector defines the other vector
      * @returns true if the given vector coordinates strictly equal the current Vector2 ones
      */
@@ -319,6 +348,7 @@ export class Vector2 {
     }
     /**
      * Gets a boolean if two vectors are equals (using an epsilon value)
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#32
      * @param otherVector defines the other vector
      * @param epsilon defines the minimal distance to consider equality
      * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
@@ -328,6 +358,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 from current Vector2 floored values
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#35
      * eg (1.2, 2.31) returns (1, 2)
      * @returns a new Vector2
      */
@@ -336,6 +367,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 from current Vector2 fractional values
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#34
      * eg (1.2, 2.31) returns (0.2, 0.31)
      * @returns a new Vector2
      */
@@ -344,6 +376,7 @@ export class Vector2 {
     }
     /**
      * Rotate the current vector into a given result vector
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#49
      * @param angle defines the rotation angle
      * @param result defines the result vector where to store the rotated vector
      * @returns the current vector
@@ -373,6 +406,7 @@ export class Vector2 {
     // Methods
     /**
      * Normalize the vector
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#48
      * @returns the current updated Vector2
      */
     normalize() {
@@ -381,6 +415,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 copied from the Vector2
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#20
      * @returns a new Vector2
      */
     clone() {
@@ -409,6 +444,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 set from the given index element of the given array
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#79
      * @param array defines the data source
      * @param offset defines the offset in the data source
      * @returns a new Vector2
@@ -418,6 +454,7 @@ export class Vector2 {
     }
     /**
      * Sets "result" from the given index element of the given array
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#80
      * @param array defines the data source
      * @param offset defines the offset in the data source
      * @param result defines the target vector
@@ -428,6 +465,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#65
      * @param value1 defines 1st point of control
      * @param value2 defines 2nd point of control
      * @param value3 defines 3rd point of control
@@ -454,6 +492,7 @@ export class Vector2 {
      * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
      * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
      * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#76
      * @param value defines the value to clamp
      * @param min defines the lower limit
      * @param max defines the upper limit
@@ -470,6 +509,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value2", "tangent1", "tangent2"
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#81
      * @param value1 defines the 1st control point
      * @param tangent1 defines the outgoing tangent
      * @param value2 defines the 2nd control point
@@ -490,6 +530,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 which is the 1st derivative of the Hermite spline defined by the vectors "value1", "value2", "tangent1", "tangent2".
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#82
      * @param value1 defines the first control point
      * @param tangent1 defines the first tangent
      * @param value2 defines the second control point
@@ -504,6 +545,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 which is the 1st derivative of the Hermite spline defined by the vectors "value1", "value2", "tangent1", "tangent2".
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#83
      * @param value1 defines the first control point
      * @param tangent1 defines the first tangent
      * @param value2 defines the second control point
@@ -518,6 +560,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#84
      * @param start defines the start vector
      * @param end defines the end vector
      * @param amount defines the interpolation factor
@@ -530,6 +573,7 @@ export class Vector2 {
     }
     /**
      * Gets the dot product of the vector "left" and the vector "right"
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#90
      * @param left defines first vector
      * @param right defines second vector
      * @returns the dot product (float)
@@ -539,6 +583,7 @@ export class Vector2 {
     }
     /**
      * Returns a new Vector2 equal to the normalized given vector
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#46
      * @param vector defines the vector to normalize
      * @returns a new Vector2
      */
@@ -549,6 +594,7 @@ export class Vector2 {
     }
     /**
      * Normalize a given vector into a second one
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#50
      * @param vector defines the vector to normalize
      * @param result defines the vector where to store the result
      */
@@ -562,6 +608,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#86
      * @param left defines 1st vector
      * @param right defines 2nd vector
      * @returns a new Vector2
@@ -573,6 +620,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 set with the maximal coordinate values from the "left" and "right" vectors
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#86
      * @param left defines 1st vector
      * @param right defines 2nd vector
      * @returns a new Vector2
@@ -584,6 +632,7 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#17
      * @param vector defines the vector to transform
      * @param transformation defines the matrix to apply
      * @returns a new Vector2
@@ -595,6 +644,7 @@ export class Vector2 {
     }
     /**
      * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#19
      * @param vector defines the vector to transform
      * @param transformation defines the matrix to apply
      * @param result defines the target vector
@@ -608,6 +658,7 @@ export class Vector2 {
     }
     /**
      * Determines if a given vector is included in a triangle
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#87
      * @param p defines the vector to test
      * @param p0 defines 1st triangle point
      * @param p1 defines 2nd triangle point
@@ -623,6 +674,7 @@ export class Vector2 {
     }
     /**
      * Gets the distance between the vectors "value1" and "value2"
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#71
      * @param value1 defines first vector
      * @param value2 defines second vector
      * @returns the distance between vectors
@@ -632,6 +684,7 @@ export class Vector2 {
     }
     /**
      * Returns the squared distance between the vectors "value1" and "value2"
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#72
      * @param value1 defines first vector
      * @param value2 defines second vector
      * @returns the squared distance between vectors
@@ -643,6 +696,8 @@ export class Vector2 {
     }
     /**
      * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#86
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#66
      * @param value1 defines first vector
      * @param value2 defines second vector
      * @returns a new Vector2
@@ -652,6 +707,7 @@ export class Vector2 {
     }
     /**
      * Gets the center of the vectors "value1" and "value2" and stores the result in the vector "ref"
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#66
      * @param value1 defines first vector
      * @param value2 defines second vector
      * @param ref defines third vector
@@ -662,6 +718,7 @@ export class Vector2 {
     }
     /**
      * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
+     * Example Playground https://playground.babylonjs.com/#QYBWV4#77
      * @param p defines the middle point
      * @param segA defines one point of the segment
      * @param segB defines the other point of the segment
@@ -1514,6 +1571,7 @@ export class Vector3 {
     }
     /**
      * Gets the rotation that aligns the roll axis (Y) to the line joining the start point to the target point and stores it in the ref Vector3
+     * Example PG https://playground.babylonjs.com/#R1F8YU#189
      * @param start the starting point
      * @param target the target point
      * @param ref the vector3 to store the result
@@ -1529,6 +1587,7 @@ export class Vector3 {
     }
     /**
      * Gets the rotation that aligns the roll axis (Y) to the line joining the start point to the target point
+     * Example PG https://playground.babylonjs.com/#R1F8YU#188
      * @param start the starting point
      * @param target the target point
      * @returns the rotation in the form (pitch, yaw, 0)
@@ -3663,6 +3722,7 @@ export class Quaternion {
     }
     /**
      * Creates the rotation quaternion needed to rotate from one Vector3 onto another Vector3
+     * Example PG https://playground.babylonjs.com/#L49EJ7#2
      * @param fromVector the starting vector
      * @param toVector the ending vector
      * @returns the rotation quaternion needed
@@ -3673,6 +3733,7 @@ export class Quaternion {
     }
     /**
      * Creates the rotation quaternion needed to rotate from one Vector3 onto another Vector3 and stores in a result Quaternion
+     * Example PG https://playground.babylonjs.com/#L49EJ7#3
      * @param fromVector the starting vector
      * @param toVector the ending vector
      * @param result the rotation quaternion needed