@babylonjs/core 5.32.0 → 5.32.2

package/Particles/solidParticleSystem.d.ts

@@ -12,7 +12,7 @@ import type { PickingInfo } from "../Collisions/pickingInfo";
  * The SPS is also a particle system. It provides some methods to manage the particles.
  * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  *
- * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
+ * Full documentation here : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_intro
  */
 export declare class SolidParticleSystem implements IDisposable {
     /**
@@ -46,7 +46,7 @@ export declare class SolidParticleSystem implements IDisposable {
     mesh: Mesh;
     /**
      * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
-     * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
+     * Please read : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/optimize_sps#limit-garbage-collection
      */
     vars: any;
     /**
@@ -58,7 +58,7 @@ export declare class SolidParticleSystem implements IDisposable {
      * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
      * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
      * Use the method SPS.pickedParticle(pickingInfo) instead.
-     * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
+     * Please read : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/picking_sps
      */
     pickedParticles: {
         idx: number;
@@ -73,7 +73,7 @@ export declare class SolidParticleSystem implements IDisposable {
      * `idx` is the picked particle index in the `SPS.particles` array
      * `faceId` is the picked face index counted within this particle.
      * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
-     * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
+     * Please read : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/picking_sps
      */
     pickedBySubMesh: {
         idx: number;
@@ -274,7 +274,7 @@ export declare class SolidParticleSystem implements IDisposable {
     private _addParticle;
     /**
      * Adds some particles to the SPS from the model shape. Returns the shape id.
-     * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
+     * Please read the doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/immutable_sps
      * @param mesh is any Mesh object that will be used as a model for the solid particles.
      * @param nb (positive integer) the number of particles to be created from this model
      * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
@@ -415,7 +415,7 @@ export declare class SolidParticleSystem implements IDisposable {
     private _setDefaultMaterial;
     /**
      * Visibility helper : Recomputes the visible size according to the mesh bounding box
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      * @returns the SPS.
      */
     refreshVisibleSize(): SolidParticleSystem;
@@ -423,27 +423,27 @@ export declare class SolidParticleSystem implements IDisposable {
      * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
      * @param size the size (float) of the visibility box
      * note : this doesn't lock the SPS mesh bounding box.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     setVisibilityBox(size: number): void;
     /**
      * Gets whether the SPS as always visible or not
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     get isAlwaysVisible(): boolean;
     /**
      * Sets the SPS as always visible or not
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     set isAlwaysVisible(val: boolean);
     /**
      * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     set isVisibilityBoxLocked(val: boolean);
     /**
      * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     get isVisibilityBoxLocked(): boolean;
     /**
@@ -545,13 +545,13 @@ export declare class SolidParticleSystem implements IDisposable {
     /**
      * This function does nothing. It may be overwritten to set all the particle first values.
      * The SPS doesn't call this function, you may have to call it by your own.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/manage_sps_particles
      */
     initParticles(): void;
     /**
      * This function does nothing. It may be overwritten to recycle a particle.
      * The SPS doesn't call this function, you may have to call it by your own.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/manage_sps_particles
      * @param particle The particle to recycle
      * @returns the recycled particle
      */
@@ -559,7 +559,7 @@ export declare class SolidParticleSystem implements IDisposable {
     /**
      * Updates a particle : this function should  be overwritten by the user.
      * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/manage_sps_particles
      * @example : just set a particle position or velocity and recycle conditions
      * @param particle The particle to update
      * @returns the updated particle
@@ -571,7 +571,7 @@ export declare class SolidParticleSystem implements IDisposable {
      * @param particle the current particle
      * @param vertex the current vertex of the current particle : a SolidParticleVertex object
      * @param pt the index of the current vertex in the particle shape
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_vertices
      * @example : just set a vertex particle position or color
      * @returns the sps
      */

package/Particles/solidParticleSystem.js

@@ -18,7 +18,7 @@ import { MultiMaterial } from "../Materials/multiMaterial.js";
  * The SPS is also a particle system. It provides some methods to manage the particles.
  * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  *
- * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
+ * Full documentation here : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_intro
  */
 export class SolidParticleSystem {
     /**
@@ -74,7 +74,7 @@ export class SolidParticleSystem {
         this.counter = 0;
         /**
          * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
-         * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
+         * Please read : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/optimize_sps#limit-garbage-collection
          */
         this.vars = {};
         /**
@@ -586,7 +586,7 @@ export class SolidParticleSystem {
     }
     /**
      * Adds some particles to the SPS from the model shape. Returns the shape id.
-     * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
+     * Please read the doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/immutable_sps
      * @param mesh is any Mesh object that will be used as a model for the solid particles.
      * @param nb (positive integer) the number of particles to be created from this model
      * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
@@ -1496,7 +1496,7 @@ export class SolidParticleSystem {
     }
     /**
      * Visibility helper : Recomputes the visible size according to the mesh bounding box
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      * @returns the SPS.
      */
     refreshVisibleSize() {
@@ -1509,7 +1509,7 @@ export class SolidParticleSystem {
      * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
      * @param size the size (float) of the visibility box
      * note : this doesn't lock the SPS mesh bounding box.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     setVisibilityBox(size) {
         const vis = size / 2;
@@ -1517,14 +1517,14 @@ export class SolidParticleSystem {
     }
     /**
      * Gets whether the SPS as always visible or not
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     get isAlwaysVisible() {
         return this._alwaysVisible;
     }
     /**
      * Sets the SPS as always visible or not
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     set isAlwaysVisible(val) {
         this._alwaysVisible = val;
@@ -1532,7 +1532,7 @@ export class SolidParticleSystem {
     }
     /**
      * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     set isVisibilityBoxLocked(val) {
         this._isVisibilityBoxLocked = val;
@@ -1541,7 +1541,7 @@ export class SolidParticleSystem {
     }
     /**
      * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_visibility
      */
     get isVisibilityBoxLocked() {
         return this._isVisibilityBoxLocked;
@@ -1700,13 +1700,13 @@ export class SolidParticleSystem {
     /**
      * This function does nothing. It may be overwritten to set all the particle first values.
      * The SPS doesn't call this function, you may have to call it by your own.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/manage_sps_particles
      */
     initParticles() { }
     /**
      * This function does nothing. It may be overwritten to recycle a particle.
      * The SPS doesn't call this function, you may have to call it by your own.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/manage_sps_particles
      * @param particle The particle to recycle
      * @returns the recycled particle
      */
@@ -1716,7 +1716,7 @@ export class SolidParticleSystem {
     /**
      * Updates a particle : this function should  be overwritten by the user.
      * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/manage_sps_particles
      * @example : just set a particle position or velocity and recycle conditions
      * @param particle The particle to update
      * @returns the updated particle
@@ -1730,7 +1730,7 @@ export class SolidParticleSystem {
      * @param particle the current particle
      * @param vertex the current vertex of the current particle : a SolidParticleVertex object
      * @param pt the index of the current vertex in the particle shape
-     * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
+     * doc : https://doc.babylonjs.com/features/featuresDeepDive/particles/solid_particle_system/sps_vertices
      * @example : just set a vertex particle position or color
      * @returns the sps
      */