@babylonjs/loaders 5.24.0 → 5.26.0

package/glTF/glTFFileLoader.d.ts

@@ -91,7 +91,7 @@ export declare enum GLTFLoaderState {
      */
     COMPLETE = 2
 }
-/** @hidden */
+/** @internal */
 export interface IGLTFLoader extends IDisposable {
     importMeshAsync: (meshesNames: any, scene: Scene, container: Nullable<AssetContainer>, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string) => Promise<ISceneLoaderAsyncResult>;
     loadAsync: (scene: Scene, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string) => Promise<void>;
@@ -100,9 +100,9 @@ export interface IGLTFLoader extends IDisposable {
  * File loader for loading glTF files into a scene.
  */
 export declare class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISceneLoaderPluginFactory {
-    /** @hidden */
+    /** @internal */
     static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
-    /** @hidden */
+    /** @internal */
     static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
     /**
      * Raised when the asset has been parsed
@@ -117,13 +117,13 @@ export declare class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAs
      * Set this property to false to disable incremental loading which delays the loader from calling the success callback until after loading the meshes and shaders.
      * Textures always loads asynchronously. For example, the success callback can compute the bounding information of the loaded meshes when incremental loading is disabled.
      * Defaults to true.
-     * @hidden
+     * @internal
      */
     static IncrementalLoading: boolean;
     /**
      * Set this property to true in order to work with homogeneous coordinates, available with some converters and exporters.
      * Defaults to false. See https://en.wikipedia.org/wiki/Homogeneous_coordinates.
-     * @hidden
+     * @internal
      */
     static HomogeneousCoordinates: boolean;
     /**
@@ -317,59 +317,34 @@ export declare class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAs
      * Name of the loader ("gltf")
      */
     name: string;
-    /** @hidden */
+    /** @internal */
     extensions: ISceneLoaderPluginExtensions;
     /**
      * Disposes the loader, releases resources during load, and cancels any outstanding requests.
      */
     dispose(): void;
     /**
-     * @param scene
-     * @param fileOrUrl
-     * @param onSuccess
-     * @param onProgress
-     * @param useArrayBuffer
-     * @param onError
-     * @hidden
+     * @internal
      */
     loadFile(scene: Scene, fileOrUrl: File | string, onSuccess: (data: any, responseURL?: string) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
     /**
-     * @param meshesNames
-     * @param scene
-     * @param data
-     * @param rootUrl
-     * @param onProgress
-     * @param fileName
-     * @hidden
+     * @internal
      */
     importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<ISceneLoaderAsyncResult>;
     /**
-     * @param scene
-     * @param data
-     * @param rootUrl
-     * @param onProgress
-     * @param fileName
-     * @hidden
+     * @internal
      */
     loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
     /**
-     * @param scene
-     * @param data
-     * @param rootUrl
-     * @param onProgress
-     * @param fileName
-     * @hidden
+     * @internal
      */
     loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
     /**
-     * @param data
-     * @hidden
+     * @internal
      */
     canDirectLoad(data: string): boolean;
     /**
-     * @param scene
-     * @param data
-     * @hidden
+     * @internal
      */
     directLoad(scene: Scene, data: string): Promise<any>;
     /**
@@ -379,7 +354,7 @@ export declare class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAs
      * @returns the new root url
      */
     rewriteRootURL?(rootUrl: string, responseURL?: string): string;
-    /** @hidden */
+    /** @internal */
     createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
     /**
      * The loader state or null if the loader is not active.
@@ -395,18 +370,11 @@ export declare class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAs
      */
     whenCompleteAsync(): Promise<void>;
     /**
-     * @param state
-     * @hidden
+     * @internal
      */
     _setState(state: GLTFLoaderState): void;
     /**
-     * @param scene
-     * @param fileOrUrl
-     * @param onSuccess
-     * @param useArrayBuffer
-     * @param onError
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _loadFile(scene: Scene, fileOrUrl: File | string, onSuccess: (data: string | ArrayBuffer) => void, useArrayBuffer?: boolean, onError?: (request?: WebRequest) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
     private _onProgress;
@@ -421,21 +389,20 @@ export declare class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAs
     private static readonly _logSpaces;
     private _logIndentLevel;
     private _loggingEnabled;
-    /** @hidden */
+    /** @internal */
     _log: (message: string) => void;
     /**
-     * @param message
-     * @hidden
+     * @internal
      */
     _logOpen(message: string): void;
-    /** @hidden */
+    /** @internal */
     _logClose(): void;
     private _logEnabled;
     private _logDisabled;
     private _capturePerformanceCounters;
-    /** @hidden */
+    /** @internal */
     _startPerformanceCounter: (counterName: string) => void;
-    /** @hidden */
+    /** @internal */
     _endPerformanceCounter: (counterName: string) => void;
     private _startPerformanceCounterEnabled;
     private _startPerformanceCounterDisabled;

package/glTF/glTFFileLoader.js

@@ -208,7 +208,7 @@ export class GLTFFileLoader {
          * Name of the loader ("gltf")
          */
         this.name = "gltf";
-        /** @hidden */
+        /** @internal */
         this.extensions = {
             ".gltf": { isBinary: false },
             ".glb": { isBinary: true },
@@ -219,12 +219,12 @@ export class GLTFFileLoader {
         this.onLoaderStateChangedObservable = new Observable();
         this._logIndentLevel = 0;
         this._loggingEnabled = false;
-        /** @hidden */
+        /** @internal */
         this._log = this._logDisabled;
         this._capturePerformanceCounters = false;
-        /** @hidden */
+        /** @internal */
         this._startPerformanceCounter = this._startPerformanceCounterDisabled;
-        /** @hidden */
+        /** @internal */
         this._endPerformanceCounter = this._endPerformanceCounterDisabled;
     }
     /**
@@ -383,13 +383,7 @@ export class GLTFFileLoader {
         this.onDisposeObservable.clear();
     }
     /**
-     * @param scene
-     * @param fileOrUrl
-     * @param onSuccess
-     * @param onProgress
-     * @param useArrayBuffer
-     * @param onError
-     * @hidden
+     * @internal
      */
     loadFile(scene, fileOrUrl, onSuccess, onProgress, useArrayBuffer, onError) {
         this._progressCallback = onProgress;
@@ -440,13 +434,7 @@ export class GLTFFileLoader {
         }, useArrayBuffer, onError);
     }
     /**
-     * @param meshesNames
-     * @param scene
-     * @param data
-     * @param rootUrl
-     * @param onProgress
-     * @param fileName
-     * @hidden
+     * @internal
      */
     importMeshAsync(meshesNames, scene, data, rootUrl, onProgress, fileName) {
         return Promise.resolve().then(() => {
@@ -458,12 +446,7 @@ export class GLTFFileLoader {
         });
     }
     /**
-     * @param scene
-     * @param data
-     * @param rootUrl
-     * @param onProgress
-     * @param fileName
-     * @hidden
+     * @internal
      */
     loadAsync(scene, data, rootUrl, onProgress, fileName) {
         return Promise.resolve().then(() => {
@@ -475,12 +458,7 @@ export class GLTFFileLoader {
         });
     }
     /**
-     * @param scene
-     * @param data
-     * @param rootUrl
-     * @param onProgress
-     * @param fileName
-     * @hidden
+     * @internal
      */
     loadAssetContainerAsync(scene, data, rootUrl, onProgress, fileName) {
         return Promise.resolve().then(() => {
@@ -519,8 +497,7 @@ export class GLTFFileLoader {
         });
     }
     /**
-     * @param data
-     * @hidden
+     * @internal
      */
     canDirectLoad(data) {
         return ((data.indexOf("asset") !== -1 && data.indexOf("version") !== -1) ||
@@ -530,9 +507,7 @@ export class GLTFFileLoader {
             data.startsWith("data:model/gltf-binary;base64," + GLTFFileLoader._MagicBase64Encoded));
     }
     /**
-     * @param scene
-     * @param data
-     * @hidden
+     * @internal
      */
     directLoad(scene, data) {
         if (data.startsWith("base64," + GLTFFileLoader._MagicBase64Encoded) || // this is technically incorrect, but will continue to support for backcompat.
@@ -549,7 +524,7 @@ export class GLTFFileLoader {
         this._validate(scene, data);
         return Promise.resolve({ json: this._parseJson(data) });
     }
-    /** @hidden */
+    /** @internal */
     createPlugin() {
         return new GLTFFileLoader();
     }
@@ -574,8 +549,7 @@ export class GLTFFileLoader {
         });
     }
     /**
-     * @param state
-     * @hidden
+     * @internal
      */
     _setState(state) {
         if (this._state === state) {
@@ -586,13 +560,7 @@ export class GLTFFileLoader {
         this._log(GLTFLoaderState[this._state]);
     }
     /**
-     * @param scene
-     * @param fileOrUrl
-     * @param onSuccess
-     * @param useArrayBuffer
-     * @param onError
-     * @param onOpened
-     * @hidden
+     * @internal
      */
     _loadFile(scene, fileOrUrl, onSuccess, useArrayBuffer, onError, onOpened) {
         const request = scene._loadFile(fileOrUrl, onSuccess, (event) => {
@@ -819,14 +787,13 @@ export class GLTFFileLoader {
         return 0;
     }
     /**
-     * @param message
-     * @hidden
+     * @internal
      */
     _logOpen(message) {
         this._log(message);
         this._logIndentLevel++;
     }
-    /** @hidden */
+    /** @internal */
     _logClose() {
         --this._logIndentLevel;
     }
@@ -851,13 +818,13 @@ export class GLTFFileLoader {
  * Set this property to false to disable incremental loading which delays the loader from calling the success callback until after loading the meshes and shaders.
  * Textures always loads asynchronously. For example, the success callback can compute the bounding information of the loaded meshes when incremental loading is disabled.
  * Defaults to true.
- * @hidden
+ * @internal
  */
 GLTFFileLoader.IncrementalLoading = true;
 /**
  * Set this property to true in order to work with homogeneous coordinates, available with some converters and exporters.
  * Defaults to false. See https://en.wikipedia.org/wiki/Homogeneous_coordinates.
- * @hidden
+ * @internal
  */
 GLTFFileLoader.HomogeneousCoordinates = false;
 GLTFFileLoader._MagicBase64Encoded = "Z2xURg"; // "glTF" base64 encoded (without the quotes!)