import Check from "../Core/Check.js";
import defaultValue from "../Core/defaultValue.js";
/**
* This class represents a single entity in the MetadataTable
owned by an implicit subtree. The entity is specified by the entityId.
*
* See the {@link https://github.com/CesiumGS/3d-tiles/tree/main/extensions/3DTILES_metadata|3DTILES_metadata Extension} for 3D Tiles *
* * @param {MetadataTable} options.metadataTable The metadata table. * @param {MetadataClass} options.class The class that the metadata conforms to. * @param {number} options.entityId The ID of the entity the metadata belongs to. * @param {object} options.propertyTableJson The JSON that contains the property table of the entity. * * @alias ImplicitMetadataView * @constructor * * @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. */ function ImplicitMetadataView(options) { options = defaultValue(options, defaultValue.EMPTY_OBJECT); const metadataTable = options.metadataTable; const metadataClass = options.class; const entityId = options.entityId; const propertyTableJson = options.propertyTableJson; //>>includeStart('debug', pragmas.debug); Check.typeOf.object("options.metadataTable", metadataTable); Check.typeOf.object("options.class", metadataClass); Check.typeOf.number("options.entityId", entityId); Check.typeOf.object("options.propertyTableJson", propertyTableJson); //>>includeEnd('debug'); this._class = metadataClass; this._metadataTable = metadataTable; this._entityId = entityId; this._extensions = propertyTableJson.extensions; this._extras = propertyTableJson.extras; } Object.defineProperties(ImplicitMetadataView.prototype, { /** * The class that properties conform to. * * @memberof ImplicitMetadataView.prototype * @type {MetadataClass} * @readonly */ class: { get: function () { return this._class; }, }, /** * Extra user-defined properties. * * @memberof ImplicitMetadataView.prototype * @type {object} * @readonly */ extras: { get: function () { return this._extras; }, }, /** * An object containing extensions. * * @memberof ImplicitMetadataView.prototype * @type {object} * @readonly */ extensions: { get: function () { return this._extensions; }, }, }); /** * Returns whether the metadata contains this property. * * @param {string} propertyId The case-sensitive ID of the property. * @returns {boolean} Whether the tile has this property. * @private */ ImplicitMetadataView.prototype.hasProperty = function (propertyId) { return this._metadataTable.hasProperty(propertyId); }; /** * Returns whether the metadata contains a property with the given semantic. * * @param {string} semantic The case-sensitive semantic of the property. * @returns {boolean} Whether the tile has a property with the given semantic. * @private */ ImplicitMetadataView.prototype.hasPropertyBySemantic = function (semantic) { return this._metadataTable.hasPropertyBySemantic(semantic); }; /** * Returns an array of property IDs in the metadata table. * * @param {string[]} [results] An array into which to store the results. * @returns {string[]} The property IDs. * @private */ ImplicitMetadataView.prototype.getPropertyIds = function (results) { return this._metadataTable.getPropertyIds(results); }; /** * Returns a copy of the value of the property with the given ID. ** If the property is normalized the normalized value is returned. *
* * @param {string} propertyId The case-sensitive ID of the property. * @returns {*} The value of the property orundefined
if the tile does not have this property.
* @private
*/
ImplicitMetadataView.prototype.getProperty = function (propertyId) {
return this._metadataTable.getProperty(this._entityId, propertyId);
};
/**
* Sets the value of the property with the given ID in the metadata table.
* * If the property is normalized a normalized value must be provided to this function. *
* * @param {string} propertyId The case-sensitive ID of the property. * @param {*} value The value of the property that will be copied. * @returns {boolean}true
if the property was set, false
otherwise.
* @private
*/
ImplicitMetadataView.prototype.setProperty = function (propertyId, value) {
return this._metadataTable.setProperty(this._entityId, propertyId, value);
};
/**
* Returns a copy of the value of the property with the given semantic in the metadata table.
*
* @param {string} semantic The case-sensitive semantic of the property.
* @returns {*} The value of the property or undefined
if the tile does not have this semantic.
* @private
*/
ImplicitMetadataView.prototype.getPropertyBySemantic = function (semantic) {
return this._metadataTable.getPropertyBySemantic(this._entityId, semantic);
};
/**
* Sets the value of the property with the given semantic in the metadata table.
*
* @param {string} semantic The case-sensitive semantic of the property.
* @param {*} value The value of the property that will be copied.
* @returns {boolean} true
if the property was set, false
otherwise.
* @private
*/
ImplicitMetadataView.prototype.setPropertyBySemantic = function (
semantic,
value
) {
return this._metadataTable.setPropertyBySemantic(
this._entityId,
semantic,
value
);
};
export default ImplicitMetadataView;