import Check from "../Core/Check.js"; import ComponentDatatype from "../Core/ComponentDatatype.js"; import defaultValue from "../Core/defaultValue.js"; import defer from "../Core/defer.js"; import defined from "../Core/defined.js"; import IndexDatatype from "../Core/IndexDatatype.js"; import Buffer from "../Renderer/Buffer.js"; import BufferUsage from "../Renderer/BufferUsage.js"; import JobType from "./JobType.js"; import ResourceLoader from "./ResourceLoader.js"; import ResourceLoaderState from "./ResourceLoaderState.js"; /** * Loads an index buffer from a glTF accessor. *

* Implements the {@link ResourceLoader} interface. *

* * @alias GltfIndexBufferLoader * @constructor * @augments ResourceLoader * * @param {Object} options Object with the following properties: * @param {ResourceCache} options.resourceCache The {@link ResourceCache} (to avoid circular dependencies). * @param {Object} options.gltf The glTF JSON. * @param {Number} options.accessorId The accessor ID corresponding to the index buffer. * @param {Resource} options.gltfResource The {@link Resource} containing the glTF. * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to. * @param {Object} [options.draco] The Draco extension object. * @param {String} [options.cacheKey] The cache key of the resource. * @param {Boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created. * @param {Boolean} [loadAsTypedArray=false] Load index buffer as a typed array instead of a GPU index buffer. * * @private */ export default function GltfIndexBufferLoader(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); const resourceCache = options.resourceCache; const gltf = options.gltf; const accessorId = options.accessorId; const gltfResource = options.gltfResource; const baseResource = options.baseResource; const draco = options.draco; const cacheKey = options.cacheKey; const asynchronous = defaultValue(options.asynchronous, true); const loadAsTypedArray = defaultValue(options.loadAsTypedArray, false); //>>includeStart('debug', pragmas.debug); Check.typeOf.func("options.resourceCache", resourceCache); Check.typeOf.object("options.gltf", gltf); Check.typeOf.number("options.accessorId", accessorId); Check.typeOf.object("options.gltfResource", gltfResource); Check.typeOf.object("options.baseResource", baseResource); //>>includeEnd('debug'); const indexDatatype = gltf.accessors[accessorId].componentType; this._resourceCache = resourceCache; this._gltfResource = gltfResource; this._baseResource = baseResource; this._gltf = gltf; this._accessorId = accessorId; this._indexDatatype = indexDatatype; this._draco = draco; this._cacheKey = cacheKey; this._asynchronous = asynchronous; this._loadAsTypedArray = loadAsTypedArray; this._bufferViewLoader = undefined; this._dracoLoader = undefined; this._typedArray = undefined; this._buffer = undefined; this._state = ResourceLoaderState.UNLOADED; this._promise = defer(); } if (defined(Object.create)) { GltfIndexBufferLoader.prototype = Object.create(ResourceLoader.prototype); GltfIndexBufferLoader.prototype.constructor = GltfIndexBufferLoader; } Object.defineProperties(GltfIndexBufferLoader.prototype, { /** * A promise that resolves to the resource when the resource is ready. * * @memberof GltfIndexBufferLoader.prototype * * @type {Promise.} * @readonly * @private */ promise: { get: function () { return this._promise.promise; }, }, /** * The cache key of the resource. * * @memberof GltfIndexBufferLoader.prototype * * @type {String} * @readonly * @private */ cacheKey: { get: function () { return this._cacheKey; }, }, /** * The index buffer. This is only defined when loadAsTypedArray is false. * * @memberof GltfIndexBufferLoader.prototype * * @type {Buffer} * @readonly * @private */ buffer: { get: function () { return this._buffer; }, }, /** * The typed array containing indices. This is only defined when loadAsTypedArray is true. * * @memberof GltfIndexBufferLoader.prototype * * @type {Uint8Array|Uint16Array|Uint32Array} * @readonly * @private */ typedArray: { get: function () { return this._typedArray; }, }, /** * The index datatype after decode. * * @memberof GltfIndexBufferLoader.prototype * * @type {IndexDatatype} * @readonly * @private */ indexDatatype: { get: function () { return this._indexDatatype; }, }, }); /** * Loads the resource. * @private */ GltfIndexBufferLoader.prototype.load = function () { if (defined(this._draco)) { loadFromDraco(this); } else { loadFromBufferView(this); } }; function loadFromDraco(indexBufferLoader) { const resourceCache = indexBufferLoader._resourceCache; const dracoLoader = resourceCache.loadDraco({ gltf: indexBufferLoader._gltf, draco: indexBufferLoader._draco, gltfResource: indexBufferLoader._gltfResource, baseResource: indexBufferLoader._baseResource, }); indexBufferLoader._dracoLoader = dracoLoader; indexBufferLoader._state = ResourceLoaderState.LOADING; dracoLoader.promise .then(function () { if (indexBufferLoader.isDestroyed()) { return; } // Now wait for process() to run to finish loading const typedArray = dracoLoader.decodedData.indices.typedArray; indexBufferLoader._typedArray = typedArray; // The index datatype may be a smaller datatype after draco decode indexBufferLoader._indexDatatype = ComponentDatatype.fromTypedArray( typedArray ); indexBufferLoader._state = ResourceLoaderState.PROCESSING; }) .catch(function (error) { if (indexBufferLoader.isDestroyed()) { return; } handleError(indexBufferLoader, error); }); } function loadFromBufferView(indexBufferLoader) { const gltf = indexBufferLoader._gltf; const accessorId = indexBufferLoader._accessorId; const accessor = gltf.accessors[accessorId]; const bufferViewId = accessor.bufferView; const resourceCache = indexBufferLoader._resourceCache; const bufferViewLoader = resourceCache.loadBufferView({ gltf: gltf, bufferViewId: bufferViewId, gltfResource: indexBufferLoader._gltfResource, baseResource: indexBufferLoader._baseResource, }); indexBufferLoader._state = ResourceLoaderState.LOADING; indexBufferLoader._bufferViewLoader = bufferViewLoader; bufferViewLoader.promise .then(function () { if (indexBufferLoader.isDestroyed()) { return; } // Now wait for process() to run to finish loading const bufferViewTypedArray = bufferViewLoader.typedArray; indexBufferLoader._typedArray = createIndicesTypedArray( indexBufferLoader, bufferViewTypedArray ); indexBufferLoader._state = ResourceLoaderState.PROCESSING; }) .catch(function (error) { if (indexBufferLoader.isDestroyed()) { return; } handleError(indexBufferLoader, error); }); } function createIndicesTypedArray(indexBufferLoader, bufferViewTypedArray) { const gltf = indexBufferLoader._gltf; const accessorId = indexBufferLoader._accessorId; const accessor = gltf.accessors[accessorId]; const count = accessor.count; const indexDatatype = accessor.componentType; const arrayBuffer = bufferViewTypedArray.buffer; const byteOffset = bufferViewTypedArray.byteOffset + accessor.byteOffset; let typedArray; if (indexDatatype === IndexDatatype.UNSIGNED_BYTE) { typedArray = new Uint8Array(arrayBuffer, byteOffset, count); } else if (indexDatatype === IndexDatatype.UNSIGNED_SHORT) { typedArray = new Uint16Array(arrayBuffer, byteOffset, count); } else if (indexDatatype === IndexDatatype.UNSIGNED_INT) { typedArray = new Uint32Array(arrayBuffer, byteOffset, count); } return typedArray; } function handleError(indexBufferLoader, error) { indexBufferLoader.unload(); indexBufferLoader._state = ResourceLoaderState.FAILED; const errorMessage = "Failed to load index buffer"; error = indexBufferLoader.getError(errorMessage, error); indexBufferLoader._promise.reject(error); } function CreateIndexBufferJob() { this.typedArray = undefined; this.indexDatatype = undefined; this.context = undefined; this.buffer = undefined; } CreateIndexBufferJob.prototype.set = function ( typedArray, indexDatatype, context ) { this.typedArray = typedArray; this.indexDatatype = indexDatatype; this.context = context; }; CreateIndexBufferJob.prototype.execute = function () { this.buffer = createIndexBuffer( this.typedArray, this.indexDatatype, this.context ); }; function createIndexBuffer(typedArray, indexDatatype, context) { const buffer = Buffer.createIndexBuffer({ typedArray: typedArray, context: context, usage: BufferUsage.STATIC_DRAW, indexDatatype: indexDatatype, }); buffer.vertexArrayDestroyable = false; return buffer; } const scratchIndexBufferJob = new CreateIndexBufferJob(); /** * Processes the resource until it becomes ready. * * @param {FrameState} frameState The frame state. * @private */ GltfIndexBufferLoader.prototype.process = function (frameState) { //>>includeStart('debug', pragmas.debug); Check.typeOf.object("frameState", frameState); //>>includeEnd('debug'); if (this._state === ResourceLoaderState.READY) { return; } const typedArray = this._typedArray; const indexDatatype = this._indexDatatype; if (defined(this._dracoLoader)) { this._dracoLoader.process(frameState); } if (defined(this._bufferViewLoader)) { this._bufferViewLoader.process(frameState); } if (!defined(typedArray)) { // Buffer view hasn't been loaded yet return; } // WebGL1 has no way to retrieve the contents of buffers that are // on the GPU. Therefore, the index buffer is stored in CPU memory // in case it needs to be referenced later. const useWebgl2 = frameState.context.webgl2; if (this._loadAsTypedArray || !useWebgl2) { // Unload everything except the typed array this.unload(); this._typedArray = typedArray; this._state = ResourceLoaderState.READY; this._promise.resolve(this); return; } let buffer; if (this._asynchronous) { const indexBufferJob = scratchIndexBufferJob; indexBufferJob.set(typedArray, indexDatatype, frameState.context); const jobScheduler = frameState.jobScheduler; if (!jobScheduler.execute(indexBufferJob, JobType.BUFFER)) { // Job scheduler is full. Try again next frame. return; } buffer = indexBufferJob.buffer; } else { buffer = createIndexBuffer(typedArray, indexDatatype, frameState.context); } // Unload everything except the index buffer this.unload(); this._buffer = buffer; this._state = ResourceLoaderState.READY; this._promise.resolve(this); }; /** * Unloads the resource. * @private */ GltfIndexBufferLoader.prototype.unload = function () { if (defined(this._buffer)) { this._buffer.destroy(); } const resourceCache = this._resourceCache; if (defined(this._bufferViewLoader)) { resourceCache.unload(this._bufferViewLoader); } if (defined(this._dracoLoader)) { resourceCache.unload(this._dracoLoader); } this._bufferViewLoader = undefined; this._dracoLoader = undefined; this._typedArray = undefined; this._buffer = undefined; this._gltf = undefined; };