(#500) Implement color finder interface + tests

Author: s1hofmann

e2e/assets/dot.png

@@ -0,0 +1,68 @@
+import ColorFinder from "./color-finder.class";
+import { join } from "path";
+import {
+  ColorQuery,
+  loadImage,
+  MatchRequest,
+  MatchResult,
+  Point,
+  RGBA,
+} from "../../../index";
+
+describe("color finder", () => {
+  describe("find", () => {
+    it("should resolve", async () => {
+      // GIVEN
+      const screenImage = await loadImage(
+        join(__dirname, `../../../e2e/assets/dot.png`)
+      );
+      const SUT = new ColorFinder();
+      const colorQuery: ColorQuery = {
+        id: "colorFinderTest",
+        type: "color",
+        by: {
+          color: new RGBA(255, 0, 0, 255),
+        },
+      };
+      const matchRequest = new MatchRequest(screenImage, colorQuery, 0.9);
+
+      const expectedResult = new MatchResult(1, new Point(60, 60));
+
+      // WHEN
+      const result = await SUT.findMatch(matchRequest);
+
+      // THEN
+      expect(result).toEqual(expectedResult);
+    });
+  });
+
+  describe("findAll", () => {
+    it("should resolve", async () => {
+      // GIVEN
+      const screenImage = await loadImage(
+        join(__dirname, `../../../e2e/assets/dots.png`)
+      );
+      const SUT = new ColorFinder();
+      const colorQuery: ColorQuery = {
+        id: "colorFinderTest",
+        type: "color",
+        by: {
+          color: new RGBA(255, 0, 0, 255),
+        },
+      };
+      const matchRequest = new MatchRequest(screenImage, colorQuery, 0.9);
+
+      const expectedResult = [
+        new MatchResult(1, new Point(60, 60)),
+        new MatchResult(1, new Point(60, 80)),
+        new MatchResult(1, new Point(60, 100)),
+      ];
+
+      // WHEN
+      const result = await SUT.findMatches(matchRequest);
+
+      // THEN
+      expect(result).toEqual(expectedResult);
+    });
+  });
+});

e2e/assets/dots.png

@@ -0,0 +1,73 @@
+import { ColorFinderInterface } from "../color-finder.interface";
+import { MatchRequest } from "../../match-request.class";
+import { ColorQuery } from "../../query.class";
+import { MatchResult } from "../../match-result.class";
+import { imageToJimp } from "../io/imageToJimp.function";
+import { Point } from "../../point.class";
+
+export default class implements ColorFinderInterface {
+  async findMatch<PROVIDER_DATA_TYPE>(
+    query: MatchRequest<ColorQuery, PROVIDER_DATA_TYPE>
+  ): Promise<MatchResult<Point>> {
+    const jimp = imageToJimp(query.haystack);
+    let result: MatchResult<Point> | null = null;
+    const color = query.needle.by.color;
+    for (const { x, y, idx } of jimp.scanIterator(
+      0,
+      0,
+      jimp.bitmap.width,
+      jimp.bitmap.height
+    )) {
+      if (
+        jimp.bitmap.data[idx] === color.R &&
+        jimp.bitmap.data[idx + 1] === color.G &&
+        jimp.bitmap.data[idx + 2] === color.B &&
+        jimp.bitmap.data[idx + 3] === color.A
+      ) {
+        result = new MatchResult(
+          1,
+          new Point(
+            x / query.haystack.pixelDensity.scaleX,
+            y / query.haystack.pixelDensity.scaleY
+          )
+        );
+        break;
+      }
+    }
+
+    if (result) {
+      return result;
+    } else {
+      throw new Error(
+        `No match for color RGBA(${color.R},${color.G},${color.B},${color.A}) found`
+      );
+    }
+  }
+
+  async findMatches<PROVIDER_DATA_TYPE>(
+    query: MatchRequest<ColorQuery, PROVIDER_DATA_TYPE>
+  ): Promise<MatchResult<Point>[]> {
+    const jimp = imageToJimp(query.haystack);
+    const results: MatchResult<Point>[] = [];
+    const color = query.needle.by.color;
+    jimp.scan(0, 0, jimp.bitmap.width, jimp.bitmap.height, (x, y, idx) => {
+      if (
+        jimp.bitmap.data[idx] === color.R &&
+        jimp.bitmap.data[idx + 1] === color.G &&
+        jimp.bitmap.data[idx + 2] === color.B &&
+        jimp.bitmap.data[idx + 3] === color.A
+      ) {
+        results.push(
+          new MatchResult(
+            1,
+            new Point(
+              x / query.haystack.pixelDensity.scaleX,
+              y / query.haystack.pixelDensity.scaleY
+            )
+          )
+        );
+      }
+    });
+    return results;
+  }
+}