gpu-curtains/dist/types/extras/loaders/GLTFLoader.d.ts

gpu-curtains is a 3D WebGPU rendering engine. It can be used as a standalone 3D engine, but also includes extra classes focused on mapping 3d objects to DOM elements; It allows users to synchronize values such as position, sizing, or scale between them.

import { GLTF } from '../../types/gltf/GLTF';
import { GLTFExtensions } from '../../types/gltf/GLTFExtensions';
/**
 * Defined the structure of the parsed result from the glTF json object.
 */
export interface GPUCurtainsGLTF extends Omit<GLTF.IGLTF, 'extensions'> {
    /** Array of {@link ArrayBuffer} used by the glTF. */
    arrayBuffers: ArrayBuffer[];
    /** Array of created {@link ImageBitmap}. */
    imagesBitmaps: ImageBitmap[];
    /** Top level extensions definitions. */
    extensions?: GLTFExtensions;
}
/**
 * Basic glTF loader class.
 *
 * Allow to load a glTF from an URI and create the associated {@link ArrayBuffer} and {@link ImageBitmap}.
 *
 * @example
 * ```javascript
 * const gltfLoader = new GLTFLoader()
 * const gltf = await gltfLoader.loadFromUrl('path/to/model.gltf')
 *
 * // create a gltfScenesManager from the resulting 'gltf' object
 * // assuming 'renderer' is a valid camera or curtains renderer
 * const gltfScenesManager = new GLTFScenesManager({ renderer, gltf })
 * gltfScenesManager.addMeshes()
 * ```
 */
export declare class GLTFLoader {
    /** The {@link GPUCurtainsGLTF} object result. */
    gltf: GPUCurtainsGLTF | null;
    /**
     * {@link GLTFLoader} constructor.
     */
    constructor();
    /**
     * Build the absolute uri of the resource
     * @param uri - uri of the resource
     * @param baseUrl - base url from which to get all the other assets.
     * @returns - absolute uri of the resource
     */
    static resolveUri(uri: string, baseUrl: string): string;
    /**
     * Load a glTF from the given url.
     * @param url - url of the glTF.
     * @returns - the {@link GPUCurtainsGLTF} created.
     */
    loadFromUrl(url: string): Promise<GPUCurtainsGLTF>;
    /**
     * Parse a {@link GLTF.IGLTF | glTF json} and create our {@link gltf} base object.
     * @param json - already parsed JSON content.
     * @param baseUrl - base url from which to get all the other assets.
     * @param binaryChunk - optional binary chunks.
     * @returns - {@link gltf} base object.
     */
    loadFromJsonBase(json: GLTF.IGLTF, baseUrl: string, binaryChunk?: Record<string, ArrayBuffer>): Promise<GPUCurtainsGLTF>;
    /**
     * Load a glTF from a .glb file.
     * @param arrayBuffer - {@link ArrayBuffer} containing the data.
     * @param baseUrl - base url from which to get all the other assets.
     * @returns - the {@link GPUCurtainsGLTF} created.
     */
    loadFromBinary(arrayBuffer: ArrayBuffer, baseUrl: string): Promise<GPUCurtainsGLTF>;
    /**
     * Load the glTF json, parse the data and create our {@link GPUCurtainsGLTF} object.
     * @param json - already parsed JSON content.
     * @param baseUrl - base url from which to get all the other assets.
     * @param binaryChunk - optional binary chunks.
     * @returns - the {@link GPUCurtainsGLTF} created.
     */
    loadFromJson(json: GLTF.IGLTF, baseUrl: string, binaryChunk?: Record<string, ArrayBuffer>): Promise<GPUCurtainsGLTF>;
}