Merge pull request #7582 from shehzan10/fix-followsurface-arctype

Change usage of followSurface to arcType. Add CZML property for it.
CesiumGS · Feb 21, 2019 · 0fda487 · 0fda487
2 parents 62a70de + 0cbd2d3
commit 0fda487
Show file tree

Hide file tree

Showing 20 changed files with 70 additions and 34 deletions.
diff --git a/Apps/SampleData/simple.czml b/Apps/SampleData/simple.czml
@@ -122,7 +122,7 @@
           }
         }
       },
-      "followSurface":false,
+      "arcType":"NONE",
       "positions":{
         "references":[
           "Satellite/Geoeye1#position","Satellite/ISS#position"
@@ -207,7 +207,7 @@
           }
         }
       },
-      "followSurface":false,
+      "arcType":"NONE",
       "positions":{
         "references":[
           "Facility/AGI#position","Satellite/ISS#position"
@@ -232,7 +232,7 @@
           }
         }
       },
-      "followSurface":false,
+      "arcType":"NONE",
       "positions":{
         "references":[
           "Facility/AGI#position","Satellite/Geoeye1/Sensor/Sensor#position"

diff --git a/Apps/Sandcastle/gallery/CZML Polyline.html b/Apps/Sandcastle/gallery/CZML Polyline.html
@@ -112,7 +112,7 @@
                 }
             }
         },
-        "followSurface" : false,
+        "arcType" : "NONE",
         "width" : 10
     }
 }, {

diff --git a/Apps/Sandcastle/gallery/Clamp to Terrain.html b/Apps/Sandcastle/gallery/Clamp to Terrain.html
@@ -197,7 +197,7 @@
             viewer.entities.add({
                 polyline : {
                     positions : Cesium.Ellipsoid.WGS84.cartographicArrayToCartesianArray(samples),
-                    followSurface : false,
+                    arcType : Cesium.ArcType.NONE,
                     width : 5,
                     material : new Cesium.PolylineOutlineMaterialProperty({
                         color : Cesium.Color.ORANGE,

diff --git a/Apps/Sandcastle/gallery/Custom DataSource.html b/Apps/Sandcastle/gallery/Custom DataSource.html
@@ -319,7 +319,7 @@
             var polyline = new Cesium.PolylineGraphics();
             polyline.material = new Cesium.ColorMaterialProperty(color);
             polyline.width = new Cesium.ConstantProperty(2);
-            polyline.followSurface = new Cesium.ConstantProperty(false);
+            polyline.arcType = new Cesium.ConstantProperty(Cesium.ArcType.NONE);
             polyline.positions = new Cesium.ConstantProperty([surfacePosition, heightPosition]);
 
             //The polyline instance itself needs to be on an entity.

diff --git a/Apps/Sandcastle/gallery/Sample Height from 3D Tiles.html b/Apps/Sandcastle/gallery/Sample Height from 3D Tiles.html
@@ -81,7 +81,7 @@
         viewer.entities.add({
             polyline : {
                 positions : clampedCartesians,
-                followSurface : false,
+                arcType : Cesium.ArcType.NONE,
                 width : 2,
                 material : new Cesium.PolylineOutlineMaterialProperty({
                     color : Cesium.Color.YELLOW

diff --git a/Apps/Sandcastle/gallery/Star Burst.html b/Apps/Sandcastle/gallery/Star Burst.html
@@ -208,7 +208,7 @@
         instances.push(new Cesium.GeometryInstance({
             geometry : new Cesium.SimplePolylineGeometry({
                 positions : [starBurstState.center, lines[i]],
-                followSurface : false,
+                arcType : Cesium.ArcType.NONE,
                 granularity : Cesium.Math.PI_OVER_FOUR
             }),
             attributes : {

diff --git a/Apps/Sandcastle/gallery/development/Pick From Ray.html b/Apps/Sandcastle/gallery/development/Pick From Ray.html
@@ -85,7 +85,7 @@
     polyline : {
         positions : arrowPositions,
         width : 10,
-        followSurface : false,
+        arcType : Cesium.ArcType.NONE,
         material : new Cesium.PolylineArrowMaterialProperty(Cesium.Color.YELLOW)
     }
 });

diff --git a/Apps/Sandcastle/gallery/development/Polyline.html b/Apps/Sandcastle/gallery/development/Polyline.html
@@ -52,7 +52,7 @@
 
 // Example 2: Draw a straight blue polyline
 
-// Setting the followSurface option to false will allow
+// Setting the arcType option to ArcType.NONE will allow
 // you to draw a straight polyline.  Otherwise, it will
 // curve to the globe surface.
 scene.primitives.add(new Cesium.Primitive({
@@ -64,7 +64,7 @@
             ]),
             width : 5.0,
             vertexFormat : Cesium.PolylineColorAppearance.VERTEX_FORMAT,
-            followSurface: false
+            arcType: Cesium.ArcType.NONE
         }),
         attributes: {
             color: Cesium.ColorGeometryInstanceAttribute.fromColor(Cesium.Color.BLUE)

diff --git a/Apps/Sandcastle/gallery/development/Simple Polyline.html b/Apps/Sandcastle/gallery/development/Simple Polyline.html
@@ -53,13 +53,13 @@
 }
 // For per segment coloring, provide the colors options with an
 // array of colors where the length is equal to the number of positions.
-// Setting followSurface to false will draw straight lines.
+// Setting arcType to ArcType.NONE will draw straight lines.
 // Otherwise, the polyline curves to the surface of the globe.
 var perSegmentPolyline = new Cesium.GeometryInstance({
     geometry : new Cesium.SimplePolylineGeometry({
         positions : positions,
         colors : colors,
-        followSurface: false
+        arcType: Cesium.ArcType.NONE
     })
 });
 

diff --git a/Source/Core/PolylineGeometry.js b/Source/Core/PolylineGeometry.js
@@ -143,7 +143,7 @@ define([
 
         this._followSurface = defaultValue(options.followSurface, true);
         if (defined(options.followSurface)) {
-            deprecationWarning('PolylineGeometry.followSurface', 'PolylineGeometry.followSurface is deprecated and will be removed in Cesium 1.55. Use PolylineGeometry.arcType instead.');
+            deprecationWarning('PolylineGeometry.followSurface', 'PolylineGeometry.followSurface is deprecated and will be removed in Cesium 1.57. Use PolylineGeometry.arcType instead.');
             options.arcType = options.followSurface ? ArcType.GEODESIC : ArcType.NONE;
         }
         this._arcType = defaultValue(options.arcType, ArcType.GEODESIC);

diff --git a/Source/Core/SimplePolylineGeometry.js b/Source/Core/SimplePolylineGeometry.js
@@ -128,7 +128,7 @@ define([
 
         this._followSurface = defaultValue(options.followSurface, true);
         if (defined(options.followSurface)) {
-            deprecationWarning('PolylineGeometry.followSurface', 'PolylineGeometry.followSurface is deprecated and will be removed in Cesium 1.55. Use PolylineGeometry.arcType instead.');
+            deprecationWarning('PolylineGeometry.followSurface', 'PolylineGeometry.followSurface is deprecated and will be removed in Cesium 1.57. Use PolylineGeometry.arcType instead.');
             options.arcType = options.followSurface ? ArcType.GEODESIC : ArcType.NONE;
         }
         this._arcType = defaultValue(options.arcType, ArcType.GEODESIC);

diff --git a/Source/DataSources/CzmlDataSource.js b/Source/DataSources/CzmlDataSource.js
@@ -1,4 +1,5 @@
 define([
+        '../Core/ArcType',
         '../Core/BoundingRectangle',
         '../Core/Cartesian2',
         '../Core/Cartesian3',
@@ -86,6 +87,7 @@ define([
         './VelocityVectorProperty',
         './WallGraphics'
     ], function(
+        ArcType,
         BoundingRectangle,
         Cartesian2,
         Cartesian3,
@@ -501,6 +503,8 @@ define([
         } else if (czmlInterval.hasOwnProperty('rgba') ||
                    czmlInterval.hasOwnProperty('rgbaf')) {
             return Color;
+        } else if (czmlInterval.hasOwnProperty('arcType')) {
+            return ArcType;
         } else if (czmlInterval.hasOwnProperty('colorBlendMode')) {
             return ColorBlendMode;
         } else if (czmlInterval.hasOwnProperty('cornerType')) {
@@ -546,6 +550,8 @@ define([
         // The associations in this function need to be kept in sync with the
         // associations in getPropertyType
         switch (type) {
+            case ArcType:
+                return ArcType[defaultValue(czmlInterval.arcType, czmlInterval)];
             case Array:
                 return czmlInterval.array;
             case Boolean:
@@ -1765,6 +1771,7 @@ define([
         processPacketData(Boolean, polygon, 'perPositionHeight', polygonData.perPositionHeight, interval, sourceUri, entityCollection);
         processPacketData(Boolean, polygon, 'closeTop', polygonData.closeTop, interval, sourceUri, entityCollection);
         processPacketData(Boolean, polygon, 'closeBottom', polygonData.closeBottom, interval, sourceUri, entityCollection);
+        processPacketData(ArcType, polygon, 'arcType', polygonData.arcType, interval, sourceUri, entityCollection);
         processPacketData(ShadowMode, polygon, 'shadows', polygonData.shadows, interval, sourceUri, entityCollection);
         processPacketData(DistanceDisplayCondition, polygon, 'distanceDisplayCondition', polygonData.distanceDisplayCondition, interval, sourceUri, entityCollection);
         processPacketData(Number, polygon, 'zIndex', polygonData.zIndex, interval, sourceUri, entityCollection);
@@ -1794,7 +1801,17 @@ define([
         processPacketData(Number, polyline, 'granularity', polylineData.granularity, interval, sourceUri, entityCollection);
         processMaterialPacketData(polyline, 'material', polylineData.material, interval, sourceUri, entityCollection);
         processMaterialPacketData(polyline, 'depthFailMaterial', polylineData.depthFailMaterial, interval, sourceUri, entityCollection);
-        processPacketData(Boolean, polyline, 'followSurface', polylineData.followSurface, interval, sourceUri, entityCollection);
+        // Don't want to break CZML spec to keep this workaround even after followSurface has been deprecated from geometry.
+        // See https://github.com/AnalyticalGraphicsInc/cesium/pull/7582#discussion_r258695385
+        if (defined(polylineData.followSurface) && !defined(polylineData.arcType)) {
+            if (polyline.followSurface) {
+                processPacketData(ArcType, polyline, 'arcType', ArcType.GEODESIC, interval, sourceUri, entityCollection);
+            } else {
+                processPacketData(ArcType, polyline, 'arcType', ArcType.NONE, interval, sourceUri, entityCollection);
+            }
+        } else {
+            processPacketData(ArcType, polyline, 'arcType', polylineData.arcType, interval, sourceUri, entityCollection);
+        }
         processPacketData(Boolean, polyline, 'clampToGround', polylineData.clampToGround, interval, sourceUri, entityCollection);
         processPacketData(ShadowMode, polyline, 'shadows', polylineData.shadows, interval, sourceUri, entityCollection);
         processPacketData(DistanceDisplayCondition, polyline, 'distanceDisplayCondition', polylineData.distanceDisplayCondition, interval, sourceUri, entityCollection);

diff --git a/Source/DataSources/KmlDataSource.js b/Source/DataSources/KmlDataSource.js
@@ -1,4 +1,5 @@
 define([
+        '../Core/ArcType',
         '../Core/AssociativeArray',
         '../Core/BoundingRectangle',
         '../Core/Cartesian2',
@@ -64,6 +65,7 @@ define([
         './TimeIntervalCollectionProperty',
         './WallGraphics'
     ], function(
+        ArcType,
         AssociativeArray,
         BoundingRectangle,
         Cartesian2,
@@ -1287,7 +1289,7 @@ define([
             entity.polyline = polyline;
             polyline.positions = createPositionPropertyArrayFromAltitudeMode(coordinates, altitudeMode, gxAltitudeMode, ellipsoid);
             if (!tessellate || canExtrude) {
-                polyline.followSurface = false;
+                polyline.arcType = ArcType.NONE;
             }
         }
 

diff --git a/Specs/Core/SimplePolylineGeometrySpec.js b/Specs/Core/SimplePolylineGeometrySpec.js
@@ -116,7 +116,7 @@ defineSuite([
         var positions = [new Cartesian3(), new Cartesian3(1.0, 0.0, 0.0), new Cartesian3(2.0, 0.0, 0.0)];
         var line = SimplePolylineGeometry.createGeometry(new SimplePolylineGeometry({
             positions : positions,
-            followSurface: false
+            arcType: ArcType.NONE
         }));
 
         expect(line.attributes.position.values).toEqual([0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 2.0, 0.0, 0.0]);
@@ -131,7 +131,7 @@ defineSuite([
         var line = SimplePolylineGeometry.createGeometry(new SimplePolylineGeometry({
             positions : positions,
             colors : colors,
-            followSurface: false
+            arcType : ArcType.NONE
         }));
 
         expect(line.attributes.color).toBeDefined();
@@ -147,7 +147,7 @@ defineSuite([
             positions : positions,
             colors : colors,
             colorsPerVertex : true,
-            followSurface: false
+            arcType : ArcType.NONE
         }));
 
         expect(line.attributes.color).toBeDefined();
@@ -161,7 +161,7 @@ defineSuite([
         positions : positions,
         colors : [Color.RED, Color.LIME, Color.BLUE],
         colorsPerVertex : true,
-        followSurface : false,
+        arcType : ArcType.NONE,
         granularity : 11,
         ellipsoid : new Ellipsoid(12, 13, 14)
     });
@@ -171,7 +171,7 @@ defineSuite([
     line = new SimplePolylineGeometry({
         positions : positions,
         colorsPerVertex : false,
-        followSurface : false,
+        arcType : ArcType.NONE,
         granularity : 11,
         ellipsoid : new Ellipsoid(12, 13, 14)
     });

diff --git a/Specs/Data/CZML/ValidationDocument.czml b/Specs/Data/CZML/ValidationDocument.czml
@@ -449,6 +449,7 @@
       "perPositionHeight":true,
       "closeTop":true,
       "closeBottom":true,
+      "arcType":"GEODESIC",
       "shadows":"CAST_ONLY",
       "distanceDisplayCondition":{
         "distanceDisplayCondition":[
@@ -474,7 +475,7 @@
           }
         }
       },
-      "followSurface":true,
+      "arcType":"GEODESIC",
       "shadows":"CAST_ONLY",
       "depthFailMaterial":{
         "solidColor":{
@@ -6281,6 +6282,9 @@
       "closeBottom":{
         "reference":"Constant#polygon.closeBottom"
       },
+      "arcType":{
+        "reference":"Constant#polygon.arcType"
+      },
       "shadows":{
         "reference":"Constant#polygon.shadows"
       },
@@ -6313,6 +6317,9 @@
       "followSurface":{
         "reference":"Constant#polyline.followSurface"
       },
+      "arcType":{
+        "reference":"Constant#polyline.arcType"
+      },
       "shadows":{
         "reference":"Constant#polyline.shadows"
       },

diff --git a/Specs/DataSources/CzmlDataSourceSpec.js b/Specs/DataSources/CzmlDataSourceSpec.js
@@ -1,5 +1,6 @@
 defineSuite([
         'DataSources/CzmlDataSource',
+        'Core/ArcType',
         'Core/BoundingRectangle',
         'Core/Cartesian2',
         'Core/Cartesian3',
@@ -38,6 +39,7 @@ defineSuite([
         'ThirdParty/when'
     ], function(
         CzmlDataSource,
+        ArcType,
         BoundingRectangle,
         Cartesian2,
         Cartesian3,
@@ -3775,7 +3777,7 @@ defineSuite([
             expect(e.polyline.width.getValue(date)).toEqual(14667.0);
             expect(e.polyline.granularity.getValue(date)).toEqual(53395.0);
             expect(e.polyline.material.color.getValue(date)).toEqual(Color.fromBytes(88, 0, 232, 230));
-            expect(e.polyline.followSurface.getValue(date)).toEqual(true);
+            expect(e.polyline.arcType.getValue(date)).toEqual(ArcType.GEODESIC);
             expect(e.polyline.shadows.getValue(date)).toEqual(ShadowMode.CAST_ONLY);
             expect(e.polyline.depthFailMaterial.color.getValue(date)).toEqual(Color.fromBytes(197, 195, 115, 198));
             expect(e.polyline.distanceDisplayCondition.getValue(date)).toEqual(new DistanceDisplayCondition(5807, 30486));
@@ -4584,7 +4586,7 @@ defineSuite([
             expect(e.polyline.width.getValue(date)).toEqual(constant.polyline.width.getValue(date));
             expect(e.polyline.granularity.getValue(date)).toEqual(constant.polyline.granularity.getValue(date));
             expect(e.polyline.material.color.getValue(date)).toEqual(constant.polyline.material.color.getValue(date));
-            expect(e.polyline.followSurface.getValue(date)).toEqual(constant.polyline.followSurface.getValue(date));
+            expect(e.polyline.arcType.getValue(date)).toEqual(constant.polyline.arcType.getValue(date));
             expect(e.polyline.shadows.getValue(date)).toEqual(constant.polyline.shadows.getValue(date));
             expect(e.polyline.depthFailMaterial.color.getValue(date)).toEqual(constant.polyline.depthFailMaterial.color.getValue(date));
             expect(e.polyline.distanceDisplayCondition.getValue(date)).toEqual(constant.polyline.distanceDisplayCondition.getValue(date));

diff --git a/Specs/DataSources/KmlDataSourceSpec.js b/Specs/DataSources/KmlDataSourceSpec.js
@@ -1,5 +1,6 @@
 defineSuite([
         'DataSources/KmlDataSource',
+        'Core/ArcType',
         'Core/BoundingRectangle',
         'Core/Cartesian2',
         'Core/Cartesian3',
@@ -38,6 +39,7 @@ defineSuite([
         'ThirdParty/when'
     ], function(
         KmlDataSource,
+        ArcType,
         BoundingRectangle,
         Cartesian2,
         Cartesian3,
@@ -2161,7 +2163,7 @@ defineSuite([
             expect(polyline).toBeDefined();
 
             expect(polyline.positions).toBeUndefined();
-            expect(polyline.followSurface).toBeUndefined();
+            expect(polyline.arcType).toBeUndefined();
             expect(polyline.width).toBeUndefined();
             expect(polyline.show).toBeUndefined();
             expect(polyline.material).toBeUndefined();
@@ -2899,7 +2901,7 @@ defineSuite([
             var entity = entities[0];
             expect(entity.wall).toBeUndefined();
             expect(entity.polyline).toBeDefined();
-            expect(entity.polyline.followSurface.getValue()).toEqual(false);
+            expect(entity.polyline.arcType.getValue()).toEqual(ArcType.NONE);
         });
     });
 
@@ -2923,7 +2925,7 @@ defineSuite([
 
             var positions = entity.polyline.positions.getValue(Iso8601.MINIMUM_VALUE);
             expect(positions).toEqualEpsilon([Cartesian3.fromDegrees(1, 2), Cartesian3.fromDegrees(4, 5)], CesiumMath.EPSILON10);
-            expect(entity.polyline.followSurface.getValue()).toEqual(false);
+            expect(entity.polyline.arcType.getValue()).toEqual(ArcType.NONE);
         });
     });
 
@@ -2968,7 +2970,7 @@ defineSuite([
             expect(entities.length).toEqual(1);
 
             var entity = entities[0];
-            expect(entity.polyline.followSurface).toBeUndefined();
+            expect(entity.polyline.arcType).toBeUndefined();
             var positions = entity.polyline.positions.getValue(Iso8601.MINIMUM_VALUE);
             expect(positions).toEqualEpsilon([Cartesian3.fromDegrees(1, 2), Cartesian3.fromDegrees(4, 5)], CesiumMath.EPSILON10);
         });
@@ -2991,7 +2993,7 @@ defineSuite([
             expect(entities.length).toEqual(1);
 
             var entity = entities[0];
-            expect(entity.polyline.followSurface).toBeUndefined();
+            expect(entity.polyline.arcType).toBeUndefined();
             var positions = entity.polyline.positions.getValue(Iso8601.MINIMUM_VALUE);
             expect(positions).toEqualEpsilon([Cartesian3.fromDegrees(1, 2), Cartesian3.fromDegrees(4, 5)], CesiumMath.EPSILON10);
         });