@cesium/engine 0.1.0

package/Source/DataSources/BoxGraphics.js

@@ -0,0 +1,213 @@
+import defaultValue from "../Core/defaultValue.js";
+import defined from "../Core/defined.js";
+import DeveloperError from "../Core/DeveloperError.js";
+import Event from "../Core/Event.js";
+import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor.js";
+import createPropertyDescriptor from "./createPropertyDescriptor.js";
+
+/**
+ * @typedef {Object} BoxGraphics.ConstructorOptions
+ *
+ * Initialization options for the BoxGraphics constructor
+ *
+ * @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the box.
+ * @property {Property | Cartesian3} [dimensions] A {@link Cartesian3} Property specifying the length, width, and height of the box.
+ * @property {Property | HeightReference} [heightReference=HeightReference.NONE] A Property specifying what the height from the entity position is relative to.
+ * @property {Property | boolean} [fill=true] A boolean Property specifying whether the box is filled with the provided material.
+ * @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to fill the box.
+ * @property {Property | boolean} [outline=false] A boolean Property specifying whether the box is outlined.
+ * @property {Property | Color} [outlineColor=Color.BLACK] A Property specifying the {@link Color} of the outline.
+ * @property {Property | number} [outlineWidth=1.0] A numeric Property specifying the width of the outline.
+ * @property {Property | ShadowMode} [shadows=ShadowMode.DISABLED] An enum Property specifying whether the box casts or receives shadows from light sources.
+ * @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this box will be displayed.
+ *
+ */
+
+/**
+ * Describes a box. The center position and orientation are determined by the containing {@link Entity}.
+ *
+ * @alias BoxGraphics
+ * @constructor
+ *
+ * @param {BoxGraphics.ConstructorOptions} [options] Object describing initialization options
+ *
+ * @demo {@link https://sandcastle.cesium.com/index.html?src=Box.html|Cesium Sandcastle Box Demo}
+ */
+function BoxGraphics(options) {
+  this._definitionChanged = new Event();
+  this._show = undefined;
+  this._showSubscription = undefined;
+  this._dimensions = undefined;
+  this._dimensionsSubscription = undefined;
+  this._heightReference = undefined;
+  this._heightReferenceSubscription = undefined;
+  this._fill = undefined;
+  this._fillSubscription = undefined;
+  this._material = undefined;
+  this._materialSubscription = undefined;
+  this._outline = undefined;
+  this._outlineSubscription = undefined;
+  this._outlineColor = undefined;
+  this._outlineColorSubscription = undefined;
+  this._outlineWidth = undefined;
+  this._outlineWidthSubscription = undefined;
+  this._shadows = undefined;
+  this._shadowsSubscription = undefined;
+  this._distanceDisplayCondition = undefined;
+  this._distanceDisplayConditionSubscription = undefined;
+
+  this.merge(defaultValue(options, defaultValue.EMPTY_OBJECT));
+}
+
+Object.defineProperties(BoxGraphics.prototype, {
+  /**
+   * Gets the event that is raised whenever a property or sub-property is changed or modified.
+   * @memberof BoxGraphics.prototype
+   * @type {Event}
+   * @readonly
+   */
+  definitionChanged: {
+    get: function () {
+      return this._definitionChanged;
+    },
+  },
+
+  /**
+   * Gets or sets the boolean Property specifying the visibility of the box.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   * @default true
+   */
+  show: createPropertyDescriptor("show"),
+
+  /**
+   * Gets or sets {@link Cartesian3} Property property specifying the length, width, and height of the box.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   */
+  dimensions: createPropertyDescriptor("dimensions"),
+
+  /**
+   * Gets or sets the Property specifying the {@link HeightReference}.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   * @default HeightReference.NONE
+   */
+  heightReference: createPropertyDescriptor("heightReference"),
+
+  /**
+   * Gets or sets the boolean Property specifying whether the box is filled with the provided material.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   * @default true
+   */
+  fill: createPropertyDescriptor("fill"),
+
+  /**
+   * Gets or sets the material used to fill the box.
+   * @memberof BoxGraphics.prototype
+   * @type {MaterialProperty|undefined}
+   * @default Color.WHITE
+   */
+  material: createMaterialPropertyDescriptor("material"),
+
+  /**
+   * Gets or sets the Property specifying whether the box is outlined.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   * @default false
+   */
+  outline: createPropertyDescriptor("outline"),
+
+  /**
+   * Gets or sets the Property specifying the {@link Color} of the outline.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   * @default Color.BLACK
+   */
+  outlineColor: createPropertyDescriptor("outlineColor"),
+
+  /**
+   * Gets or sets the numeric Property specifying the width of the outline.
+   * <p>
+   * Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}.
+   * </p>
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   * @default 1.0
+   */
+  outlineWidth: createPropertyDescriptor("outlineWidth"),
+
+  /**
+   * Get or sets the enum Property specifying whether the box
+   * casts or receives shadows from light sources.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   * @default ShadowMode.DISABLED
+   */
+  shadows: createPropertyDescriptor("shadows"),
+
+  /**
+   * Gets or sets the {@link DistanceDisplayCondition} Property specifying at what distance from the camera that this box will be displayed.
+   * @memberof BoxGraphics.prototype
+   * @type {Property|undefined}
+   */
+  distanceDisplayCondition: createPropertyDescriptor(
+    "distanceDisplayCondition"
+  ),
+});
+
+/**
+ * Duplicates this instance.
+ *
+ * @param {BoxGraphics} [result] The object onto which to store the result.
+ * @returns {BoxGraphics} The modified result parameter or a new instance if one was not provided.
+ */
+BoxGraphics.prototype.clone = function (result) {
+  if (!defined(result)) {
+    return new BoxGraphics(this);
+  }
+  result.show = this.show;
+  result.dimensions = this.dimensions;
+  result.heightReference = this.heightReference;
+  result.fill = this.fill;
+  result.material = this.material;
+  result.outline = this.outline;
+  result.outlineColor = this.outlineColor;
+  result.outlineWidth = this.outlineWidth;
+  result.shadows = this.shadows;
+  result.distanceDisplayCondition = this.distanceDisplayCondition;
+  return result;
+};
+
+/**
+ * Assigns each unassigned property on this object to the value
+ * of the same property on the provided source object.
+ *
+ * @param {BoxGraphics} source The object to be merged into this object.
+ */
+BoxGraphics.prototype.merge = function (source) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(source)) {
+    throw new DeveloperError("source is required.");
+  }
+  //>>includeEnd('debug');
+
+  this.show = defaultValue(this.show, source.show);
+  this.dimensions = defaultValue(this.dimensions, source.dimensions);
+  this.heightReference = defaultValue(
+    this.heightReference,
+    source.heightReference
+  );
+  this.fill = defaultValue(this.fill, source.fill);
+  this.material = defaultValue(this.material, source.material);
+  this.outline = defaultValue(this.outline, source.outline);
+  this.outlineColor = defaultValue(this.outlineColor, source.outlineColor);
+  this.outlineWidth = defaultValue(this.outlineWidth, source.outlineWidth);
+  this.shadows = defaultValue(this.shadows, source.shadows);
+  this.distanceDisplayCondition = defaultValue(
+    this.distanceDisplayCondition,
+    source.distanceDisplayCondition
+  );
+};
+export default BoxGraphics;

package/Source/DataSources/CallbackProperty.js

@@ -0,0 +1,111 @@
+import defined from "../Core/defined.js";
+import DeveloperError from "../Core/DeveloperError.js";
+import Event from "../Core/Event.js";
+
+/**
+ * A {@link Property} whose value is lazily evaluated by a callback function.
+ *
+ * @alias CallbackProperty
+ * @constructor
+ *
+ * @param {CallbackProperty.Callback} callback The function to be called when the property is evaluated.
+ * @param {Boolean} isConstant <code>true</code> when the callback function returns the same value every time, <code>false</code> if the value will change.
+ */
+function CallbackProperty(callback, isConstant) {
+  this._callback = undefined;
+  this._isConstant = undefined;
+  this._definitionChanged = new Event();
+  this.setCallback(callback, isConstant);
+}
+
+Object.defineProperties(CallbackProperty.prototype, {
+  /**
+   * Gets a value indicating if this property is constant.
+   * @memberof CallbackProperty.prototype
+   *
+   * @type {Boolean}
+   * @readonly
+   */
+  isConstant: {
+    get: function () {
+      return this._isConstant;
+    },
+  },
+  /**
+   * Gets the event that is raised whenever the definition of this property changes.
+   * The definition is changed whenever setCallback is called.
+   * @memberof CallbackProperty.prototype
+   *
+   * @type {Event}
+   * @readonly
+   */
+  definitionChanged: {
+    get: function () {
+      return this._definitionChanged;
+    },
+  },
+});
+
+/**
+ * Gets the value of the property.
+ *
+ * @param {JulianDate} time The time for which to retrieve the value.
+ * @param {Object} [result] The object to store the value into, if omitted, a new instance is created and returned.
+ * @returns {Object} The modified result parameter or a new instance if the result parameter was not supplied or is unsupported.
+ */
+CallbackProperty.prototype.getValue = function (time, result) {
+  return this._callback(time, result);
+};
+
+/**
+ * Sets the callback to be used.
+ *
+ * @param {CallbackProperty.Callback} callback The function to be called when the property is evaluated.
+ * @param {Boolean} isConstant <code>true</code> when the callback function returns the same value every time, <code>false</code> if the value will change.
+ */
+CallbackProperty.prototype.setCallback = function (callback, isConstant) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(callback)) {
+    throw new DeveloperError("callback is required.");
+  }
+  if (!defined(isConstant)) {
+    throw new DeveloperError("isConstant is required.");
+  }
+  //>>includeEnd('debug');
+
+  const changed =
+    this._callback !== callback || this._isConstant !== isConstant;
+
+  this._callback = callback;
+  this._isConstant = isConstant;
+
+  if (changed) {
+    this._definitionChanged.raiseEvent(this);
+  }
+};
+
+/**
+ * Compares this property to the provided property and returns
+ * <code>true</code> if they are equal, <code>false</code> otherwise.
+ *
+ * @param {Property} [other] The other property.
+ * @returns {Boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
+ */
+CallbackProperty.prototype.equals = function (other) {
+  return (
+    this === other ||
+    (other instanceof CallbackProperty &&
+      this._callback === other._callback &&
+      this._isConstant === other._isConstant)
+  );
+};
+
+/**
+ * A function that returns the value of the property.
+ * @callback CallbackProperty.Callback
+ *
+ * @param {JulianDate} time The time for which to retrieve the value.
+ * @param {Object} [result] The object to store the value into. If omitted, the function must create and return a new instance.
+ * @returns {Object} The modified result parameter, or a new instance if the result parameter was not supplied or is unsupported.
+ */
+export default CallbackProperty;

package/Source/DataSources/Cesium3DTilesetGraphics.js

@@ -0,0 +1,113 @@
+import defaultValue from "../Core/defaultValue.js";
+import defined from "../Core/defined.js";
+import DeveloperError from "../Core/DeveloperError.js";
+import Event from "../Core/Event.js";
+import createPropertyDescriptor from "./createPropertyDescriptor.js";
+
+/**
+ * @typedef {Object} Cesium3DTilesetGraphics.ConstructorOptions
+ *
+ * Initialization options for the Cesium3DTilesetGraphics constructor
+ *
+ * @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the tileset.
+ * @property {Property | string | Resource} [uri] A string or Resource Property specifying the URI of the tileset.
+ * @property {Property | number} [maximumScreenSpaceError] A number or Property specifying the maximum screen space error used to drive level of detail refinement.
+ */
+
+/**
+ * A 3D Tiles tileset represented by an {@link Entity}.
+ * The tileset modelMatrix is determined by the containing Entity position and orientation
+ * or is left unset if position is undefined.
+ *
+ * @alias Cesium3DTilesetGraphics
+ * @constructor
+ *
+ * @param {Cesium3DTilesetGraphics.ConstructorOptions} [options] Object describing initialization options
+ */
+function Cesium3DTilesetGraphics(options) {
+  this._definitionChanged = new Event();
+  this._show = undefined;
+  this._showSubscription = undefined;
+  this._uri = undefined;
+  this._uriSubscription = undefined;
+  this._maximumScreenSpaceError = undefined;
+  this._maximumScreenSpaceErrorSubscription = undefined;
+
+  this.merge(defaultValue(options, defaultValue.EMPTY_OBJECT));
+}
+
+Object.defineProperties(Cesium3DTilesetGraphics.prototype, {
+  /**
+   * Gets the event that is raised whenever a property or sub-property is changed or modified.
+   * @memberof Cesium3DTilesetGraphics.prototype
+   * @type {Event}
+   * @readonly
+   */
+  definitionChanged: {
+    get: function () {
+      return this._definitionChanged;
+    },
+  },
+
+  /**
+   * Gets or sets the boolean Property specifying the visibility of the model.
+   * @memberof Cesium3DTilesetGraphics.prototype
+   * @type {Property|undefined}
+   * @default true
+   */
+  show: createPropertyDescriptor("show"),
+
+  /**
+   * Gets or sets the string Property specifying the URI of the glTF asset.
+   * @memberof Cesium3DTilesetGraphics.prototype
+   * @type {Property|undefined}
+   */
+  uri: createPropertyDescriptor("uri"),
+
+  /**
+   * Gets or sets the maximum screen space error used to drive level of detail refinement.
+   * @memberof Cesium3DTilesetGraphics.prototype
+   * @type {Property|undefined}
+   */
+  maximumScreenSpaceError: createPropertyDescriptor("maximumScreenSpaceError"),
+});
+
+/**
+ * Duplicates this instance.
+ *
+ * @param {Cesium3DTilesetGraphics} [result] The object onto which to store the result.
+ * @returns {Cesium3DTilesetGraphics} The modified result parameter or a new instance if one was not provided.
+ */
+Cesium3DTilesetGraphics.prototype.clone = function (result) {
+  if (!defined(result)) {
+    return new Cesium3DTilesetGraphics(this);
+  }
+  result.show = this.show;
+  result.uri = this.uri;
+  result.maximumScreenSpaceError = this.maximumScreenSpaceError;
+
+  return result;
+};
+
+/**
+ * Assigns each unassigned property on this object to the value
+ * of the same property on the provided source object.
+ *
+ * @param {Cesium3DTilesetGraphics} source The object to be merged into this object.
+ */
+Cesium3DTilesetGraphics.prototype.merge = function (source) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(source)) {
+    throw new DeveloperError("source is required.");
+  }
+  //>>includeEnd('debug');
+
+  this.show = defaultValue(this.show, source.show);
+  this.uri = defaultValue(this.uri, source.uri);
+  this.maximumScreenSpaceError = defaultValue(
+    this.maximumScreenSpaceError,
+    source.maximumScreenSpaceError
+  );
+};
+
+export default Cesium3DTilesetGraphics;

package/Source/DataSources/Cesium3DTilesetVisualizer.js

@@ -0,0 +1,249 @@
+import AssociativeArray from "../Core/AssociativeArray.js";
+import BoundingSphere from "../Core/BoundingSphere.js";
+import defined from "../Core/defined.js";
+import destroyObject from "../Core/destroyObject.js";
+import DeveloperError from "../Core/DeveloperError.js";
+import Matrix4 from "../Core/Matrix4.js";
+import Resource from "../Core/Resource.js";
+import Cesium3DTileset from "../Scene/Cesium3DTileset.js";
+import BoundingSphereState from "./BoundingSphereState.js";
+import Property from "./Property.js";
+
+const modelMatrixScratch = new Matrix4();
+
+/**
+ * A {@link Visualizer} which maps {@link Entity#tileset} to a {@link Cesium3DTileset}.
+ * @alias Cesium3DTilesetVisualizer
+ * @constructor
+ *
+ * @param {Scene} scene The scene the primitives will be rendered in.
+ * @param {EntityCollection} entityCollection The entityCollection to visualize.
+ */
+function Cesium3DTilesetVisualizer(scene, entityCollection) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(scene)) {
+    throw new DeveloperError("scene is required.");
+  }
+  if (!defined(entityCollection)) {
+    throw new DeveloperError("entityCollection is required.");
+  }
+  //>>includeEnd('debug');
+
+  entityCollection.collectionChanged.addEventListener(
+    Cesium3DTilesetVisualizer.prototype._onCollectionChanged,
+    this
+  );
+
+  this._scene = scene;
+  this._primitives = scene.primitives;
+  this._entityCollection = entityCollection;
+  this._tilesetHash = {};
+  this._entitiesToVisualize = new AssociativeArray();
+  this._onCollectionChanged(entityCollection, entityCollection.values, [], []);
+}
+
+/**
+ * Updates models created this visualizer to match their
+ * Entity counterpart at the given time.
+ *
+ * @param {JulianDate} time The time to update to.
+ * @returns {Boolean} This function always returns true.
+ */
+Cesium3DTilesetVisualizer.prototype.update = function (time) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(time)) {
+    throw new DeveloperError("time is required.");
+  }
+  //>>includeEnd('debug');
+
+  const entities = this._entitiesToVisualize.values;
+  const tilesetHash = this._tilesetHash;
+  const primitives = this._primitives;
+
+  for (let i = 0, len = entities.length; i < len; i++) {
+    const entity = entities[i];
+    const tilesetGraphics = entity._tileset;
+
+    let resource;
+    let tilesetData = tilesetHash[entity.id];
+    const show =
+      entity.isShowing &&
+      entity.isAvailable(time) &&
+      Property.getValueOrDefault(tilesetGraphics._show, time, true);
+
+    let modelMatrix;
+    if (show) {
+      modelMatrix = entity.computeModelMatrix(time, modelMatrixScratch);
+      resource = Resource.createIfNeeded(
+        Property.getValueOrUndefined(tilesetGraphics._uri, time)
+      );
+    }
+
+    if (!show) {
+      if (defined(tilesetData)) {
+        tilesetData.tilesetPrimitive.show = false;
+      }
+      continue;
+    }
+
+    let tileset = defined(tilesetData)
+      ? tilesetData.tilesetPrimitive
+      : undefined;
+    if (!defined(tileset) || resource.url !== tilesetData.url) {
+      if (defined(tileset)) {
+        primitives.removeAndDestroy(tileset);
+        delete tilesetHash[entity.id];
+      }
+      tileset = new Cesium3DTileset({
+        url: resource,
+      });
+      tileset.id = entity;
+      primitives.add(tileset);
+
+      tilesetData = {
+        tilesetPrimitive: tileset,
+        url: resource.url,
+        loadFail: false,
+      };
+      tilesetHash[entity.id] = tilesetData;
+
+      checkLoad(tileset, entity, tilesetHash);
+    }
+
+    tileset.show = true;
+    if (defined(modelMatrix)) {
+      tileset.modelMatrix = modelMatrix;
+    }
+    tileset.maximumScreenSpaceError = Property.getValueOrDefault(
+      tilesetGraphics.maximumScreenSpaceError,
+      time,
+      tileset.maximumScreenSpaceError
+    );
+  }
+
+  return true;
+};
+
+/**
+ * Returns true if this object was destroyed; otherwise, false.
+ *
+ * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ */
+Cesium3DTilesetVisualizer.prototype.isDestroyed = function () {
+  return false;
+};
+
+/**
+ * Removes and destroys all primitives created by this instance.
+ */
+Cesium3DTilesetVisualizer.prototype.destroy = function () {
+  this._entityCollection.collectionChanged.removeEventListener(
+    Cesium3DTilesetVisualizer.prototype._onCollectionChanged,
+    this
+  );
+  const entities = this._entitiesToVisualize.values;
+  const tilesetHash = this._tilesetHash;
+  const primitives = this._primitives;
+  for (let i = entities.length - 1; i > -1; i--) {
+    removeTileset(this, entities[i], tilesetHash, primitives);
+  }
+  return destroyObject(this);
+};
+
+/**
+ * Computes a bounding sphere which encloses the visualization produced for the specified entity.
+ * The bounding sphere is in the fixed frame of the scene's globe.
+ *
+ * @param {Entity} entity The entity whose bounding sphere to compute.
+ * @param {BoundingSphere} result The bounding sphere onto which to store the result.
+ * @returns {BoundingSphereState} BoundingSphereState.DONE if the result contains the bounding sphere,
+ *                       BoundingSphereState.PENDING if the result is still being computed, or
+ *                       BoundingSphereState.FAILED if the entity has no visualization in the current scene.
+ * @private
+ */
+Cesium3DTilesetVisualizer.prototype.getBoundingSphere = function (
+  entity,
+  result
+) {
+  //>>includeStart('debug', pragmas.debug);
+  if (!defined(entity)) {
+    throw new DeveloperError("entity is required.");
+  }
+  if (!defined(result)) {
+    throw new DeveloperError("result is required.");
+  }
+  //>>includeEnd('debug');
+
+  const tilesetData = this._tilesetHash[entity.id];
+  if (!defined(tilesetData) || tilesetData.loadFail) {
+    return BoundingSphereState.FAILED;
+  }
+
+  const primitive = tilesetData.tilesetPrimitive;
+  if (!defined(primitive) || !primitive.show) {
+    return BoundingSphereState.FAILED;
+  }
+
+  if (!primitive.ready) {
+    return BoundingSphereState.PENDING;
+  }
+
+  BoundingSphere.clone(primitive.boundingSphere, result);
+
+  return BoundingSphereState.DONE;
+};
+
+/**
+ * @private
+ */
+Cesium3DTilesetVisualizer.prototype._onCollectionChanged = function (
+  entityCollection,
+  added,
+  removed,
+  changed
+) {
+  let i;
+  let entity;
+  const entities = this._entitiesToVisualize;
+  const tilesetHash = this._tilesetHash;
+  const primitives = this._primitives;
+
+  for (i = added.length - 1; i > -1; i--) {
+    entity = added[i];
+    if (defined(entity._tileset)) {
+      entities.set(entity.id, entity);
+    }
+  }
+
+  for (i = changed.length - 1; i > -1; i--) {
+    entity = changed[i];
+    if (defined(entity._tileset)) {
+      entities.set(entity.id, entity);
+    } else {
+      removeTileset(this, entity, tilesetHash, primitives);
+      entities.remove(entity.id);
+    }
+  }
+
+  for (i = removed.length - 1; i > -1; i--) {
+    entity = removed[i];
+    removeTileset(this, entity, tilesetHash, primitives);
+    entities.remove(entity.id);
+  }
+};
+
+function removeTileset(visualizer, entity, tilesetHash, primitives) {
+  const tilesetData = tilesetHash[entity.id];
+  if (defined(tilesetData)) {
+    primitives.removeAndDestroy(tilesetData.tilesetPrimitive);
+    delete tilesetHash[entity.id];
+  }
+}
+
+function checkLoad(primitive, entity, tilesetHash) {
+  primitive.readyPromise.catch(function (error) {
+    console.error(error);
+    tilesetHash[entity.id].loadFail = true;
+  });
+}
+export default Cesium3DTilesetVisualizer;