cesium 0.13.0

data/app/assets/javascripts/DynamicScene/DynamicPathVisualizer.js

@@ -0,0 +1,402 @@
+/*global define*/
+define([
+        '../Core/DeveloperError',
+        '../Core/destroyObject',
+        '../Core/Cartesian3',
+        '../Core/Matrix4',
+        '../Core/Color',
+        '../Core/Transforms',
+        '../Core/ReferenceFrame',
+        '../Scene/SceneMode',
+        '../Scene/PolylineCollection'
+       ], function(
+         DeveloperError,
+         destroyObject,
+         Cartesian3,
+         Matrix4,
+         Color,
+         Transforms,
+         ReferenceFrame,
+         SceneMode,
+         PolylineCollection) {
+    "use strict";
+
+    var PolylineUpdater = function(scene, referenceFrame) {
+        this._unusedIndexes = [];
+        this._polylineCollection = new PolylineCollection();
+        this._scene = scene;
+        this._referenceFrame = referenceFrame;
+
+        var transform;
+        if (referenceFrame === ReferenceFrame.INERTIAL) {
+            transform = Transforms.computeIcrfToFixedMatrix;
+        }
+        scene.getPrimitives().add(this._polylineCollection);
+        this._transformFunction = transform;
+    };
+
+    PolylineUpdater.prototype.update = function(time) {
+        var transform = this._transformFunction;
+        if (typeof transform !== 'undefined') {
+            var toFixed = transform(time);
+            if (typeof toFixed !== 'undefined') {
+                Matrix4.fromRotationTranslation(toFixed, Cartesian3.ZERO, this._polylineCollection.modelMatrix);
+            }
+        }
+    };
+
+    PolylineUpdater.prototype.updateObject = function(time, dynamicObject) {
+        var dynamicPath = dynamicObject.path;
+        if (typeof dynamicPath === 'undefined') {
+            return;
+        }
+
+        var positionProperty = dynamicObject.position;
+        if (typeof positionProperty === 'undefined') {
+            return;
+        }
+
+        var polyline;
+        var property;
+        var sampleStart;
+        var sampleStop;
+        var showProperty = dynamicPath.show;
+        var pathVisualizerIndex = dynamicObject._pathVisualizerIndex;
+        var show = (typeof showProperty === 'undefined' || showProperty.getValue(time));
+
+        //While we want to show the path, there may not actually be anything to show
+        //depending on lead/trail settings.  Compute the interval of the path to
+        //show and check against actual availability.
+        if (show) {
+            property = dynamicPath.leadTime;
+            var leadTime;
+            if (typeof property !== 'undefined') {
+                leadTime = property.getValue(time);
+            }
+
+            property = dynamicPath.trailTime;
+            var trailTime;
+            if (typeof property !== 'undefined') {
+                trailTime = property.getValue(time);
+            }
+
+            var availability = dynamicObject.availability;
+            var hasAvailability = typeof availability !== 'undefined';
+            var hasLeadTime = typeof leadTime !== 'undefined';
+            var hasTrailTime = typeof trailTime !== 'undefined';
+
+            //Objects need to have either defined availability or both a lead and trail time in order to
+            //draw a path (since we can't draw "infinite" paths.
+            show = hasAvailability || (hasLeadTime && hasTrailTime);
+
+            //The final step is to compute the actual start/stop times of the path to show.
+            //If current time is outside of the availability interval, there's a chance that
+            //we won't have to draw anything anyway.
+            if (show) {
+                if (hasTrailTime) {
+                    sampleStart = time.addSeconds(-trailTime);
+                }
+                if (hasAvailability && (!hasTrailTime || availability.start.greaterThan(sampleStart))) {
+                    sampleStart = availability.start;
+                }
+
+                if (hasLeadTime) {
+                    sampleStop = time.addSeconds(leadTime);
+                }
+                if (hasAvailability && (!hasLeadTime || availability.stop.lessThan(sampleStop))) {
+                    sampleStop = availability.stop;
+                }
+                show = sampleStart.lessThan(sampleStop);
+            }
+        }
+
+        if (!show) {
+            //don't bother creating or updating anything else
+            if (typeof pathVisualizerIndex !== 'undefined') {
+                polyline = this._polylineCollection.get(pathVisualizerIndex);
+                polyline.setShow(false);
+                dynamicObject._pathVisualizerIndex = undefined;
+                this._unusedIndexes.push(pathVisualizerIndex);
+            }
+            return;
+        }
+
+        if (typeof pathVisualizerIndex === 'undefined') {
+            var unusedIndexes = this._unusedIndexes;
+            var length = unusedIndexes.length;
+            if (length > 0) {
+                pathVisualizerIndex = unusedIndexes.pop();
+                polyline = this._polylineCollection.get(pathVisualizerIndex);
+            } else {
+                pathVisualizerIndex = this._polylineCollection.getLength();
+                polyline = this._polylineCollection.add();
+            }
+            dynamicObject._pathVisualizerIndex = pathVisualizerIndex;
+            polyline.dynamicObject = dynamicObject;
+
+            // CZML_TODO Determine official defaults
+            polyline.setColor(Color.WHITE);
+            polyline.setOutlineColor(Color.BLACK);
+            polyline.setOutlineWidth(1);
+            polyline.setWidth(1);
+        } else {
+            polyline = this._polylineCollection.get(pathVisualizerIndex);
+        }
+
+        polyline.setShow(true);
+        polyline.setPositions(positionProperty._getValueRangeInReferenceFrame(sampleStart, sampleStop, time, this._referenceFrame, polyline.getPositions()));
+
+        property = dynamicPath.color;
+        if (typeof property !== 'undefined') {
+            polyline.setColor(property.getValue(time, polyline.getColor()));
+        }
+
+        property = dynamicPath.outlineColor;
+        if (typeof property !== 'undefined') {
+            polyline.setOutlineColor(property.getValue(time, polyline.getOutlineColor()));
+        }
+
+        property = dynamicPath.outlineWidth;
+        if (typeof property !== 'undefined') {
+            var outlineWidth = property.getValue(time);
+            if (typeof outlineWidth !== 'undefined') {
+                polyline.setOutlineWidth(outlineWidth);
+            }
+        }
+
+        property = dynamicPath.width;
+        if (typeof property !== 'undefined') {
+            var width = property.getValue(time);
+            if (typeof width !== 'undefined') {
+                polyline.setWidth(width);
+            }
+        }
+    };
+
+    PolylineUpdater.prototype.removeObject = function(dynamicObject) {
+        var pathVisualizerIndex = dynamicObject._pathVisualizerIndex;
+        if (typeof pathVisualizerIndex !== 'undefined') {
+            var polyline = this._polylineCollection.get(pathVisualizerIndex);
+            polyline.setShow(false);
+            this._unusedIndexes.push(pathVisualizerIndex);
+            dynamicObject._pathVisualizerIndex = undefined;
+        }
+    };
+
+    PolylineUpdater.prototype.destroy = function() {
+        this._scene.getPrimitives().remove(this._polylineCollection);
+        return destroyObject(this);
+    };
+
+    /**
+     * A DynamicObject visualizer which maps the DynamicPath instance
+     * in DynamicObject.path to a Polyline primitive.
+     * @alias DynamicPathVisualizer
+     * @constructor
+     *
+     * @param {Scene} scene The scene the primitives will be rendered in.
+     * @param {DynamicObjectCollection} [dynamicObjectCollection] The dynamicObjectCollection to visualize.
+     *
+     * @exception {DeveloperError} scene is required.
+     *
+     * @see DynamicPath
+     * @see Polyline
+     * @see Scene
+     * @see DynamicObject
+     * @see DynamicObjectCollection
+     * @see CompositeDynamicObjectCollection
+     * @see VisualizerCollection
+     * @see DynamicBillboardVisualizer
+     * @see DynamicConeVisualizer
+     * @see DynamicConeVisualizerUsingCustomSensorr
+     * @see DynamicLabelVisualizer
+     * @see DynamicPointVisualizer
+     * @see DynamicPolygonVisualizer
+     * @see DynamicPyramidVisualizer
+     *
+     */
+    var DynamicPathVisualizer = function(scene, dynamicObjectCollection) {
+        if (typeof scene === 'undefined') {
+            throw new DeveloperError('scene is required.');
+        }
+        this._scene = scene;
+        this._updaters = {};
+        this._dynamicObjectCollection = undefined;
+        this.setDynamicObjectCollection(dynamicObjectCollection);
+    };
+
+    /**
+     * Returns the scene being used by this visualizer.
+     *
+     * @returns {Scene} The scene being used by this visualizer.
+     */
+    DynamicPathVisualizer.prototype.getScene = function() {
+        return this._scene;
+    };
+
+    /**
+     * Gets the DynamicObjectCollection being visualized.
+     *
+     * @returns {DynamicObjectCollection} The DynamicObjectCollection being visualized.
+     */
+    DynamicPathVisualizer.prototype.getDynamicObjectCollection = function() {
+        return this._dynamicObjectCollection;
+    };
+
+    /**
+     * Sets the DynamicObjectCollection to visualize.
+     *
+     * @param dynamicObjectCollection The DynamicObjectCollection to visualizer.
+     */
+    DynamicPathVisualizer.prototype.setDynamicObjectCollection = function(dynamicObjectCollection) {
+        var oldCollection = this._dynamicObjectCollection;
+        if (oldCollection !== dynamicObjectCollection) {
+            if (typeof oldCollection !== 'undefined') {
+                oldCollection.objectsRemoved.removeEventListener(DynamicPathVisualizer.prototype._onObjectsRemoved);
+                this.removeAllPrimitives();
+            }
+            this._dynamicObjectCollection = dynamicObjectCollection;
+            if (typeof dynamicObjectCollection !== 'undefined') {
+                dynamicObjectCollection.objectsRemoved.addEventListener(DynamicPathVisualizer.prototype._onObjectsRemoved, this);
+            }
+        }
+    };
+
+    /**
+     * Updates all of the primitives created by this visualizer to match their
+     * DynamicObject counterpart at the given time.
+     *
+     * @param {JulianDate} time The time to update to.
+     *
+     * @exception {DeveloperError} time is required.
+     */
+    DynamicPathVisualizer.prototype.update = function(time) {
+        if (typeof time === 'undefined') {
+            throw new DeveloperError('time is requied.');
+        }
+
+        if (typeof this._dynamicObjectCollection !== 'undefined') {
+            var updaters = this._updaters;
+            for ( var key in updaters) {
+                if (updaters.hasOwnProperty(key)) {
+                    updaters[key].update(time);
+                }
+            }
+
+            var dynamicObjects = this._dynamicObjectCollection.getObjects();
+            for ( var i = 0, len = dynamicObjects.length; i < len; i++) {
+                var dynamicObject = dynamicObjects[i];
+
+                if (typeof dynamicObject.path === 'undefined') {
+                    continue;
+                }
+
+                var positionProperty = dynamicObject.position;
+                if (typeof positionProperty === 'undefined') {
+                    continue;
+                }
+
+                var lastUpdater = dynamicObject._pathUpdater;
+
+                var frameToVisualize = ReferenceFrame.FIXED;
+                if (this._scene.mode === SceneMode.SCENE3D) {
+                    frameToVisualize = positionProperty._getReferenceFrame();
+                }
+
+                var currentUpdater = this._updaters[frameToVisualize];
+
+                if ((lastUpdater === currentUpdater) && (typeof currentUpdater !== 'undefined')) {
+                    currentUpdater.updateObject(time, dynamicObject);
+                    continue;
+                }
+
+                if (typeof lastUpdater !== 'undefined') {
+                    lastUpdater.removeObject(dynamicObject);
+                }
+
+                if (typeof currentUpdater === 'undefined') {
+                    currentUpdater = new PolylineUpdater(this._scene, frameToVisualize);
+                    this._updaters[frameToVisualize] = currentUpdater;
+                }
+
+                dynamicObject._pathUpdater = currentUpdater;
+                if (typeof currentUpdater !== 'undefined') {
+                    currentUpdater.updateObject(time, dynamicObject);
+                }
+            }
+        }
+    };
+
+    /**
+     * Removes all primitives from the scene.
+     */
+    DynamicPathVisualizer.prototype.removeAllPrimitives = function() {
+        var updaters = this._updaters;
+        for ( var key in updaters) {
+            if (updaters.hasOwnProperty(key)) {
+                updaters[key].destroy();
+            }
+        }
+        this._updaters = {};
+
+        if (typeof this._dynamicObjectCollection !== 'undefined') {
+            var dynamicObjects = this._dynamicObjectCollection.getObjects();
+            for ( var i = dynamicObjects.length - 1; i > -1; i--) {
+                dynamicObjects[i]._pathUpdater = undefined;
+                dynamicObjects[i]._pathVisualizerIndex = 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.
+     *
+     * @memberof DynamicPathVisualizer
+     *
+     * @return {Boolean} True if this object was destroyed; otherwise, false.
+     *
+     * @see DynamicPathVisualizer#destroy
+     */
+    DynamicPathVisualizer.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 DynamicPathVisualizer
+     *
+     * @return {undefined}
+     *
+     * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
+     *
+     * @see DynamicPathVisualizer#isDestroyed
+     *
+     * @example
+     * visualizer = visualizer && visualizer.destroy();
+     */
+    DynamicPathVisualizer.prototype.destroy = function() {
+        this.removeAllPrimitives();
+        return destroyObject(this);
+    };
+
+    DynamicPathVisualizer.prototype._onObjectsRemoved = function(dynamicObjectCollection, dynamicObjects) {
+        for ( var i = dynamicObjects.length - 1; i > -1; i--) {
+            var dynamicObject = dynamicObjects[i];
+            var _pathUpdater = dynamicObject._pathUpdater;
+            if (typeof _pathUpdater !== 'undefined') {
+                _pathUpdater.removeObject(dynamicObject);
+            }
+        }
+    };
+
+    return DynamicPathVisualizer;
+});

data/app/assets/javascripts/DynamicScene/DynamicPoint.js

@@ -0,0 +1,184 @@
+/*global define*/
+define([
+        '../Core/TimeInterval',
+        '../Core/defaultValue',
+        './CzmlBoolean',
+        './CzmlNumber',
+        './CzmlColor',
+        './DynamicProperty'
+    ], function(
+         TimeInterval,
+         defaultValue,
+         CzmlBoolean,
+         CzmlNumber,
+         CzmlColor,
+         DynamicProperty) {
+    "use strict";
+
+    /**
+     * Represents a time-dynamic point, typically used in conjunction with DynamicPointVisualizer and
+     * DynamicObjectCollection to visualize CZML.
+     *
+     * @alias DynamicPoint
+     * @constructor
+     *
+     * @see DynamicObject
+     * @see DynamicProperty
+     * @see DynamicObjectCollection
+     * @see DynamicPointVisualizer
+     * @see VisualizerCollection
+     * @see Billboard
+     * @see BillboardCollection
+     * @see CzmlDefaults
+     */
+    var DynamicPoint = function() {
+        /**
+         * A DynamicProperty of type CzmlColor which determines the point's color.
+         * @type DynamicProperty
+         */
+        this.color = undefined;
+        /**
+         * A DynamicProperty of type CzmlNumber which determines the point's pixel size.
+         * @type DynamicProperty
+         */
+        this.pixelSize = undefined;
+        /**
+         * A DynamicProperty of type CzmlColor which determines the point's outline color.
+         * @type DynamicProperty
+         */
+        this.outlineColor = undefined;
+        /**
+         * A DynamicProperty of type CzmlNumber which determines the point's outline width.
+         * @type DynamicProperty
+         */
+        this.outlineWidth = undefined;
+        /**
+         * A DynamicProperty of type CzmlBoolean which determines the point's visibility.
+         * @type DynamicProperty
+         */
+        this.show = undefined;
+    };
+
+    /**
+     * Processes a single CZML packet and merges its data into the provided DynamicObject's point.
+     * If the DynamicObject does not have a point, one is created.  This method is not
+     * normally called directly, but is part of the array of CZML processing functions that is
+     * passed into the DynamicObjectCollection constructor.
+     *
+     * @param {DynamicObject} dynamicObject The DynamicObject which will contain the point data.
+     * @param {Object} packet The CZML packet to process.
+     * @returns {Boolean} true if any new properties were created while processing the packet, false otherwise.
+     *
+     * @see DynamicObject
+     * @see DynamicProperty
+     * @see DynamicObjectCollection
+     * @see CzmlDefaults#updaters
+     */
+    DynamicPoint.processCzmlPacket = function(dynamicObject, packet) {
+        var pointData = packet.point;
+        if (typeof pointData === 'undefined') {
+            return false;
+        }
+
+        var pointUpdated = false;
+        var point = dynamicObject.point;
+        pointUpdated = typeof point === 'undefined';
+        if (pointUpdated) {
+            dynamicObject.point = point = new DynamicPoint();
+        }
+
+        var interval = pointData.interval;
+        if (typeof interval !== 'undefined') {
+            interval = TimeInterval.fromIso8601(interval);
+        }
+
+        if (typeof pointData.color !== 'undefined') {
+            var color = point.color;
+            if (typeof color === 'undefined') {
+                point.color = color = new DynamicProperty(CzmlColor);
+                pointUpdated = true;
+            }
+            color.processCzmlIntervals(pointData.color, interval);
+        }
+
+        if (typeof pointData.pixelSize !== 'undefined') {
+            var pixelSize = point.pixelSize;
+            if (typeof pixelSize === 'undefined') {
+                point.pixelSize = pixelSize = new DynamicProperty(CzmlNumber);
+                pointUpdated = true;
+            }
+            pixelSize.processCzmlIntervals(pointData.pixelSize, interval);
+        }
+
+        if (typeof pointData.outlineColor !== 'undefined') {
+            var outlineColor = point.outlineColor;
+            if (typeof outlineColor === 'undefined') {
+                point.outlineColor = outlineColor = new DynamicProperty(CzmlColor);
+                pointUpdated = true;
+            }
+            outlineColor.processCzmlIntervals(pointData.outlineColor, interval);
+        }
+
+        if (typeof pointData.outlineWidth !== 'undefined') {
+            var outlineWidth = point.outlineWidth;
+            if (typeof outlineWidth === 'undefined') {
+                point.outlineWidth = outlineWidth = new DynamicProperty(CzmlNumber);
+                pointUpdated = true;
+            }
+            outlineWidth.processCzmlIntervals(pointData.outlineWidth, interval);
+        }
+
+        if (typeof pointData.show !== 'undefined') {
+            var show = point.show;
+            if (typeof show === 'undefined') {
+                point.show = show = new DynamicProperty(CzmlBoolean);
+                pointUpdated = true;
+            }
+            show.processCzmlIntervals(pointData.show, interval);
+        }
+        return pointUpdated;
+    };
+
+    /**
+     * Given two DynamicObjects, takes the point properties from the second
+     * and assigns them to the first, assuming such a property did not already exist.
+     * This method is not normally called directly, but is part of the array of CZML processing
+     * functions that is passed into the CompositeDynamicObjectCollection constructor.
+     *
+     * @param {DynamicObject} targetObject The DynamicObject which will have properties merged onto it.
+     * @param {DynamicObject} objectToMerge The DynamicObject containing properties to be merged.
+     *
+     * @see CzmlDefaults
+     */
+    DynamicPoint.mergeProperties = function(targetObject, objectToMerge) {
+        var pointToMerge = objectToMerge.point;
+        if (typeof pointToMerge !== 'undefined') {
+
+            var targetPoint = targetObject.point;
+            if (typeof targetPoint === 'undefined') {
+                targetObject.point = targetPoint = new DynamicPoint();
+            }
+
+            targetPoint.color = defaultValue(targetPoint.color, pointToMerge.color);
+            targetPoint.pixelSize = defaultValue(targetPoint.pixelSize, pointToMerge.pixelSize);
+            targetPoint.outlineColor = defaultValue(targetPoint.outlineColor, pointToMerge.outlineColor);
+            targetPoint.outlineWidth = defaultValue(targetPoint.outlineWidth, pointToMerge.outlineWidth);
+            targetPoint.show = defaultValue(targetPoint.show, pointToMerge.show);
+        }
+    };
+
+    /**
+     * Given a DynamicObject, undefines the point associated with it.
+     * This method is not normally called directly, but is part of the array of CZML processing
+     * functions that is passed into the CompositeDynamicObjectCollection constructor.
+     *
+     * @param {DynamicObject} dynamicObject The DynamicObject to remove the point from.
+     *
+     * @see CzmlDefaults
+     */
+    DynamicPoint.undefineProperties = function(dynamicObject) {
+        dynamicObject.point = undefined;
+    };
+
+    return DynamicPoint;
+});