Visualizer.js 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. /*global define*/
  2. define([
  3. '../Core/DeveloperError'
  4. ], function(
  5. DeveloperError) {
  6. "use strict";
  7. /**
  8. * Defines the interface for visualizers. Visualizers are plug-ins to
  9. * {@link DataSourceDisplay} that render data associated with
  10. * {@link DataSource} instances.
  11. * This object is an interface for documentation purposes and is not intended
  12. * to be instantiated directly.
  13. * @alias Visualizer
  14. * @constructor
  15. *
  16. * @see BillboardVisualizer
  17. * @see LabelVisualizer
  18. * @see ModelVisualizer
  19. * @see PathVisualizer
  20. * @see PointVisualizer
  21. * @see GeometryVisualizer
  22. */
  23. var Visualizer = function() {
  24. DeveloperError.throwInstantiationError();
  25. };
  26. /**
  27. * Updates the visualization to the provided time.
  28. * @function
  29. *
  30. * @param {JulianDate} time The time.
  31. *
  32. * @returns {Boolean} True if the display was updated to the provided time,
  33. * false if the visualizer is waiting for an asynchronous operation to
  34. * complete before data can be updated.
  35. */
  36. Visualizer.prototype.update = DeveloperError.throwInstantiationError;
  37. /**
  38. * Returns true if this object was destroyed; otherwise, false.
  39. * @function
  40. *
  41. * @returns {Boolean} True if this object was destroyed; otherwise, false.
  42. */
  43. Visualizer.prototype.isDestroyed = DeveloperError.throwInstantiationError;
  44. /**
  45. * Removes all visualization and cleans up any resources associated with this instance.
  46. * @function
  47. */
  48. Visualizer.prototype.destroy = DeveloperError.throwInstantiationError;
  49. return Visualizer;
  50. });