Added feature to modify scene pick search size

CONTRIBUTORS.md

@@ -2,6 +2,9 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Cesiu
 
 ## [Corporate CLA](Documentation/Contributors/CLAs/corporate-cla-agi-v1.0.txt)
 
+* [Bentley Systems ](https://www.bentley.com/)
+    * [Jason Crow](https://github.com/jason-crow)
+
 * [Analytical Graphics, Inc.](http://www.agi.com/)
    * [Patrick Cozzi](https://github.com/pjcozzi)
    * [Kristian Calhoun](https://github.com/kristiancalhoun)

Source/Scene/Scene.js

@@ -2769,9 +2769,6 @@ define([
     }
 
     // pick rectangle width and height, assumed odd
-    var rectangleWidth = 3.0;
-    var rectangleHeight = 3.0;
-    var scratchRectangle = new BoundingRectangle(0.0, 0.0, rectangleWidth, rectangleHeight);
     var scratchColorZero = new Color(0.0, 0.0, 0.0, 0.0);
     var scratchPosition = new Cartesian2();
 
@@ -2793,16 +2790,22 @@ define([
      * }, Cesium.ScreenSpaceEventType.MOUSE_MOVE);
      *
      * @param {Cartesian2} windowPosition Window coordinates to perform picking on.
+     * @param {Number} [optional] width of the pick rectangle
+     * @param {Number} [optional] height of the pick rectangle
      * @returns {Object} Object containing the picked primitive.
      *
      * @exception {DeveloperError} windowPosition is undefined.
      */
-    Scene.prototype.pick = function(windowPosition) {
+    Scene.prototype.pick = function(windowPosition, width, height) {
         //>>includeStart('debug', pragmas.debug);
         if(!defined(windowPosition)) {
             throw new DeveloperError('windowPosition is undefined.');
         }
         //>>includeEnd('debug');
+        // override the rectangle dimensions if defined
+        var rectangleWidth = width || 3.0;
+        var rectangleHeight = height || width || 3.0;
+        var scratchRectangle = new BoundingRectangle(0.0, 0.0, rectangleWidth, rectangleHeight);
 
         var context = this._context;
         var us = context.uniformState;
@@ -2825,7 +2828,6 @@ define([
 
         scratchRectangle.x = drawingBufferPosition.x - ((rectangleWidth - 1.0) * 0.5);
         scratchRectangle.y = (this.drawingBufferHeight - drawingBufferPosition.y) - ((rectangleHeight - 1.0) * 0.5);
-
         var passState = this._pickFramebuffer.begin(scratchRectangle);
 
         updateEnvironment(this, passState);

Specs/Scene/PickSpec.js

@@ -10,7 +10,8 @@ defineSuite([
         'Scene/PerspectiveFrustum',
         'Scene/Primitive',
         'Scene/SceneMode',
-        'Specs/createScene'
+        'Specs/createCanvas',
+        'Specs/createScene',
     ], 'Scene/Pick', function(
         FeatureDetection,
         GeometryInstance,
@@ -23,6 +24,7 @@ defineSuite([
         PerspectiveFrustum,
         Primitive,
         SceneMode,
+        createCanvas,
         createScene) {
     'use strict';
 
@@ -58,6 +60,20 @@ defineSuite([
         primitives.removeAll();
     });
 
+     // reset the scene such that the canvas is 10 pixels and the camera is set
+    //  such that the primitive only takes up a small area at the canvas center
+    function setupPickSizeTestScene()  {
+        scene = createScene({canvas: createCanvas(10,10) });
+        primitives = scene.primitives;
+        camera = scene.camera;
+        scene.mode = SceneMode.SCENE3D;
+        scene.morphTime = SceneMode.getMorphTime(scene.mode);
+
+        camera.setView({
+            destination : Rectangle.fromDegrees(-10.0, -10.0, 10.0, 10.0)
+        });
+    }
+
     function createRectangle() {
         var e = new Primitive({
             geometryInstances: new GeometryInstance({
@@ -94,6 +110,35 @@ defineSuite([
         expect(scene).toPickPrimitive(rectangle);
     });
 
+    it('picks a primitive at pickSize extent', function() {
+        if (FeatureDetection.isInternetExplorer()) {
+            // Workaround IE 11.0.9.  This test fails when all tests are ran without a breakpoint here.
+            return;
+        }
+
+        setupPickSizeTestScene();
+        var rectangle = createRectangle();
+        // scene is 10px, primitive is at center, pick size convers 5px pixel from corner
+        var config = { x: 0, y: 0, size: 5 };
+
+        expect(scene).toPickNearbyPrimitive(rectangle, config);
+    });
+
+    it('does not pick a primitive at pickSize extent', function() {
+       if (FeatureDetection.isInternetExplorer()) {
+            // Workaround IE 11.0.9.  This test fails when all tests are ran without a breakpoint here.
+            return;
+        }
+
+        setupPickSizeTestScene();
+        createRectangle();
+        // scene is 10px, primitive is at center, pick size only convers 3px from corner
+        var config = { x: 0, y: 0, size: 3 };
+
+        expect(scene).notToPickNearbyPrimitive(config);
+    });
+
+
     it('does not pick primitives when show is false', function() {
         var rectangle = createRectangle();
         rectangle.show = false;

Specs/addDefaultMatchers.js

@@ -269,6 +269,22 @@ define([
                 };
             },
 
+            toPickNearbyPrimitive : function(util, customEqualityTesters) {
+                return {
+                    compare : function(actual, expected, config) {
+                        return pickPrimitiveEqualsWrapper(actual, expected, config.x, config.y, config.size);
+                    }
+                };
+            },
+
+            notToPickNearbyPrimitive : function(util, customEqualityTesters) {
+                return {
+                    compare : function(actual, config) {
+                        return pickPrimitiveEqualsWrapper(actual, undefined, config.x, config.y, config.size);
+                    }
+                };
+            },
+
             notToPick : function(util, customEqualityTesters) {
                 return {
                     compare : function(actual, expected) {
@@ -416,6 +432,17 @@ define([
         };
     }
 
+    // converts x and y coordinates such that after updating for drawing buffer position, the correct coordinates will be used
+    function pickPrimitiveEqualsWrapper(actual, expected, x, y, width, height) {
+        width = width || 3;
+        height = height || width || 3;
+        x = x || 0;
+        y = y || 0;
+        var adjustedX = x + ((width - 1) * 0.5);
+        var adjustedY = -1 * (y + ((height - 1) * 0.5) - actual._context.drawingBufferHeight);
+        return pickPrimitiveEquals(actual, expected, adjustedX, adjustedY, width, height);
+    }
+
     function renderAndReadPixels(options) {
         var scene;
 
@@ -465,9 +492,9 @@ define([
         };
     }
 
-    function pickPrimitiveEquals(actual, expected) {
+    function pickPrimitiveEquals(actual, expected, x, y, pickWidth, pickHeight) {
         var scene = actual;
-        var result = scene.pick(new Cartesian2(0, 0));
+        var result = scene.pick(new Cartesian2(x || 0, y || 0), pickWidth, pickHeight);
 
         if (!!window.webglStub) {
             return {