@loaders.gl/gltf 4.0.0-alpha.1 → 4.0.0-alpha.11

package/dist/lib/api/gltf-scenegraph.d.ts

@@ -0,0 +1,180 @@
+import type { GLTFWithBuffers } from '../types/gltf-types';
+import type { GLTF, GLTFScene, GLTFNode, GLTFMesh, GLTFSkin, GLTFMaterial, GLTFAccessor, GLTFSampler, GLTFTexture, GLTFImage, GLTFBuffer, GLTFBufferView } from '../types/gltf-json-schema';
+type Extension = {
+    [key: string]: any;
+};
+/**
+ * Class for structured access to GLTF data
+ */
+export declare class GLTFScenegraph {
+    gltf: GLTFWithBuffers;
+    sourceBuffers: any[];
+    byteLength: number;
+    constructor(gltf?: {
+        json: GLTF;
+        buffers?: any[];
+        images?: any[];
+    });
+    get json(): GLTF;
+    getApplicationData(key: string): unknown;
+    getExtraData(key: string): {
+        [key: string]: unknown;
+    };
+    hasExtension(extensionName: string): boolean;
+    getExtension<T = Extension>(extensionName: string): T | null;
+    getRequiredExtension<T = Extension>(extensionName: string): T | null;
+    getRequiredExtensions(): string[];
+    getUsedExtensions(): string[];
+    getRemovedExtensions(): string[];
+    getObjectExtension<T = Extension>(object: {
+        [key: string]: any;
+    }, extensionName: string): T | null;
+    getScene(index: number): GLTFScene;
+    getNode(index: number): GLTFNode;
+    getSkin(index: number): GLTFSkin;
+    getMesh(index: number): GLTFMesh;
+    getMaterial(index: number): GLTFMaterial;
+    getAccessor(index: number): GLTFAccessor;
+    getTexture(index: number): GLTFTexture;
+    getSampler(index: number): GLTFSampler;
+    getImage(index: number): GLTFImage;
+    getBufferView(index: number | object): GLTFBufferView;
+    getBuffer(index: number): GLTFBuffer;
+    getObject(array: string, index: number | object): object;
+    /**
+     * Accepts buffer view index or buffer view object
+     * @returns a `Uint8Array`
+     */
+    getTypedArrayForBufferView(bufferView: number | object): Uint8Array;
+    /** Accepts accessor index or accessor object
+     * @returns a typed array with type that matches the types
+     */
+    getTypedArrayForAccessor(accessor: number | object): any;
+    /** accepts accessor index or accessor object
+     * returns a `Uint8Array`
+     */
+    getTypedArrayForImageData(image: number | object): Uint8Array;
+    /**
+     * Add an extra application-defined key to the top-level data structure
+     */
+    addApplicationData(key: string, data: object): GLTFScenegraph;
+    /**
+     * `extras` - Standard GLTF field for storing application specific data
+     */
+    addExtraData(key: string, data: object): GLTFScenegraph;
+    addObjectExtension(object: object, extensionName: string, data: object): GLTFScenegraph;
+    setObjectExtension(object: any, extensionName: string, data: object): void;
+    removeObjectExtension(object: any, extensionName: string): void;
+    /**
+     * Add to standard GLTF top level extension object, mark as used
+     */
+    addExtension(extensionName: string, extensionData?: object): object;
+    /**
+     * Standard GLTF top level extension object, mark as used and required
+     */
+    addRequiredExtension(extensionName: any, extensionData?: object): object;
+    /**
+     * Add extensionName to list of used extensions
+     */
+    registerUsedExtension(extensionName: string): void;
+    /**
+     * Add extensionName to list of required extensions
+     */
+    registerRequiredExtension(extensionName: string): void;
+    /**
+     * Removes an extension from the top-level list
+     */
+    removeExtension(extensionName: string): void;
+    /**
+     *  Set default scene which is to be displayed at load time
+     */
+    setDefaultScene(sceneIndex: number): void;
+    /**
+     * @todo: add more properties for scene initialization:
+     *   name`, `extensions`, `extras`
+     *   https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#reference-scene
+     */
+    addScene(scene: {
+        nodeIndices: number[];
+    }): number;
+    /**
+     * @todo: add more properties for node initialization:
+     *   `name`, `extensions`, `extras`, `camera`, `children`, `skin`, `rotation`, `scale`, `translation`, `weights`
+     *   https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#node
+     */
+    addNode(node: {
+        meshIndex: number;
+        matrix?: number[];
+    }): number;
+    /** Adds a mesh to the json part */
+    addMesh(mesh: {
+        attributes: object;
+        indices?: object;
+        material?: number;
+        mode?: number;
+    }): number;
+    addPointCloud(attributes: object): number;
+    /**
+     * Adds a binary image. Builds glTF "JSON metadata" and saves buffer reference
+     * Buffer will be copied into BIN chunk during "pack"
+     * Currently encodes as glTF image
+     * @param imageData
+     * @param mimeType
+     */
+    addImage(imageData: any, mimeTypeOpt?: string): number;
+    /**
+     * Add one untyped source buffer, create a matching glTF `bufferView`, and return its index
+     * @param buffer
+     */
+    addBufferView(buffer: any, bufferIndex?: number, byteOffset?: number): number;
+    /**
+     * Adds an accessor to a bufferView
+     * @param bufferViewIndex
+     * @param accessor
+     */
+    addAccessor(bufferViewIndex: number, accessor: object): number;
+    /**
+     * Add a binary buffer. Builds glTF "JSON metadata" and saves buffer reference
+     * Buffer will be copied into BIN chunk during "pack"
+     * Currently encodes buffers as glTF accessors, but this could be optimized
+     * @param sourceBuffer
+     * @param accessor
+     */
+    addBinaryBuffer(sourceBuffer: any, accessor?: object): number;
+    /**
+     * Adds a texture to the json part
+     * @todo: add more properties for texture initialization
+     * `sampler`, `name`, `extensions`, `extras`
+     * https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#texture
+     */
+    addTexture(texture: {
+        imageIndex: number;
+    }): number;
+    /** Adds a material to the json part */
+    addMaterial(pbrMaterialInfo: Object): number;
+    /** Pack the binary chunk */
+    createBinaryChunk(): void;
+    _removeStringFromArray(array: any, string: any): void;
+    /**
+     * Add attributes to buffers and create `attributes` object which is part of `mesh`
+     */
+    _addAttributes(attributes?: {}): {};
+    /**
+     * Add indices to buffers
+     */
+    _addIndices(indices: any): number;
+    /**
+     * Deduce gltf specific attribue name from input attribute name
+     */
+    _getGltfAttributeName(attributeName: any): any;
+    /**
+     * Calculate `min` and `max` arrays of accessor according to spec:
+     * https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#reference-accessor
+     */
+    _getAccessorMinMax(buffer: any, size: any): {
+        min: null;
+        max: null;
+    };
+}
+export {};
+//# sourceMappingURL=gltf-scenegraph.d.ts.map

package/dist/lib/api/gltf-scenegraph.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gltf-scenegraph.d.ts","sourceRoot":"","sources":["../../../src/lib/api/gltf-scenegraph.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,qBAAqB,CAAC;AACzD,OAAO,KAAK,EACV,IAAI,EACJ,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,WAAW,EACX,SAAS,EACT,UAAU,EACV,cAAc,EACf,MAAM,2BAA2B,CAAC;AAWnC,KAAK,SAAS,GAAG;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,CAAC;AAetC;;GAEG;AACH,qBAAa,cAAc;IAEzB,IAAI,EAAE,eAAe,CAAC;IACtB,aAAa,EAAE,GAAG,EAAE,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;gBAGP,IAAI,CAAC,EAAE;QAAC,IAAI,EAAE,IAAI,CAAC;QAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAA;KAAC;IAoBhE,IAAI,IAAI,IAAI,IAAI,CAEf;IAED,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAMxC,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC;IAMnD,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO;IAM5C,YAAY,CAAC,CAAC,GAAG,SAAS,EAAE,aAAa,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAM5D,oBAAoB,CAAC,CAAC,GAAG,SAAS,EAAE,aAAa,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAKpE,qBAAqB,IAAI,MAAM,EAAE;IAIjC,iBAAiB,IAAI,MAAM,EAAE;IAI7B,oBAAoB,IAAI,MAAM,EAAE;IAIhC,kBAAkB,CAAC,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,EAAE,aAAa,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAKhG,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS;IAIlC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAIhC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAIhC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ;IAIhC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAIxC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY;IAQxC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAItC,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAItC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS;IAIlC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,cAAc;IAIrD,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU;IAIpC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAYxD;;;OAGG;IACH,0BAA0B,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU;IAgBnE;;OAEG;IACH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG;IAgBxD;;OAEG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU;IAe7D;;OAEG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAK7D;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAMvD,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc;IAUvF,kBAAkB,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAM1E,qBAAqB,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI;IAc/D;;OAEG;IACH,YAAY,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,GAAE,MAAW,GAAG,MAAM;IAQvE;;OAEG;IACH,oBAAoB,CAAC,aAAa,KAAA,EAAE,aAAa,GAAE,MAAW,GAAG,MAAM;IAOvE;;OAEG;IACH,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAOlD;;OAEG;IACH,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAQtD;;OAEG;IACH,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI;IAmB5C;;OAEG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAIzC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE;QAAC,WAAW,EAAE,MAAM,EAAE,CAAA;KAAC,GAAG,MAAM;IAOhD;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAAC,GAAG,MAAM;IAY7D,mCAAmC;IACnC,OAAO,CAAC,IAAI,EAAE;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,MAAM;IA6B/F,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAkBzC;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM;IAmBtD;;;OAGG;IACH,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,WAAW,SAAI,EAAE,UAAU,SAAkB,GAAG,MAAM;IAyBjF;;;;OAIG;IACH,WAAW,CAAC,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM;IAoB9D;;;;;;OAMG;IACH,eAAe,CAAC,YAAY,EAAE,GAAG,EAAE,QAAQ,GAAE,MAAkB,GAAG,MAAM;IAsBxE;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE;QAAC,UAAU,EAAE,MAAM,CAAA;KAAC,GAAG,MAAM;IAWjD,uCAAuC;IACvC,WAAW,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM;IAM5C,4BAA4B;IAC5B,iBAAiB,IAAI,IAAI;IA+BzB,sBAAsB,CAAC,KAAK,KAAA,EAAE,MAAM,KAAA;IAYpC;;OAEG;IACH,cAAc,CAAC,UAAU,KAAK;IAW9B;;OAEG;IACH,WAAW,CAAC,OAAO,KAAA;IAInB;;OAEG;IACH,qBAAqB,CAAC,aAAa,KAAA;IAoBnC;;;OAGG;IACH,kBAAkB,CAAC,MAAM,KAAA,EAAE,IAAI,KAAA;;;;CAmChC"}