@babylonjs/core 5.24.0 → 5.25.0

package/scene.d.ts

@@ -129,13 +129,13 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * @returns The collision coordinator
      */
     static CollisionCoordinatorFactory(): ICollisionCoordinator;
-    /** @hidden */
+    /** @internal */
     _inputManager: InputManager;
     /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
     cameraToUseForPointers: Nullable<Camera>;
-    /** @hidden */
+    /** @internal */
     readonly _isScene = true;
-    /** @hidden */
+    /** @internal */
     _blockEntityCollection: boolean;
     /**
      * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
@@ -181,7 +181,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * this is easier to reference from here than from all the materials.
      */
     environmentIntensity: number;
-    /** @hidden */
+    /** @internal */
     protected _imageProcessingConfiguration: ImageProcessingConfiguration;
     /**
      * Default image processing configuration used either in the rendering
@@ -504,7 +504,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * By default this function is undefined and Babylon.js will select LOD based on distance to camera
      */
     customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
-    /** @hidden */
+    /** @internal */
     _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
     /**
      * Gets or sets a predicate used to select candidate meshes for a pointer down event
@@ -586,7 +586,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * @returns the scene UniformBuffer
      */
     finalizeSceneUbo(): UniformBuffer;
-    /** @hidden */
+    /** @internal */
     _mirroredCameraPosition: Nullable<Vector3>;
     /**
      * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
@@ -694,7 +694,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
     /** All of the active cameras added to this scene. */
     get activeCameras(): Nullable<Camera[]>;
     set activeCameras(cameras: Nullable<Camera[]>);
-    /** @hidden */
+    /** @internal */
     _activeCamera: Nullable<Camera>;
     /** Gets or sets the current active camera */
     get activeCamera(): Nullable<Camera>;
@@ -738,7 +738,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      */
     collisionsEnabled: boolean;
     private _collisionCoordinator;
-    /** @hidden */
+    /** @internal */
     get collisionCoordinator(): ICollisionCoordinator;
     /**
      * Defines the gravity applied to this scene (used only for collisions)
@@ -796,27 +796,27 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
     proceduralTexturesEnabled: boolean;
     private _engine;
     private _totalVertices;
-    /** @hidden */
+    /** @internal */
     _activeIndices: PerfCounter;
-    /** @hidden */
+    /** @internal */
     _activeParticles: PerfCounter;
-    /** @hidden */
+    /** @internal */
     _activeBones: PerfCounter;
     private _animationRatio;
-    /** @hidden */
+    /** @internal */
     _animationTimeLast: number;
-    /** @hidden */
+    /** @internal */
     _animationTime: number;
     /**
      * Gets or sets a general scale for animation speed
      * @see https://www.babylonjs-playground.com/#IBU2W7#3
      */
     animationTimeScale: number;
-    /** @hidden */
+    /** @internal */
     _cachedMaterial: Nullable<Material>;
-    /** @hidden */
+    /** @internal */
     _cachedEffect: Nullable<Effect>;
-    /** @hidden */
+    /** @internal */
     _cachedVisibility: Nullable<number>;
     private _renderId;
     private _frameId;
@@ -825,10 +825,10 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
     private _defaultFrameBufferCleared;
     private _viewUpdateFlag;
     private _projectionUpdateFlag;
-    /** @hidden */
+    /** @internal */
     _toBeDisposed: Nullable<IDisposable>[];
     private _activeRequests;
-    /** @hidden */
+    /** @internal */
     _pendingData: any[];
     private _isDisposed;
     /**
@@ -840,22 +840,22 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
     private _processedMaterials;
     private _renderTargets;
     private _materialsRenderTargets;
-    /** @hidden */
+    /** @internal */
     _activeParticleSystems: SmartArray<IParticleSystem>;
     private _activeSkeletons;
     private _softwareSkinnedMeshes;
     private _renderingManager;
-    /** @hidden */
+    /** @internal */
     _activeAnimatables: import("./Animations/animatable").Animatable[];
     private _transformMatrix;
     private _sceneUbo;
-    /** @hidden */
+    /** @internal */
     _viewMatrix: Matrix;
-    /** @hidden */
+    /** @internal */
     _projectionMatrix: Matrix;
-    /** @hidden */
+    /** @internal */
     _forcedViewPosition: Nullable<Vector3>;
-    /** @hidden */
+    /** @internal */
     _frustumPlanes: Plane[];
     /**
      * Gets the list of frustum planes (built from the active camera)
@@ -866,19 +866,19 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * This is useful if there are more lights that the maximum simulteanous authorized
      */
     requireLightSorting: boolean;
-    /** @hidden */
+    /** @internal */
     readonly useMaterialMeshMap: boolean;
-    /** @hidden */
+    /** @internal */
     readonly useClonedMeshMap: boolean;
     private _externalData;
     private _uid;
     /**
-     * @hidden
+     * @internal
      * Backing store of defined scene components.
      */
     _components: ISceneComponent[];
     /**
-     * @hidden
+     * @internal
      * Backing store of defined scene components.
      */
     _serializableComponents: ISceneSerializableComponent[];
@@ -891,7 +891,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      */
     private _registerTransientComponents;
     /**
-     * @hidden
+     * @internal
      * Add a component to the scene.
      * Note that the ccomponent could be registered on th next frame if this is called after
      * the register component stage.
@@ -899,119 +899,119 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      */
     _addComponent(component: ISceneComponent): void;
     /**
-     * @hidden
+     * @internal
      * Gets a component from the scene.
      * @param name defines the name of the component to retrieve
      * @returns the component or null if not present
      */
     _getComponent(name: string): Nullable<ISceneComponent>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening before camera updates.
      */
     _beforeCameraUpdateStage: Stage<SimpleStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening before clear the canvas.
      */
     _beforeClearStage: Stage<SimpleStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening before clear the canvas.
      */
     _beforeRenderTargetClearStage: Stage<RenderTargetStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions when collecting render targets for the frame.
      */
     _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening for one camera in the frame.
      */
     _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening during the per mesh ready checks.
      */
     _isReadyForMeshStage: Stage<MeshStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening before evaluate active mesh checks.
      */
     _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening during the evaluate sub mesh checks.
      */
     _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening during the active mesh stage.
      */
     _preActiveMeshStage: Stage<PreActiveMeshStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening during the per camera render target step.
      */
     _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just before the active camera is drawing.
      */
     _beforeCameraDrawStage: Stage<CameraStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just before a render target is drawing.
      */
     _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just before a rendering group is drawing.
      */
     _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just before a mesh is drawing.
      */
     _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just after a mesh has been drawn.
      */
     _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just after a rendering group has been drawn.
      */
     _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just after the active camera has been drawn.
      */
     _afterCameraDrawStage: Stage<CameraStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just after a render target has been drawn.
      */
     _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening just after rendering all cameras and computing intersections.
      */
     _afterRenderStage: Stage<SimpleStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening when a pointer move event happens.
      */
     _pointerMoveStage: Stage<PointerMoveStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening when a pointer down event happens.
      */
     _pointerDownStage: Stage<PointerUpDownStageAction>;
     /**
-     * @hidden
+     * @internal
      * Defines the actions happening when a pointer up event happens.
      */
     _pointerUpStage: Stage<PointerUpDownStageAction>;
@@ -1032,13 +1032,12 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
     getClassName(): string;
     private _defaultMeshCandidates;
     /**
-     * @hidden
+     * @internal
      */
     _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
     private _defaultSubMeshCandidates;
     /**
-     * @param mesh
-     * @hidden
+     * @internal
      */
     _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
     /**
@@ -1262,8 +1261,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      */
     whenReadyAsync(checkRenderTargets?: boolean): Promise<void>;
     /**
-     * @param checkRenderTargets
-     * @hidden
+     * @internal
      */
     _checkIsReady(checkRenderTargets?: boolean): void;
     /**
@@ -1801,7 +1799,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * Clear the info related to rendering groups preventing retention points during dispose.
      */
     freeRenderingGroups(): void;
-    /** @hidden */
+    /** @internal */
     _isInIntermediateRendering(): boolean;
     /**
      * Lambda returning the list of potentially active meshes.
@@ -1819,7 +1817,7 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * Lambda returning the list of potentially colliding sub meshes.
      */
     getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
-    /** @hidden */
+    /** @internal */
     _activeMeshesFrozen: boolean;
     _activeMeshesFrozenButKeepClipping: boolean;
     private _skipEvaluateActiveMeshesCompletely;
@@ -1848,27 +1846,23 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
     updateTransformMatrix(force?: boolean): void;
     private _bindFrameBuffer;
     private _clearFrameBuffer;
-    /** @hidden */
+    /** @internal */
     _allowPostProcessClearColor: boolean;
     /**
-     * @param camera
-     * @param rigParent
-     * @param bindFrameBuffer
-     * @hidden
+     * @internal
      */
     _renderForCamera(camera: Camera, rigParent?: Camera, bindFrameBuffer?: boolean): void;
     private _processSubCameras;
     private _checkIntersections;
     /**
-     * @param step
-     * @hidden
+     * @internal
      */
     _advancePhysicsEngineStep(step: number): void;
     /**
      * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
      */
     getDeterministicFrameTime: () => number;
-    /** @hidden */
+    /** @internal */
     _animate(): void;
     /** Execute all animations (for a frame) */
     animate(): void;
@@ -2020,9 +2014,9 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      * @returns a Mesh or null if no mesh is under the pointer
      */
     getPointerOverMesh(): Nullable<AbstractMesh>;
-    /** @hidden */
+    /** @internal */
     _rebuildGeometries(): void;
-    /** @hidden */
+    /** @internal */
     _rebuildTextures(): void;
     private _getByTags;
     /**
@@ -2097,59 +2091,27 @@ export declare class Scene extends AbstractScene implements IAnimatable, IClipPl
      */
     markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
     /**
-     * @param fileOrUrl
-     * @param onSuccess
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onError
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _loadFile(fileOrUrl: File | string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
     /**
-     * @param fileOrUrl
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _loadFileAsync(fileOrUrl: File | string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
     /**
-     * @param url
-     * @param onSuccess
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onError
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _requestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
     /**
-     * @param url
-     * @param onProgress
-     * @param useOfflineSupport
-     * @param useArrayBuffer
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
     /**
-     * @param file
-     * @param onSuccess
-     * @param onProgress
-     * @param useArrayBuffer
-     * @param onError
-     * @hidden
+     * @internal
      */
     _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
     /**
-     * @param file
-     * @param onProgress
-     * @param useArrayBuffer
-     * @hidden
+     * @internal
      */
     _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
     /**