@tresjs/cientos 4.3.1 → 5.0.0-next.1

package/dist/core/loaders/useGLTF/index.d.ts

@@ -1,39 +1,50 @@
-import { TresLoader, TresObject3D } from '@tresjs/core';
-import { DRACOLoader, GLTF } from 'three-stdlib';
-import { AnimationClip, Material, Scene } from 'three';
-export interface GLTFLoaderOptions {
+import { MaybeRef } from 'vue';
+import { GLTF } from 'three-stdlib';
+export interface UseGLTFOptions {
     /**
-     * Whether to use Draco compression.
-     *
+     * Whether to use DRACO compression for loading the model
      * @type {boolean}
-     * @memberof GLTFLoaderOptions
      */
     draco?: boolean;
     /**
-     * The path to the Draco decoder.
-     *
+     * Path to the DRACO decoder. Defaults to https://www.gstatic.com/draco/versioned/decoders/1.5.6/
      * @type {string}
-     * @memberof GLTFLoaderOptions
      */
     decoderPath?: string;
 }
-export interface GLTFResult {
-    animations: Array<AnimationClip>;
-    nodes: Record<string, TresObject3D>;
-    materials: Record<string, Material>;
-    scene: Scene;
-}
-export interface TresGLTFLoaderType extends TresLoader<GLTF> {
-    setDRACOLoader?: (dracoLoader: DRACOLoader) => void;
-}
 /**
- * Loads a GLTF file and returns a THREE.Object3D.
+ * Vue composable for loading GLTF models in TresJS
+ *
+ * @remarks
+ * This composable uses Three.js GLTFLoader under the hood and supports DRACO compression.
+ * When DRACO compression is enabled, it will use the specified decoder path or fallback to Google's CDN.
+ *
+ * @example
+ * ```ts
+ * const { state: model } = useGLTF('/path/to/model.glb', { draco: true })
+ * ```
  *
- * @export
- * @template T
- * @param {T} path - Path or array of paths to the GLTF file(s)
- * @param {GLTFLoaderOptions} [options] - Options for the loader
- * @param {(loader: TresGLTFLoaderType) => void} [extendLoader] - Function to extend the loader
- * @returns {Promise<T extends string[] ? GLTFResult[] : GLTFResult>} Promise that resolves with the loaded model(s)
+ * @param {MaybeRef<string>} path - Path to the GLTF model file
+ * @param {UseGLTFOptions} options - Options for loading the model
+ * @returns {{ state: GLTF, isLoading: boolean, execute: () => Promise<void> }} Object containing the model state, loading state and reload function
  */
-export declare function useGLTF<T extends string | string[]>(path: T, options?: GLTFLoaderOptions, extendLoader?: (loader: TresGLTFLoaderType) => void): Promise<T extends string[] ? GLTFResult[] : GLTFResult>;
+export declare function useGLTF(path: MaybeRef<string>, options?: UseGLTFOptions): {
+    nodes: import('vue').ComputedRef<{
+        [name: string]: import('three').Object3D<import('three').Object3DEventMap>;
+    }>;
+    materials: import('vue').ComputedRef<{
+        [name: string]: import('three').Material;
+    }>;
+    state: import('vue').Ref<GLTF, GLTF>;
+    isReady: import('vue').Ref<boolean>;
+    isLoading: import('vue').Ref<boolean>;
+    error: import('vue').Ref<unknown>;
+    execute: (delay?: number, args_0: string) => Promise<GLTF>;
+    then<TResult1 = import('@vueuse/core').UseAsyncStateReturnBase<GLTF, [string], true>, TResult2 = never>(onfulfilled?: ((value: import('@vueuse/core').UseAsyncStateReturnBase<GLTF, [string], true>) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): PromiseLike<TResult1 | TResult2>;
+    load: (path: string) => void;
+    progress: {
+        loaded: number;
+        total: number;
+        percentage: number;
+    };
+};