Source: DataSources/DynamicGeometryUpdater.js

  1. /*global define*/
  2. define([
  3.         '../Core/DeveloperError'
  4.     ], function(
  5.         DeveloperError) {
  6.     'use strict';
  8.     /**
  9.      * Defines the interface for a dynamic geometry updater.  A DynamicGeometryUpdater
  10.      * is responsible for handling visualization of a specific type of geometry
  11.      * that needs to be recomputed based on simulation time.
  12.      * This object is never used directly by client code, but is instead created by
  13.      * {@link GeometryUpdater} implementations which contain dynamic geometry.
  14.      *
  15.      * This type defines an interface and cannot be instantiated directly.
  16.      *
  17.      * @alias DynamicGeometryUpdater
  18.      * @constructor
  19.      */
  20.     function DynamicGeometryUpdater() {
  21.         DeveloperError.throwInstantiationError();
  22.     }
  24.     /**
  25.      * Updates the geometry to the specified time.
  26.      * @memberof DynamicGeometryUpdater
  27.      * @function
  28.      *
  29.      * @param {JulianDate} time The current time.
  30.      */
  31.     DynamicGeometryUpdater.prototype.update = DeveloperError.throwInstantiationError;
  33.     /**
  34.      * Computes a bounding sphere which encloses the visualization produced for the specified entity.
  35.      * The bounding sphere is in the fixed frame of the scene's globe.
  36.      * @function
  37.      *
  38.      * @param {Entity} entity The entity whose bounding sphere to compute.
  39.      * @param {BoundingSphere} result The bounding sphere onto which to store the result.
  40.      * @returns {BoundingSphereState} BoundingSphereState.DONE if the result contains the bounding sphere,
  41.      *                       BoundingSphereState.PENDING if the result is still being computed, or
  42.      *                       BoundingSphereState.FAILED if the entity has no visualization in the current scene.
  43.      * @private
  44.      */
  45.     DynamicGeometryUpdater.prototype.getBoundingSphere = DeveloperError.throwInstantiationError;
  47.     /**
  48.      * Returns true if this object was destroyed; otherwise, false.
  49.      * @memberof DynamicGeometryUpdater
  50.      * @function
  51.      *
  52.      * @returns {Boolean} True if this object was destroyed; otherwise, false.
  53.      */
  54.     DynamicGeometryUpdater.prototype.isDestroyed = DeveloperError.throwInstantiationError;
  56.     /**
  57.      * Destroys and resources used by the object.  Once an object is destroyed, it should not be used.
  58.      * @memberof DynamicGeometryUpdater
  59.      * @function
  60.      *
  61.      * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
  62.      */
  63.     DynamicGeometryUpdater.prototype.destroy = DeveloperError.throwInstantiationError;
  65.     return DynamicGeometryUpdater;
  66. });