Visualizer cleanup

CHANGES.md

@@ -9,6 +9,16 @@ Beta Releases
   * Renamed and moved `Scene.primitives.centralBody` moved to `Scene.globe`.
   * Removed `CesiumWidget.centralBody` and `Viewer.centralBody`.  Use `Scene.globe`.
   * Renamed `CentralBody` to `Globe`.
+  * Refactored visualizers, removing `setDynamicObjectCollection`, `getDynamicObjectCollection`, `getScene`, and `removeAllPrimitives` which are all superfluous after the introduction of `DataSourceDisplay`.  The affected classes are:
+    * `DynamicBillboardVisualizer`
+    * `DynamicConeVisualizerUsingCustomSensor`
+    * `DynamicLabelVisualizer`
+    * `DynamicModelVisualizer`
+    * `DynamicPathVisualizer`
+    * `DynamicPointVisualizer`
+    * `DynamicPyramidVisualizer`
+    * `DynamicVectorVisualizer`
+    * `GeometryVisualizer`
   * Renamed Extent to Rectangle
     * `Extent` -> `Rectangle`
     * `ExtentGeometry` -> `RectangleGeomtry`

Source/DynamicScene/DynamicBillboardVisualizer.js

@@ -23,7 +23,6 @@ define([
         TextureAtlasBuilder) {
     "use strict";
 
-    //Callback to create a callback so that we close over all of the proper values.
     function textureReady(dynamicObject, billboardCollection, textureValue) {
         return function(imageIndex) {
             //By the time the texture was loaded, the billboard might already be
@@ -41,83 +40,41 @@ define([
     }
 
     /**
-     * A DynamicObject visualizer which maps the DynamicBillboard instance
-     * in DynamicObject.billboard to a Billboard primitive.
+     * A {@link Visualizer} which maps {@link DynamicObject#billboard} to a {@link Billboard}.
      * @alias DynamicBillboardVisualizer
      * @constructor
      *
      * @param {Scene} scene The scene the primitives will be rendered in.
-     * @param {DynamicObjectCollection} [dynamicObjectCollection] The dynamicObjectCollection to visualize.
-     *
-     * @see DynamicBillboard
-     * @see DynamicObject
-     * @see DynamicObjectCollection
-     * @see CompositeDynamicObjectCollection
-     * @see DynamicConeVisualizer
-     * @see DynamicConeVisualizerUsingCustomSensor
-     * @see DynamicLabelVisualizer
-     * @see DynamicPointVisualizer
-     * @see DynamicPyramidVisualizer
+     * @param {DynamicObjectCollection} dynamicObjectCollection The dynamicObjectCollection to visualize.
      */
     var DynamicBillboardVisualizer = function(scene, dynamicObjectCollection) {
         //>>includeStart('debug', pragmas.debug);
         if (!defined(scene)) {
             throw new DeveloperError('scene is required.');
         }
+        if (!defined(dynamicObjectCollection)) {
+            throw new DeveloperError('dynamicObjectCollection is required.');
+        }
         //>>includeEnd('debug');
 
-        this._scene = scene;
-        this._unusedIndexes = [];
-        this._dynamicObjectCollection = undefined;
-
-        var billboardCollection = this._billboardCollection = new BillboardCollection();
-        var atlas = this._textureAtlas = scene.createTextureAtlas();
-        this._textureAtlasBuilder = new TextureAtlasBuilder(atlas);
+        var billboardCollection = new BillboardCollection();
+        var atlas = scene.createTextureAtlas();
         billboardCollection.textureAtlas = atlas;
         scene.primitives.add(billboardCollection);
-        this.setDynamicObjectCollection(dynamicObjectCollection);
-    };
+        dynamicObjectCollection.collectionChanged.addEventListener(DynamicBillboardVisualizer.prototype._onObjectsRemoved, this);
 
-    /**
-     * Returns the scene being used by this visualizer.
-     *
-     * @returns {Scene} The scene being used by this visualizer.
-     */
-    DynamicBillboardVisualizer.prototype.getScene = function() {
-        return this._scene;
-    };
-
-    /**
-     * Gets the DynamicObjectCollection being visualized.
-     *
-     * @returns {DynamicObjectCollection} The DynamicObjectCollection being visualized.
-     */
-    DynamicBillboardVisualizer.prototype.getDynamicObjectCollection = function() {
-        return this._dynamicObjectCollection;
-    };
-
-    /**
-     * Sets the DynamicObjectCollection to visualize.
-     *
-     * @param dynamicObjectCollection The DynamicObjectCollection to visualizer.
-     */
-    DynamicBillboardVisualizer.prototype.setDynamicObjectCollection = function(dynamicObjectCollection) {
-        var oldCollection = this._dynamicObjectCollection;
-        if (oldCollection !== dynamicObjectCollection) {
-            if (defined(oldCollection)) {
-                oldCollection.collectionChanged.removeEventListener(DynamicBillboardVisualizer.prototype._onObjectsRemoved, this);
-                this.removeAllPrimitives();
-            }
-            this._dynamicObjectCollection = dynamicObjectCollection;
-            if (defined(dynamicObjectCollection)) {
-                dynamicObjectCollection.collectionChanged.addEventListener(DynamicBillboardVisualizer.prototype._onObjectsRemoved, this);
-            }
-        }
+        this._scene = scene;
+        this._unusedIndexes = [];
+        this._textureAtlas = atlas;
+        this._billboardCollection = billboardCollection;
+        this._textureAtlasBuilder = new TextureAtlasBuilder(atlas);
+        this._dynamicObjectCollection = dynamicObjectCollection;
     };
 
     /**
-     * Updates all of the primitives created by this visualizer to match their
+     * Updates the primitives created by this visualizer to match their
      * DynamicObject counterpart at the given time.
+     * @memberof DynamicBillboardVisualizer
      *
      * @param {JulianDate} time The time to update to.
      * @returns {Boolean} This function always returns true.
@@ -131,64 +88,26 @@ define([
 
         if (defined(this._dynamicObjectCollection)) {
             var dynamicObjects = this._dynamicObjectCollection.getObjects();
-            for ( var i = 0, len = dynamicObjects.length; i < len; i++) {
+            for (var i = 0, len = dynamicObjects.length; i < len; i++) {
                 updateObject(this, time, dynamicObjects[i]);
             }
         }
         return true;
     };
 
     /**
-     * Removes all primitives from the scene.
-     */
-    DynamicBillboardVisualizer.prototype.removeAllPrimitives = function() {
-        if (defined(this._dynamicObjectCollection)) {
-            this._unusedIndexes = [];
-            this._billboardCollection.removeAll();
-            var dynamicObjects = this._dynamicObjectCollection.getObjects();
-            for ( var i = dynamicObjects.length - 1; i > -1; i--) {
-                dynamicObjects[i]._billboardVisualizerIndex = undefined;
-            }
-        }
-    };
-
-    /**
-     * Returns true if this object was destroyed; otherwise, false.
-     * <br /><br />
-     * If this object was destroyed, it should not be used; calling any function other than
-     * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
-     *
+     * Removes and destroys all primitives created by this instance.
      * @memberof DynamicBillboardVisualizer
-     *
-     * @returns {Boolean} True if this object was destroyed; otherwise, false.
-     *
-     * @see DynamicBillboardVisualizer#destroy
-     */
-    DynamicBillboardVisualizer.prototype.isDestroyed = function() {
-        return false;
-    };
-
-    /**
-     * Destroys the WebGL resources held by this object.  Destroying an object allows for deterministic
-     * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
-     * <br /><br />
-     * Once an object is destroyed, it should not be used; calling any function other than
-     * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.  Therefore,
-     * assign the return value (<code>undefined</code>) to the object as done in the example.
-     *
-     * @memberof DynamicBillboardVisualizer
-     *
-     * @returns {undefined}
-     *
-     * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
-     *
-     * @see DynamicBillboardVisualizer#isDestroyed
-     *
-     * @example
-     * visualizer = visualizer && visualizer.destroy();
      */
     DynamicBillboardVisualizer.prototype.destroy = function() {
-        this.setDynamicObjectCollection(undefined);
+        var dynamicObjectCollection = this._dynamicObjectCollection;
+        dynamicObjectCollection.collectionChanged.removeEventListener(DynamicBillboardVisualizer.prototype._onObjectsRemoved, this);
+
+        var dynamicObjects = dynamicObjectCollection.getObjects();
+        var length = dynamicObjects.length;
+        for (var i = 0; i < length; i++) {
+            dynamicObjects[i]._billboardVisualizerIndex = undefined;
+        }
         this._scene.primitives.remove(this._billboardCollection);
         return destroyObject(this);
     };
@@ -247,7 +166,6 @@ define([
             billboard._visualizerUrl = undefined;
             billboard._visualizerTextureAvailable = false;
 
-            // CZML_TODO Determine official defaults
             billboard.color = Color.WHITE;
             billboard.eyeOffset = Cartesian3.ZERO;
             billboard.pixelOffset = Cartesian2.ZERO;

Source/DynamicScene/DynamicConeVisualizerUsingCustomSensor.js

@@ -29,12 +29,6 @@ define([
         MaterialProperty) {
     "use strict";
 
-    //CZML_TODO DynamicConeVisualizerUsingCustomSensor is a temporary workaround
-    //because ComplexConicSensor has major performance issues.  As soon as
-    //ComplexConicSensor is working, this class can be deleted and
-    //DynamicConeVisualizer is a drop in replacement that already does things
-    //"the right way".
-
     var matrix3Scratch = new Matrix3();
 
     function assignSpherical(index, array, clock, cone) {
@@ -77,79 +71,36 @@ define([
     }
 
     /**
-     * A DynamicObject visualizer which maps the DynamicCone instance
-     * in DynamicObject.cone to a CustomSensor primitive.
+     * A {@link Visualizer} which maps {@link DynamicObject#cone} to a {@link CustomSensor}.
      * @alias DynamicConeVisualizerUsingCustomSensor
      * @constructor
      *
      * @param {Scene} scene The scene the primitives will be rendered in.
-     * @param {DynamicObjectCollection} [dynamicObjectCollection] The dynamicObjectCollection to visualize.
-     *
-     * @see DynamicCone
-     * @see DynamicObject
-     * @see DynamicObjectCollection
-     * @see CompositeDynamicObjectCollection
-     * @see DynamicBillboardVisualizer
-     * @see DynamicConeVisualizer
-     * @see DynamicLabelVisualizer
-     * @see DynamicPointVisualizer
-     * @see DynamicPyramidVisualizer
+     * @param {DynamicObjectCollection} dynamicObjectCollection The dynamicObjectCollection to visualize.
      */
     var DynamicConeVisualizerUsingCustomSensor = function(scene, dynamicObjectCollection) {
         //>>includeStart('debug', pragmas.debug);
         if (!defined(scene)) {
             throw new DeveloperError('scene is required.');
         }
+        if (!defined(dynamicObjectCollection)) {
+            throw new DeveloperError('dynamicObjectCollection is required.');
+        }
         //>>includeEnd('debug');
 
+        dynamicObjectCollection.collectionChanged.addEventListener(DynamicConeVisualizerUsingCustomSensor.prototype._onObjectsRemoved, this);
+
         this._scene = scene;
         this._unusedIndexes = [];
         this._primitives = scene.primitives;
         this._coneCollection = [];
-        this._dynamicObjectCollection = undefined;
-        this.setDynamicObjectCollection(dynamicObjectCollection);
-    };
-
-    /**
-     * Returns the scene being used by this visualizer.
-     *
-     * @returns {Scene} The scene being used by this visualizer.
-     */
-    DynamicConeVisualizerUsingCustomSensor.prototype.getScene = function() {
-        return this._scene;
-    };
-
-    /**
-     * Gets the DynamicObjectCollection being visualized.
-     *
-     * @returns {DynamicObjectCollection} The DynamicObjectCollection being visualized.
-     */
-    DynamicConeVisualizerUsingCustomSensor.prototype.getDynamicObjectCollection = function() {
-        return this._dynamicObjectCollection;
-    };
-
-    /**
-     * Sets the DynamicObjectCollection to visualize.
-     *
-     * @param dynamicObjectCollection The DynamicObjectCollection to visualizer.
-     */
-    DynamicConeVisualizerUsingCustomSensor.prototype.setDynamicObjectCollection = function(dynamicObjectCollection) {
-        var oldCollection = this._dynamicObjectCollection;
-        if (oldCollection !== dynamicObjectCollection) {
-            if (defined(oldCollection)) {
-                oldCollection.collectionChanged.removeEventListener(DynamicConeVisualizerUsingCustomSensor.prototype._onObjectsRemoved, this);
-                this.removeAllPrimitives();
-            }
-            this._dynamicObjectCollection = dynamicObjectCollection;
-            if (defined(dynamicObjectCollection)) {
-                dynamicObjectCollection.collectionChanged.addEventListener(DynamicConeVisualizerUsingCustomSensor.prototype._onObjectsRemoved, this);
-            }
-        }
+        this._dynamicObjectCollection = dynamicObjectCollection;
     };
 
     /**
-     * Updates all of the primitives created by this visualizer to match their
+     * Updates the primitives created by this visualizer to match their
      * DynamicObject counterpart at the given time.
+     * @memberof DynamicLabelVisualizer
      *
      * @param {JulianDate} time The time to update to.
      * @returns {Boolean} This function always returns true.
@@ -171,62 +122,25 @@ define([
     };
 
     /**
-     * Removes all primitives from the scene.
+     * Removes and destroys all primitives created by this instance.
+     * @memberof DynamicLabelVisualizer
      */
-    DynamicConeVisualizerUsingCustomSensor.prototype.removeAllPrimitives = function() {
-        var i, len;
-        for (i = 0, len = this._coneCollection.length; i < len; i++) {
-            this._primitives.remove(this._coneCollection[i]);
+    DynamicConeVisualizerUsingCustomSensor.prototype.destroy = function() {
+        var dynamicObjectCollection = this._dynamicObjectCollection;
+        dynamicObjectCollection.collectionChanged.removeEventListener(DynamicConeVisualizerUsingCustomSensor.prototype._onObjectsRemoved, this);
+
+        var i;
+        var dynamicObjects = dynamicObjectCollection.getObjects();
+        var length = dynamicObjects.length;
+        for (i = 0; i < length; i++) {
+            dynamicObjects[i]._coneVisualizerIndex = undefined;
         }
 
-        if (defined(this._dynamicObjectCollection)) {
-            var dynamicObjects = this._dynamicObjectCollection.getObjects();
-            for (i = dynamicObjects.length - 1; i > -1; i--) {
-                dynamicObjects[i]._coneVisualizerIndex = undefined;
-            }
+        length = this._coneCollection.length;
+        for (i = 0; i < length; i++) {
+            this._primitives.remove(this._coneCollection[i]);
         }
 
-        this._unusedIndexes = [];
-        this._coneCollection = [];
-    };
-
-    /**
-     * Returns true if this object was destroyed; otherwise, false.
-     * <br /><br />
-     * If this object was destroyed, it should not be used; calling any function other than
-     * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
-     *
-     * @memberof DynamicConeVisualizerUsingCustomSensor
-     *
-     * @returns {Boolean} True if this object was destroyed; otherwise, false.
-     *
-     * @see DynamicConeVisualizerUsingCustomSensor#destroy
-     */
-    DynamicConeVisualizerUsingCustomSensor.prototype.isDestroyed = function() {
-        return false;
-    };
-
-    /**
-     * Destroys the WebGL resources held by this object.  Destroying an object allows for deterministic
-     * release of WebGL resources, instead of relying on the garbage collector to destroy this object.
-     * <br /><br />
-     * Once an object is destroyed, it should not be used; calling any function other than
-     * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.  Therefore,
-     * assign the return value (<code>undefined</code>) to the object as done in the example.
-     *
-     * @memberof DynamicConeVisualizerUsingCustomSensor
-     *
-     * @returns {undefined}
-     *
-     * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
-     *
-     * @see DynamicConeVisualizerUsingCustomSensor#isDestroyed
-     *
-     * @example
-     * visualizer = visualizer && visualizer.destroy();
-     */
-    DynamicConeVisualizerUsingCustomSensor.prototype.destroy = function() {
-        this.setDynamicObjectCollection(undefined);
         return destroyObject(this);
     };
 
@@ -280,7 +194,6 @@ define([
             dynamicObject._coneVisualizerIndex = coneVisualizerIndex;
             cone.id = dynamicObject;
 
-            // CZML_TODO Determine official defaults
             cone.material = Material.fromType(Material.ColorType);
             cone.intersectionColor = Color.clone(Color.YELLOW);
             cone.intersectionWidth = 5.0;