Merge pull request #6154 from AnalyticalGraphicsInc/dont-animate-by-default

Clock should not animate by default

Author: mramato

Apps/Sandcastle/gallery/3D Models Coloring.html

@@ -88,7 +88,8 @@
 var viewer = new Cesium.Viewer('cesiumContainer', {
     infoBox : false,
     selectionIndicator : false,
-    shadows : true
+    shadows : true,
+    shouldAnimate : true
 });
 
 var entity;

Apps/Sandcastle/gallery/3D Models.html

@@ -30,7 +30,8 @@
 var viewer = new Cesium.Viewer('cesiumContainer', {
     infoBox : false,
     selectionIndicator : false,
-    shadows : true
+    shadows : true,
+    shouldAnimate : true
 });
 
 function createModel(url, height) {
@@ -94,4 +95,4 @@
 }
 </script>
 </body>
-</html>
+</html>

Apps/Sandcastle/gallery/CZML Custom Properties.html

@@ -92,7 +92,10 @@
     }
 }];
 
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
+
 var dataSource = new Cesium.CzmlDataSource();
 
 function scaleProperty(property, scalingFactor) {

Apps/Sandcastle/gallery/CZML Model - Node Transformations.html

@@ -70,7 +70,10 @@
     }
 }];
 
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
+
 var dataSourcePromise = viewer.dataSources.add(Cesium.CzmlDataSource.load(czml));
 
 dataSourcePromise.then(function(dataSource){

Apps/Sandcastle/gallery/CZML Model.html

@@ -45,7 +45,10 @@
     }
 }];
 
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
+
 var dataSourcePromise = viewer.dataSources.add(Cesium.CzmlDataSource.load(czml));
 
 dataSourcePromise.then(function(dataSource){

Apps/Sandcastle/gallery/CZML Path.html

@@ -1864,17 +1864,18 @@
 }];
 
 var terrainProvider = new Cesium.CesiumTerrainProvider({
-url : 'https://assets.agi.com/stk-terrain/v1/tilesets/world/tiles',
-requestVertexNormals : true
+    url : 'https://assets.agi.com/stk-terrain/v1/tilesets/world/tiles',
+    requestVertexNormals : true
 });
 
 var viewer = new Cesium.Viewer('cesiumContainer', {
-terrainProvider : terrainProvider,
-baseLayerPicker : false
+    terrainProvider : terrainProvider,
+    baseLayerPicker : false,
+    shouldAnimate : true
 });
 
 viewer.dataSources.add(Cesium.CzmlDataSource.load(czml)).then(function(ds) {
-viewer.trackedEntity = ds.entities.getById('path');
+    viewer.trackedEntity = ds.entities.getById('path');
 });
 
   //Sandcastle_End

Apps/Sandcastle/gallery/CZML Point - Time Dynamic.html

@@ -56,7 +56,10 @@
     }
 }];
 
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
+
 viewer.dataSources.add(Cesium.CzmlDataSource.load(czml));
 
 //Sandcastle_End

Apps/Sandcastle/gallery/CZML Polygon - Interpolating References.html

@@ -97,7 +97,10 @@
     }
 }];
 
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
+
 viewer.dataSources.add(Cesium.CzmlDataSource.load(czml));
 
 

Apps/Sandcastle/gallery/CZML Polygon - Intervals, Availability.html

@@ -138,7 +138,10 @@
     }
 }];
 
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
+
 viewer.dataSources.add(Cesium.CzmlDataSource.load(czml));
 
   //Sandcastle_End

Apps/Sandcastle/gallery/CZML.html

@@ -28,7 +28,9 @@
 function startup(Cesium) {
     'use strict';
 //Sandcastle_Begin
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
 
 Sandcastle.addDefaultToolbarButton('Satellites', function() {
     viewer.dataSources.add(Cesium.CzmlDataSource.load('../../SampleData/simple.czml'));

Apps/Sandcastle/gallery/Callback Property.html

@@ -32,6 +32,7 @@
 // Use a CallbackProperty when your data can't be pre-computed
 // or needs to be derived from other properties at runtime.
 var viewer = new Cesium.Viewer('cesiumContainer');
+viewer.clock.shouldAnimate = true;
 
 var startLatitude = 35;
 var startLongitude = -120;

Apps/Sandcastle/gallery/Cardboard.html

@@ -52,6 +52,7 @@
 viewer.clock.currentTime = start.clone();
 viewer.clock.clockRange = Cesium.ClockRange.LOOP_STOP;
 viewer.clock.multiplier = 1.0;
+viewer.clock.shouldAnimate = true;
 
 function computeCirclularFlight(lon, lat, radius) {
     var property = new Cesium.SampledPositionProperty();

Apps/Sandcastle/gallery/Clock.html

@@ -34,7 +34,8 @@
    stopTime : Cesium.JulianDate.fromIso8601("2013-12-26"),
    clockRange : Cesium.ClockRange.LOOP_STOP, // loop when we hit the end time
    clockStep : Cesium.ClockStep.SYSTEM_CLOCK_MULTIPLIER,
-   multiplier : 4000 // how much time to advance each tick
+   multiplier : 4000, // how much time to advance each tick
+   shouldAnimate : true // Animation on by default
 });
 
 var viewer = new Cesium.Viewer('cesiumContainer', {

Apps/Sandcastle/gallery/HeadingPitchRoll.html

@@ -67,7 +67,10 @@ <h1>Loading...</h1>
 function startup(Cesium) {
     'use strict';
 //Sandcastle_Begin
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
+
 var canvas = viewer.canvas;
 canvas.setAttribute('tabindex', '0'); // needed to put focus on the canvas
 canvas.addEventListener('click', function() {

Apps/Sandcastle/gallery/Interpolation.html

@@ -32,7 +32,8 @@
 var viewer = new Cesium.Viewer('cesiumContainer', {
     terrainProviderViewModels : [], //Disable terrain changing
     infoBox : false, //Disable InfoBox widget
-    selectionIndicator : false //Disable selection indicator
+    selectionIndicator : false, //Disable selection indicator
+    shouldAnimate : true // Enable animations
 });
 
 //Enable lighting based on sun/moon positions

Apps/Sandcastle/gallery/Particle System Fireworks.html

@@ -28,7 +28,9 @@
 function startup(Cesium) {
     'use strict';
 //Sandcastle_Begin
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
 
 var scene = viewer.scene;
 scene.debugShowFramesPerSecond = true;

Apps/Sandcastle/gallery/Particle System.html

@@ -155,6 +155,7 @@
 viewer.clock.currentTime = start.clone();
 viewer.clock.clockRange = Cesium.ClockRange.LOOP_STOP; //Loop at the end
 viewer.clock.multiplier = 1;
+viewer.clock.shouldAnimate = true;
 
 //Set timeline to simulation bounds
 viewer.timeline.zoomTo(start, stop);
@@ -287,7 +288,7 @@
     lifeTime : 16.0,
 
     emitter : new Cesium.CircleEmitter(2.0),
-    
+
     emitterModelMatrix : computeEmitterModelMatrix(),
 
     forces : [applyGravity]

Apps/Sandcastle/gallery/Physically-Based Materials.html

@@ -33,7 +33,8 @@
     currentTime : Cesium.JulianDate.fromIso8601("2017-07-11T10:00:00Z"),
     clockRange : Cesium.ClockRange.LOOP_STOP,
     clockStep : Cesium.ClockStep.SYSTEM_CLOCK_MULTIPLIER,
-    multiplier : 1000
+    multiplier : 1000,
+    shouldAnimate : true
 });
 
 var viewer = new Cesium.Viewer('cesiumContainer', {

Apps/Sandcastle/gallery/Shadows.html

@@ -33,7 +33,8 @@
     infoBox : false,
     selectionIndicator : false,
     shadows : true,
-    terrainShadows : Cesium.ShadowMode.ENABLED
+    terrainShadows : Cesium.ShadowMode.ENABLED,
+    shouldAnimate : true
 });
 
 viewer.terrainProvider = new Cesium.CesiumTerrainProvider({

Apps/Sandcastle/gallery/Terrain Clipping Planes.html

@@ -43,7 +43,8 @@
 // Clipping planes are not currently supported in Internet Explorer.
 
 var viewer = new Cesium.Viewer('cesiumContainer', {
-    skyAtmosphere: false
+    skyAtmosphere: false,
+    shouldAnimate : true
 });
 
 viewer.terrainProvider = new Cesium.CesiumTerrainProvider({

Apps/Sandcastle/gallery/Video.html

@@ -43,7 +43,10 @@
 function startup(Cesium) {
     'use strict';
 //Sandcastle_Begin
-var viewer = new Cesium.Viewer('cesiumContainer', {showRenderLoopErrors : false});
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    showRenderLoopErrors : false,
+    shouldAnimate : true
+});
 
 var videoElement = document.getElementById('trailer');
 

Apps/Sandcastle/gallery/Web Map Tile Service with Time.html

@@ -27,7 +27,9 @@
 function startup(Cesium) {
     'use strict';
 //Sandcastle_Begin
-var viewer = new Cesium.Viewer('cesiumContainer');
+var viewer = new Cesium.Viewer('cesiumContainer', {
+    shouldAnimate : true
+});
 
 function dataCallback(interval, index) {
     var time;

CHANGES.md

@@ -4,7 +4,7 @@ Change Log
 ### 1.42 - 2018-02-01
 
 * Breaking changes
-  *
+  * The clock does not animate by default. Set the `shouldAnimate` option to `true` when creating the Viewer to enable animation.
 * Deprecated
   * For all classes/functions that can now take a `Resource` instance, all additional parameters that are part of the `Resource` class have been deprecated and will be removed in Cesium 1.44. This generally includes `proxy`, `headers` and `query` parameters.
 * Major refactor of URL handling. All classes that take a url parameter, can now take a Resource or a String. This includes all imagery providers, all terrain providers, `Cesium3DTileset`, `KMLDataSource`, `CZMLDataSource`, `GeoJsonDataSource`, `Model`, `Billboard`, along with all the low level `load*()` functions.
@@ -34,6 +34,7 @@ Change Log
 * 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)
 * Added support for vertex shader uniforms when `tileset.colorBlendMode` is  `MIX` or `REPLACE`. [#5874](https://github.com/AnalyticalGraphicsInc/cesium/pull/5874)
+* Added `shouldAnimate` option to the `Viewer` constructor to indicate if the clock should begin animating immediately.[#6154](https://github.com/AnalyticalGraphicsInc/cesium/pull/6154)
 * Added separate file for the Cesium [Code of Conduct](https://github.com/AnalyticalGraphicsInc/cesium/blob/master/CODE_OF_CONDUCT.md). [#6129](https://github.com/AnalyticalGraphicsInc/cesium/pull/6129)
 * Fixed applying a translucent style to a point cloud tileset. [#6113](https://github.com/AnalyticalGraphicsInc/cesium/pull/6113)
 * Fixed sandcastle Particle System example for better visual [#6132](https://github.com/AnalyticalGraphicsInc/cesium/pull/6132)

Source/Core/Clock.js

@@ -34,7 +34,7 @@ define([
      * @param {ClockStep} [options.clockStep=ClockStep.SYSTEM_CLOCK_MULTIPLIER] Determines if calls to {@link Clock#tick} are frame dependent or system clock dependent.
      * @param {ClockRange} [options.clockRange=ClockRange.UNBOUNDED] Determines how the clock should behave when {@link Clock#startTime} or {@link Clock#stopTime} is reached.
      * @param {Boolean} [options.canAnimate=true] Indicates whether {@link Clock#tick} can advance time.  This could be false if data is being buffered, for example.  The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true.
-     * @param {Boolean} [options.shouldAnimate=true] Indicates whether {@link Clock#tick} should attempt to advance time.  The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true.
+     * @param {Boolean} [options.shouldAnimate=false] Indicates whether {@link Clock#tick} should attempt to advance time.  The clock will only tick when both {@link Clock#canAnimate} and {@link Clock#shouldAnimate} are true.
      *
      * @exception {DeveloperError} startTime must come before stopTime.
      *
@@ -144,8 +144,8 @@ define([
 
         this.currentTime = currentTime;
         this.multiplier = defaultValue(options.multiplier, 1.0);
+        this.shouldAnimate = defaultValue(options.shouldAnimate, false);
         this.clockStep = defaultValue(options.clockStep, ClockStep.SYSTEM_CLOCK_MULTIPLIER);
-        this.shouldAnimate = defaultValue(options.shouldAnimate, true);
     }
 
     defineProperties(Clock.prototype, {

Source/Widgets/Viewer/Viewer.js

@@ -266,6 +266,7 @@ define([
      * @param {Boolean} [options.navigationHelpButton=true] If set to false, the navigation help button will not be created.
      * @param {Boolean} [options.navigationInstructionsInitiallyVisible=true] True if the navigation instructions should initially be visible, or false if the should not be shown until the user explicitly clicks the button.
      * @param {Boolean} [options.scene3DOnly=false] When <code>true</code>, each geometry instance will only be rendered in 3D to save GPU memory.
+     * @param {Boolean} [options.shouldAnimate=false] <code>true</code> if the clock should attempt to advance simulation time by default, <code>false</code> otherwise.  This option takes precedence over setting {@link Viewer#clockViewModel}.
      * @param {ClockViewModel} [options.clockViewModel=new ClockViewModel(options.clock)] The clock view model to use to control current time.
      * @param {ProviderViewModel} [options.selectedImageryProviderViewModel] The view model for the current base imagery layer, if not supplied the first available base layer is used.  This value is only valid if options.baseLayerPicker is set to true.
      * @param {ProviderViewModel[]} [options.imageryProviderViewModels=createDefaultImageryProviderViewModels()] The array of ProviderViewModels to be selectable from the BaseLayerPicker.  This value is only valid if options.baseLayerPicker is set to true.
@@ -421,6 +422,10 @@ Either specify options.terrainProvider instead or set options.baseLayerPicker to
             destroyClockViewModel = true;
         }
 
+        if (defined(options.shouldAnimate)) {
+            clock.shouldAnimate = options.shouldAnimate;
+        }
+
         // Cesium widget
         var cesiumWidget = new CesiumWidget(cesiumWidgetContainer, {
             terrainProvider : options.terrainProvider,