@realsee/five 5.0.0-alpha.11 → 5.0.0-alpha.112

package/gltf-loader/index.d.ts

@@ -0,0 +1,75 @@
+import { GLTFLoader as GLTFLoader_2 } from 'three/examples/jsm/loaders/GLTFLoader';
+import type { GLTFParser } from 'three/examples/jsm/loaders/GLTFLoader';
+import * as THREE_2 from 'three';
+
+/**
+ * GLTFLoader 返回数据
+ * @description
+ * 一般情况下，gltf.scene 为模型对象，直接通过 `five.scene.add(gltf.scene)` 即可添加到场景
+ * Five 的模型单位 1 为 1米，载入的模型单位标准不一，请自行 scale。
+ * 如果涉及模型内置动画，GLTF 已经帮你封装了，通过 `gltf.animations` 可以获取动画帧。gltf.scene.mixer 为对应的 动画混合器。
+ * 通过 `gltf.scene.mixer.clipAction(gltf.animations[0]).play()` 即可播放动画。
+ */
+export declare interface GLTF {
+    animations: THREE_2.AnimationClip[];
+    scene: GLTFObject;
+    scenes: GLTFObject[];
+    cameras: THREE_2.Camera[];
+    asset: {
+        copyright?: string;
+        generator?: string;
+        version?: string;
+        minVersion?: string;
+        extensions?: any;
+        extras?: any;
+    };
+    parser: GLTFParser;
+    userData: any;
+}
+
+/**
+ * GLTF 模型加载器
+ */
+export declare class GLTFLoader extends GLTFLoader_2 {
+    /**
+     * GLTF 模型加载器
+     *
+     * @example
+     * ```
+     * const gltfLoader = new GLTFLoader();
+     * gltfLoader.load("http://vrlab-public.ljcdn.com/release/static/image/release/five/demo/gltf/plants/scene.gltf", ({ scene }) => {
+     *   five.scene.add(scene);
+     * });
+     * ```
+     */
+    constructor(manager?: THREE_2.LoadingManager);
+    /**
+     * 加载模型
+     * @param url - 模型 URL
+     * @param onLoad - 加载完成回调
+     * @param onProgress - 加载进度回调
+     * @param onError - 加载错误回调
+     */
+    load(url: string, onLoad: (gltf: GLTF) => void, onProgress?: (event: ProgressEvent) => void, onError?: (event: ErrorEvent) => void): void;
+    parse(data: ArrayBuffer | string, path: string, onLoad: (gltf: GLTF) => void, onError?: (event: ErrorEvent) => void): void;
+}
+
+/**
+ * GLTF 对象
+ */
+export declare class GLTFObject extends THREE_2.Group {
+    needsRender: boolean;
+    /**
+     * mixer 为对应当前对象的动画混合器
+     * @description
+     * 通过 `gltf.animations` 可以获取动画帧。
+     * 通过 `gltf.scene.mixer.clipAction(gltf.animations[0]).play()` 即可播放动画。
+     */
+    mixer: THREE_2.AnimationMixer;
+    constructor(rootObject?: THREE_2.Object3D);
+    clone(): this;
+}
+
+export { GLTFParser }
+
+export { }