CesiumWidget and Viewer requestRender specs

Author: ggetz

Source/Scene/PerformanceDisplay.js

@@ -89,7 +89,7 @@ define([
      * Update the display.  This function should only be called once per frame, because
      * each call records a frame in the internal buffer and redraws the display.
      *
-     * @param {Boolean} [renderedThisFrame] If provided, the FPS count will only update and display if true.
+     * @param {Boolean} [renderedThisFrame=true] If provided, the FPS count will only update and display if true.
      */
     PerformanceDisplay.prototype.update = function(renderedThisFrame) {
         var time = getTimestamp();

Source/Scene/Scene.js

@@ -218,10 +218,7 @@ define([
      * @param {Number} [options.terrainExaggeration=1.0] A scalar used to exaggerate the terrain. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid.
      * @param {Boolean} [options.shadows=false] Determines if shadows are cast by the sun.
      * @param {MapMode2D} [options.mapMode2D=MapMode2D.INFINITE_SCROLL] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
-     * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as
-     *  determined by changes within the scene. Enabling improves performance of the application, but requires using
-     *  {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases
-     *  after making changes to the scene in other parts of the API.
+     * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API.
      * @param {Number} [options.maximumRenderTimeChange=0.5] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested.
      *
      * @see CesiumWidget
@@ -2925,8 +2922,6 @@ define([
         context.endFrame();
     }
 
-    var scratchTime = new JulianDate();
-
     /**
      * @private
      */
@@ -2949,7 +2944,7 @@ define([
 
         try {
             if (shouldRender) {
-                this._lastRenderTime = JulianDate.clone(time, scratchTime);
+                this._lastRenderTime = JulianDate.clone(time, this._lastRenderTime);
                 this._renderRequested = false;
 
                 render(this, time);

Source/Widgets/CesiumWidget/CesiumWidget.js

@@ -164,7 +164,7 @@ define([
      * @param {Boolean} [options.shadows=false] Determines if shadows are cast by the sun.
      * @param {ShadowMode} [options.terrainShadows=ShadowMode.RECEIVE_ONLY] Determines if the terrain casts or receives shadows from the sun.
      * @param {MapMode2D} [options.mapMode2D=MapMode2D.INFINITE_SCROLL] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
-     * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application.
+     * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API.
      * @param {Number} [options.maximumRenderTimeChange=0.5] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested.
      *
      * @exception {DeveloperError} Element with id "container" does not exist in the document.

Source/Widgets/Viewer/Viewer.js

@@ -288,7 +288,7 @@ define([
      * @param {ShadowMode} [options.terrainShadows=ShadowMode.RECEIVE_ONLY] Determines if the terrain casts or receives shadows from the sun.
      * @param {MapMode2D} [options.mapMode2D=MapMode2D.INFINITE_SCROLL] Determines if the 2D map is rotatable or can be scrolled infinitely in the horizontal direction.
      * @param {Boolean} [options.projectionPicker=false] If set to true, the ProjectionPicker widget will be created.
-     * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application.
+     * @param {Boolean} [options.requestRenderMode=false] If true, rendering a frame will only occur when needed as determined by changes within the scene. Enabling improves performance of the application, but requires using {@link Scene#requestRender} to render a new frame explicitly in this mode. This will be necessary in many cases after making changes to the scene in other parts of the API.
      * @param {Number} [options.maximumRenderTimeChange=0.5] If requestRenderMode is true, this value defines the maximum change in simulation time allowed before a render is requested.
      *
      * @exception {DeveloperError} Element with id "container" does not exist in the document.

Specs/Widgets/CesiumWidget/CesiumWidgetSpec.js

@@ -236,6 +236,22 @@ defineSuite([
         expect(widget.scene.orderIndependentTranslucency).toBe(false);
     });
 
+    it('can enable requestRenderMode', function() {
+        widget = createCesiumWidget(container, {
+            requestRenderMode : true
+        });
+
+        expect(widget.scene.requestRenderMode).toBe(true);
+    });
+
+    it('can set maximumRenderTimeChange', function() {
+        widget = createCesiumWidget(container, {
+            maximumRenderTimeChange : Number.POSITIVE_INFINITY
+        });
+
+        expect(widget.scene.maximumRenderTimeChange).toBe(Number.POSITIVE_INFINITY);
+    });
+
     it('throws if no container provided', function() {
         expect(function() {
             return createCesiumWidget(undefined);
@@ -262,6 +278,25 @@ defineSuite([
         }).toThrowDeveloperError();
     });
 
+    it('resizing triggers a render in requestRender mode', function() {
+        widget = createCesiumWidget(container, {
+            requestRenderMode : true,
+            maximumRenderTimeChange : Number.POSITIVE_INFINITY
+        });
+
+        var scene = widget._scene;
+        spyOn(scene, 'requestRender');
+
+        widget.resize();
+
+        expect(scene.requestRender).not.toHaveBeenCalled();
+
+        widget._forceResize = true;
+        widget.resize();
+
+        expect(scene.requestRender).toHaveBeenCalled();
+    });
+
     it('throws if no container id does not exist', function() {
         expect(function() {
             return createCesiumWidget('doesnotexist');

Specs/Widgets/Viewer/ViewerSpec.js

@@ -806,6 +806,22 @@ defineSuite([
         });
     });
 
+    it('can enable requestRender mode', function() {
+        viewer = createViewer(container, {
+            requestRenderMode : true
+        });
+
+        expect(viewer.scene.requestRenderMode).toBe(true);
+    });
+
+    it('can set maximumRenderTimeChange', function() {
+        viewer = createViewer(container, {
+            maximumRenderTimeChange : Number.POSITIVE_INFINITY
+        });
+
+        expect(viewer.scene.maximumRenderTimeChange).toBe(Number.POSITIVE_INFINITY);
+    });
+
     it('can get and set trackedEntity', function() {
         viewer = createViewer(container);