Merge pull request #162 from nut-tree/fix/160/fix-find-offset

Fix/160/fix find offset

Author: s1hofmann

lib/screen.class.spec.ts

@@ -137,52 +137,54 @@ describe("Screen.", () => {
     });
 
     it("should override default search region with parameter.", async () => {
+        // GIVEN
         const customSearchRegion = new Region(10, 10, 90, 90);
         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(customSearchRegion);
-        await expect(SUT.find(imagePath, parameters)).resolves.toEqual(matchResult.location);
-        const matchRequest = new MatchRequest(
-            expect.any(Image),
-            join(cwd(), imagePath),
-            customSearchRegion,
-            SUT.config.confidence,
-            true);
-        expect(visionAdapterMock.findOnScreenRegion).toHaveBeenCalledWith(matchRequest);
+        const expectedMatchRequest = new MatchRequest(
+          expect.any(Image),
+          join(cwd(), imagePath),
+          customSearchRegion,
+          SUT.config.confidence,
+          true);
+
+        // 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;
         const customSearchRegion = new Region(10, 10, 90, 90);
         const matchResult = new MatchResult(minMatch, 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(customSearchRegion, minMatch);
-        await expect(SUT.find(imagePath, parameters)).resolves.toEqual(matchResult.location);
-        const matchRequest = new MatchRequest(
-            expect.any(Image),
-            join(cwd(), imagePath),
-            customSearchRegion,
-            minMatch,
-            true);
-        expect(visionAdapterMock.findOnScreenRegion).toHaveBeenCalledWith(matchRequest);
+        const expectedMatchRequest = new MatchRequest(
+          expect.any(Image),
+          join(cwd(), imagePath),
+          customSearchRegion,
+          minMatch,
+          true);
+
+        // WHEN
+        await SUT.find(imagePath, parameters);
+
+        // THEN
+        expect(visionAdapterMock.findOnScreenRegion).toHaveBeenCalledWith(expectedMatchRequest);
     });
 
     it("should return region to highlight for chaining", async () => {
@@ -214,4 +216,33 @@ describe("Screen.", () => {
         expect(result).toEqual(highlightRegion);
     });
 
+    it("should add search region offset to result image location", async () => {
+
+        // GIVEN
+        const limitedSearchRegion = new Region(100, 200, 300, 400);
+        const resultRegion = new Region(50, 100, 150, 200);
+        const matchResult = new MatchResult(0.99, resultRegion);
+
+        const expectedMatchRegion = new Region(
+            limitedSearchRegion.left + resultRegion.left,
+            limitedSearchRegion.top + resultRegion.top,
+            resultRegion.width,
+            resultRegion.height);
+
+        VisionAdapter.prototype.findOnScreenRegion = jest.fn(() => {
+            return Promise.resolve(matchResult);
+        });
+        const SUT = new Screen(new VisionAdapter());
+
+        // WHEN
+        const matchRegion = await SUT.find(
+            "test/path/to/image.png",
+            {
+                searchRegion: limitedSearchRegion
+            });
+
+        // THEN
+        expect(matchRegion).toEqual(expectedMatchRegion);
+    })
+
 });

lib/screen.class.ts

@@ -105,10 +105,16 @@ export class Screen {
                     for (const hook of possibleHooks) {
                         await hook(matchResult);
                     }
+                    const resultRegion = new Region(
+                        searchRegion.left + matchResult.location.left,
+                        searchRegion.top + matchResult.location.top,
+                        matchResult.location.width,
+                        matchResult.location.height
+                    )
                     if (this.config.autoHighlight) {
-                        resolve(this.highlight(matchResult.location));
+                        resolve(this.highlight(resultRegion));
                     } else {
-                        resolve(matchResult.location);
+                        resolve(resultRegion);
                     }
                 } else {
                     reject(