Merge pull request #1417 from AnalyticalGraphicsInc/description

Description property for CZML
CesiumGS · Jan 29, 2014 · 6f752e4 · 6f752e4
2 parents 5b2f277 + afdc787
commit 6f752e4
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 2 deletions.
diff --git a/Source/DynamicScene/CzmlDataSource.js b/Source/DynamicScene/CzmlDataSource.js
@@ -726,6 +726,13 @@ define([
         dynamicObject.name = defaultValue(packet.name, dynamicObject.name);
     }
 
+    function processDescription(dynamicObject, packet, dynamicObjectCollection, sourceUri) {
+        var descriptionData = packet.description;
+        if (defined(descriptionData)) {
+            processPacketData(String, dynamicObject, 'description', descriptionData, undefined, sourceUri);
+        }
+    }
+
     function processPosition(dynamicObject, packet, dynamicObjectCollection, sourceUri) {
         var positionData = packet.position;
         if (defined(positionData)) {
@@ -1241,6 +1248,7 @@ define([
     processCone, //
     processLabel, //
     processName, //
+    processDescription, //
     processPath, //
     processPoint, //
     processPolygon, //

diff --git a/Source/DynamicScene/DynamicObject.js b/Source/DynamicScene/DynamicObject.js
@@ -62,11 +62,12 @@ define(['../Core/createGuid',
         this._vertexPositions = undefined;
         this._vector = undefined;
         this._viewFrom = undefined;
+        this._description = undefined;
 
         this._propertyChanged = new Event();
         this._propertyNames = ['parent', 'position', 'orientation', 'billboard', //
                                'cone', 'ellipsoid', 'ellipse', 'label', 'path', 'point', 'polygon', //
-                               'polyline', 'pyramid', 'vertexPositions', 'vector', 'viewFrom'];
+                               'polyline', 'pyramid', 'vertexPositions', 'vector', 'viewFrom', 'description'];
     };
 
     defineProperties(DynamicObject.prototype, {
@@ -226,7 +227,13 @@ define(['../Core/createGuid',
          * @memberof DynamicObject.prototype
          * @type {DynamicVector}
          */
-        vector : createDynamicPropertyDescriptor('vector', '_vector')
+        vector : createDynamicPropertyDescriptor('vector', '_vector'),
+        /**
+         * Gets or sets the description.
+         * @memberof DynamicObject.prototype
+         * @type {Property}
+         */
+        description : createDynamicPropertyDescriptor('description', '_description')
     });
 
     /**

diff --git a/Source/DynamicScene/GeoJsonDataSource.js b/Source/DynamicScene/GeoJsonDataSource.js
@@ -41,6 +41,27 @@ define([
         topojson) {
     "use strict";
 
+    function describe(properties, nameProperty) {
+        var html = '<table class="cesium-geoJsonDataSourceTable">';
+        for ( var key in properties) {
+            if (properties.hasOwnProperty(key)) {
+                if (key === nameProperty) {
+                    continue;
+                }
+                var value = properties[key];
+                if (defined(value)) {
+                    if (typeof value === 'object') {
+                        html += '<tr><td>' + key + '</td><td>' + describe(value) + '</td></tr>';
+                    } else {
+                        html += '<tr><td>' + key + '</td><td>' + value + '</td></tr>';
+                    }
+                }
+            }
+        }
+        html += '</table>';
+        return html;
+    }
+
     //GeoJSON specifies only the Feature object has a usable id property
     //But since "multi" geometries create multiple dynamicObject,
     //we can't use it for them either.
@@ -57,8 +78,45 @@ define([
             }
             id = finalId;
         }
+
         var dynamicObject = dynamicObjectCollection.getOrCreateObject(id);
         dynamicObject.geoJson = geoJson;
+
+        var properties = geoJson.properties;
+        if (defined(properties)) {
+            //Try and find a good name for the object from its meta-data
+            //TODO: Make both name and description creation user-configurable.
+            var key;
+            var nameProperty;
+            for (key in properties) {
+                if (properties.hasOwnProperty(key)) {
+                    var upperKey = key.toUpperCase();
+                    if (upperKey === 'NAME' || upperKey === 'TITLE') {
+                        nameProperty = key;
+                        dynamicObject.name = properties[key];
+                        break;
+                    }
+                }
+            }
+            if (!defined(nameProperty)) {
+                for (key in properties) {
+                    if (properties.hasOwnProperty(key)) {
+                        if (/name/i.test(key) || /title/i.test(key)) {
+                            nameProperty = key;
+                            dynamicObject.name = properties[key];
+                            break;
+                        }
+                    }
+                }
+            }
+
+            var description = describe(properties, nameProperty);
+            dynamicObject.description = {
+                getValue : function() {
+                    return description;
+                }
+            };
+        }
         return dynamicObject;
     }
 

diff --git a/Specs/DynamicScene/CzmlDataSourceSpec.js b/Specs/DynamicScene/CzmlDataSourceSpec.js
@@ -1088,6 +1088,17 @@ defineSuite([
         expect(dynamicObject.viewFrom.getValue(Iso8601.MINIMUM_VALUE)).toEqual(new Cartesian3(1.0, 2.0, 3.0));
     });
 
+    it('CZML description works.', function() {
+        var packet = {
+            description : "this is a description"
+        };
+
+        var dataSource = new CzmlDataSource();
+        dataSource.load(packet);
+        var dynamicObject = dataSource.getDynamicObjectCollection().getObjects()[0];
+        expect(dynamicObject.description.getValue(Iso8601.MINIMUM_VALUE)).toEqual(packet.description);
+    });
+
     it('CZML Availability works with a single interval.', function() {
         var packet1 = {
             id : 'testObject',

diff --git a/Specs/DynamicScene/GeoJsonDataSourceSpec.js b/Specs/DynamicScene/GeoJsonDataSourceSpec.js
@@ -400,6 +400,21 @@ defineSuite([
         });
     });
 
+    it('Generates description', function() {
+        var dataSource = new GeoJsonDataSource();
+        dataSource.load(topoJson);
+
+        var dynamicObjectCollection = dataSource.getDynamicObjectCollection();
+        waitsFor(function() {
+            return dynamicObjectCollection.getObjects().length === 2;
+        });
+        runs(function() {
+            var objects = dynamicObjectCollection.getObjects();
+            var polygon = objects[0];
+            expect(polygon.description).toBeDefined();
+        });
+    });
+
     it('Works with geometrycollection', function() {
         var dataSource = new GeoJsonDataSource();
         dataSource.load(geometryCollection);