Merge pull request #6110 from AnalyticalGraphicsInc/billboard-globe-undefined

Fix error with creating billboards without a globe

Author: Hannah

CHANGES.md

@@ -26,6 +26,7 @@ Change Log
    * Only one mesh per node is supported.
    * Only one primitive per mesh is supported.
 * Fixed a glTF animation bug that caused certain animations to jitter. [#5740](https://github.com/AnalyticalGraphicsInc/cesium/pull/5740)
+* Fixed a bug when creating billboard and model entities without a globe. [#6109](https://github.com/AnalyticalGraphicsInc/cesium/pull/6109)
 * Updated documentation links to reflect new locations on cesiumjs.org and cesium.com.
 * Added support for vertex shader uniforms when `tileset.colorBlendMode` is  `MIX` or `REPLACE`. [#5874](https://github.com/AnalyticalGraphicsInc/cesium/pull/5874)
 

Source/Scene/Billboard.js

@@ -950,10 +950,10 @@ define([
 
     Billboard._updateClamping = function(collection, owner) {
         var scene = collection._scene;
-        if (!defined(scene)) {
+        if (!defined(scene) || !defined(scene.globe)) {
             //>>includeStart('debug', pragmas.debug);
             if (owner._heightReference !== HeightReference.NONE) {
-                throw new DeveloperError('Height reference is not supported without a scene.');
+                throw new DeveloperError('Height reference is not supported without a scene and globe.');
             }
             //>>includeEnd('debug');
             return;

Source/Scene/Model.js

@@ -3924,10 +3924,10 @@ define([
         }
 
         var scene = model._scene;
-        if (!defined(scene) || (model.heightReference === HeightReference.NONE)) {
+        if (!defined(scene) || !defined(scene.globe) || (model.heightReference === HeightReference.NONE)) {
             //>>includeStart('debug', pragmas.debug);
             if (model.heightReference !== HeightReference.NONE) {
-                throw new DeveloperError('Height reference is not supported without a scene.');
+                throw new DeveloperError('Height reference is not supported without a scene and globe.');
             }
             //>>includeEnd('debug');
             model._clampedModelMatrix = undefined;

Specs/Scene/BillboardCollectionSpec.js

@@ -1790,6 +1790,24 @@ defineSuite([
         return deferred.promise;
     });
 
+    it('can add a billboard without a globe', function() {
+        scene.globe = undefined;
+
+        var billboardsWithoutGlobe = new BillboardCollection({
+            scene : scene
+        });
+
+        var position = Cartesian3.fromDegrees(-73.0, 40.0);
+        var b = billboardsWithoutGlobe.add({
+            position : position
+        });
+
+        scene.renderForSpecs();
+
+        expect(b.position).toEqual(position);
+        expect(b._actualClampedPosition).toBeUndefined();
+    });
+
     describe('height referenced billboards', function() {
         var billboardsWithHeight;
         beforeEach(function() {
@@ -1917,5 +1935,28 @@ defineSuite([
                 b.heightReference = HeightReference.CLAMP_TO_GROUND;
             }).toThrowDeveloperError();
         });
+
+        it('height reference without a globe rejects', function() {
+            scene.globe = undefined;
+
+            expect(function() {
+                return billboardsWithHeight.add({
+                    heightReference : HeightReference.CLAMP_TO_GROUND,
+                    position : Cartesian3.fromDegrees(-72.0, 40.0)
+                });
+            }).toThrowDeveloperError();
+        });
+
+        it('changing height reference without a globe throws DeveloperError', function() {
+            var b = billboardsWithHeight.add({
+                position : Cartesian3.fromDegrees(-72.0, 40.0)
+            });
+
+            scene.globe = undefined;
+
+            expect(function() {
+                b.heightReference = HeightReference.CLAMP_TO_GROUND;
+            }).toThrowDeveloperError();
+        });
     });
 }, 'WebGL');

Specs/Scene/ModelSpec.js

@@ -2947,7 +2947,7 @@ defineSuite([
                 position : Cartesian3.fromDegrees(-72.0, 40.0),
                 show : true
             }).otherwise(function(error) {
-                expect(error.message).toEqual('Height reference is not supported without a scene.');
+                expect(error.message).toEqual('Height reference is not supported without a scene and globe.');
             });
         });
 
@@ -2962,6 +2962,36 @@ defineSuite([
                 expect(function () {
                     return scene.renderForSpecs();
                 }).toThrowDeveloperError();
+
+                primitives.remove(model);
+            });
+        });
+
+        it('height reference without a globe rejects', function() {
+            scene.globe = undefined;
+            return loadModelJson(texturedBoxModel.gltf, {
+                heightReference : HeightReference.CLAMP_TO_GROUND,
+                position : Cartesian3.fromDegrees(-72.0, 40.0),
+                scene : scene,
+                show : true
+            }).otherwise(function(error) {
+                expect(error.message).toEqual('Height reference is not supported without a scene and globe.');
+            });
+        });
+
+        it('changing height reference without a globe throws DeveloperError', function() {
+            scene.globe = undefined;
+            return loadModelJson(texturedBoxModel.gltf, {
+                position : Cartesian3.fromDegrees(-72.0, 40.0),
+                show : true
+            }).then(function(model) {
+                model.heightReference = HeightReference.CLAMP_TO_GROUND;
+
+                expect(function () {
+                    return scene.renderForSpecs();
+                }).toThrowDeveloperError();
+
+                primitives.remove(model);
             });
         });
     });