Merge pull request #176 from zephraph/scales-configurable

Allows searching for multiple scales to be configurable

Author: s1hofmann

lib/optionalsearchparameters.class.ts

@@ -8,6 +8,7 @@ export class OptionalSearchParameters {
    * {@link OptionalSearchParameters} class constructor
    * @param searchRegion Optional {@link Region} to limit the search space to
    * @param confidence Optional confidence value to configure image match confidence
+   * @param searchMultipleScales Optional flag to indicate if the search should be conducted at different scales
    */
-  constructor(public searchRegion?: Region, public confidence?: number) {}
+  constructor(public searchRegion?: Region, public confidence?: number, public searchMultipleScales?: boolean) {}
 }

lib/screen.class.spec.ts

@@ -161,6 +161,30 @@ describe("Screen.", () => {
         expect(visionAdapterMock.findOnScreenRegion).toHaveBeenCalledWith(expectedMatchRequest);
     });
 
+    it("should override searchMultipleScales with parameter.", async () => {
+        // GIVEN
+        const matchResult = new MatchResult(0.99, searchRegion);
+        VisionAdapter.prototype.findOnScreenRegion = jest.fn(() => {
+            return Promise.resolve(matchResult);
+        });
+        const visionAdapterMock = new VisionAdapter();
+        const SUT = new Screen(visionAdapterMock);
+        const imagePath = "test/path/to/image.png";
+        const parameters = new LocationParameters(searchRegion, undefined, false);
+        const expectedMatchRequest = new MatchRequest(
+          expect.any(Image),
+          join(cwd(), imagePath),
+          searchRegion,
+          SUT.config.confidence,
+          false);
+
+        // WHEN
+        await SUT.find(imagePath, parameters);
+
+        // THEN
+        expect(visionAdapterMock.findOnScreenRegion).toHaveBeenCalledWith(expectedMatchRequest);
+    });
+
     it("should override both confidence and search region with parameter.", async () => {
         // GIVEN
         const minMatch = 0.8;

lib/screen.class.ts

@@ -85,6 +85,7 @@ export class Screen {
         const minMatch = (params && params.confidence) || this.config.confidence;
         const searchRegion =
             (params && params.searchRegion) || await this.vision.screenSize();
+        const searchMultipleScales = (params && params.searchMultipleScales)
 
         const fullPathToNeedle = normalize(join(this.config.resourceDirectory, templateImageFilename));
 
@@ -95,6 +96,7 @@ export class Screen {
             fullPathToNeedle,
             searchRegion,
             minMatch,
+            searchMultipleScales
         );
 
         return new Promise<Region>(async (resolve, reject) => {