123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389 |
- import defaultValue from "../Core/defaultValue.js";
- import defined from "../Core/defined.js";
- import deprecationWarning from "../Core/deprecationWarning.js";
- import destroyObject from "../Core/destroyObject.js";
- import getMagic from "../Core/getMagic.js";
- import RuntimeError from "../Core/RuntimeError.js";
- /**
- * Represents the contents of a
- * {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification/TileFormats/Composite|Composite}
- * tile in a {@link https://github.com/CesiumGS/3d-tiles/tree/main/specification|3D Tiles} tileset.
- * <p>
- * Implements the {@link Cesium3DTileContent} interface.
- * </p>
- *
- * @alias Composite3DTileContent
- * @constructor
- *
- * @private
- */
- function Composite3DTileContent(tileset, tile, resource, contents) {
- this._tileset = tileset;
- this._tile = tile;
- this._resource = resource;
- if (!defined(contents)) {
- contents = [];
- }
- this._contents = contents;
- this._metadata = undefined;
- this._group = undefined;
- this._ready = false;
- this._resolveContent = undefined;
- this._readyPromise = new Promise((resolve) => {
- this._resolveContent = resolve;
- });
- }
- Object.defineProperties(Composite3DTileContent.prototype, {
- featurePropertiesDirty: {
- get: function () {
- const contents = this._contents;
- const length = contents.length;
- for (let i = 0; i < length; ++i) {
- if (contents[i].featurePropertiesDirty) {
- return true;
- }
- }
- return false;
- },
- set: function (value) {
- const contents = this._contents;
- const length = contents.length;
- for (let i = 0; i < length; ++i) {
- contents[i].featurePropertiesDirty = value;
- }
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>0</code>. Instead call <code>featuresLength</code> for a tile in the composite.
- * @memberof Composite3DTileContent.prototype
- */
- featuresLength: {
- get: function () {
- return 0;
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>0</code>. Instead call <code>pointsLength</code> for a tile in the composite.
- * @memberof Composite3DTileContent.prototype
- */
- pointsLength: {
- get: function () {
- return 0;
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>0</code>. Instead call <code>trianglesLength</code> for a tile in the composite.
- * @memberof Composite3DTileContent.prototype
- */
- trianglesLength: {
- get: function () {
- return 0;
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>0</code>. Instead call <code>geometryByteLength</code> for a tile in the composite.
- * @memberof Composite3DTileContent.prototype
- */
- geometryByteLength: {
- get: function () {
- return 0;
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>0</code>. Instead call <code>texturesByteLength</code> for a tile in the composite.
- * @memberof Composite3DTileContent.prototype
- */
- texturesByteLength: {
- get: function () {
- return 0;
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>0</code>. Instead call <code>batchTableByteLength</code> for a tile in the composite.
- * @memberof Composite3DTileContent.prototype
- */
- batchTableByteLength: {
- get: function () {
- return 0;
- },
- },
- innerContents: {
- get: function () {
- return this._contents;
- },
- },
- /**
- * Returns true when the tile's content is ready to render; otherwise false
- *
- * @memberof Composite3DTileContent.prototype
- *
- * @type {boolean}
- * @readonly
- * @private
- */
- ready: {
- get: function () {
- return this._ready;
- },
- },
- /**
- * Gets the promise that will be resolved when the tile's content is ready to render.
- *
- * @memberof Composite3DTileContent.prototype
- *
- * @type {Promise<Composite3DTileContent>}
- * @readonly
- * @deprecated
- * @private
- */
- readyPromise: {
- get: function () {
- deprecationWarning(
- "Composite3DTileContent.readyPromise",
- "Composite3DTileContent.readyPromise was deprecated in CesiumJS 1.104. It will be removed in 1.107. Wait for Composite3DTileContent.ready to return true instead."
- );
- return this._readyPromise;
- },
- },
- tileset: {
- get: function () {
- return this._tileset;
- },
- },
- tile: {
- get: function () {
- return this._tile;
- },
- },
- url: {
- get: function () {
- return this._resource.getUrlComponent(true);
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * both stores the content metadata and propagates the content metadata to all of its children.
- * @memberof Composite3DTileContent.prototype
- * @private
- * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
- */
- metadata: {
- get: function () {
- return this._metadata;
- },
- set: function (value) {
- this._metadata = value;
- const contents = this._contents;
- const length = contents.length;
- for (let i = 0; i < length; ++i) {
- contents[i].metadata = value;
- }
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>undefined</code>. Instead call <code>batchTable</code> for a tile in the composite.
- * @memberof Composite3DTileContent.prototype
- */
- batchTable: {
- get: function () {
- return undefined;
- },
- },
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * both stores the group metadata and propagates the group metadata to all of its children.
- * @memberof Composite3DTileContent.prototype
- * @private
- * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
- */
- group: {
- get: function () {
- return this._group;
- },
- set: function (value) {
- this._group = value;
- const contents = this._contents;
- const length = contents.length;
- for (let i = 0; i < length; ++i) {
- contents[i].group = value;
- }
- },
- },
- });
- const sizeOfUint32 = Uint32Array.BYTES_PER_ELEMENT;
- Composite3DTileContent.fromTileType = async function (
- tileset,
- tile,
- resource,
- arrayBuffer,
- byteOffset,
- factory
- ) {
- byteOffset = defaultValue(byteOffset, 0);
- const uint8Array = new Uint8Array(arrayBuffer);
- const view = new DataView(arrayBuffer);
- byteOffset += sizeOfUint32; // Skip magic
- const version = view.getUint32(byteOffset, true);
- if (version !== 1) {
- throw new RuntimeError(
- `Only Composite Tile version 1 is supported. Version ${version} is not.`
- );
- }
- byteOffset += sizeOfUint32;
- // Skip byteLength
- byteOffset += sizeOfUint32;
- const tilesLength = view.getUint32(byteOffset, true);
- byteOffset += sizeOfUint32;
- // For caching purposes, models within the composite tile must be
- // distinguished. To do this, add a query parameter ?compositeIndex=i.
- // Since composite tiles may contain other composite tiles, check for an
- // existing prefix and separate them with underscores. e.g.
- // ?compositeIndex=0_1_1
- let prefix = resource.queryParameters.compositeIndex;
- if (defined(prefix)) {
- // We'll be adding another value at the end, so add an underscore.
- prefix = `${prefix}_`;
- } else {
- // no prefix
- prefix = "";
- }
- const promises = [];
- promises.length = tilesLength;
- for (let i = 0; i < tilesLength; ++i) {
- const tileType = getMagic(uint8Array, byteOffset);
- // Tile byte length is stored after magic and version
- const tileByteLength = view.getUint32(byteOffset + sizeOfUint32 * 2, true);
- const contentFactory = factory[tileType];
- // Label which content within the composite this is
- const compositeIndex = `${prefix}${i}`;
- const childResource = resource.getDerivedResource({
- queryParameters: {
- compositeIndex: compositeIndex,
- },
- });
- if (defined(contentFactory)) {
- promises[i] = Promise.resolve(
- contentFactory(tileset, tile, childResource, arrayBuffer, byteOffset)
- );
- } else {
- throw new RuntimeError(
- `Unknown tile content type, ${tileType}, inside Composite tile`
- );
- }
- byteOffset += tileByteLength;
- }
- const innerContents = await Promise.all(promises);
- const content = new Composite3DTileContent(
- tileset,
- tile,
- resource,
- innerContents
- );
- return content;
- };
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>false</code>. Instead call <code>hasProperty</code> for a tile in the composite.
- */
- Composite3DTileContent.prototype.hasProperty = function (batchId, name) {
- return false;
- };
- /**
- * Part of the {@link Cesium3DTileContent} interface. <code>Composite3DTileContent</code>
- * always returns <code>undefined</code>. Instead call <code>getFeature</code> for a tile in the composite.
- */
- Composite3DTileContent.prototype.getFeature = function (batchId) {
- return undefined;
- };
- Composite3DTileContent.prototype.applyDebugSettings = function (
- enabled,
- color
- ) {
- const contents = this._contents;
- const length = contents.length;
- for (let i = 0; i < length; ++i) {
- contents[i].applyDebugSettings(enabled, color);
- }
- };
- Composite3DTileContent.prototype.applyStyle = function (style) {
- const contents = this._contents;
- const length = contents.length;
- for (let i = 0; i < length; ++i) {
- contents[i].applyStyle(style);
- }
- };
- Composite3DTileContent.prototype.update = function (tileset, frameState) {
- const contents = this._contents;
- const length = contents.length;
- let ready = true;
- for (let i = 0; i < length; ++i) {
- contents[i].update(tileset, frameState);
- ready = ready && contents[i].ready;
- }
- if (!this._ready && ready) {
- this._ready = true;
- this._resolveContent(this);
- }
- };
- Composite3DTileContent.prototype.isDestroyed = function () {
- return false;
- };
- Composite3DTileContent.prototype.destroy = function () {
- const contents = this._contents;
- const length = contents.length;
- for (let i = 0; i < length; ++i) {
- contents[i].destroy();
- }
- return destroyObject(this);
- };
- export default Composite3DTileContent;
|