Fix boxPoints type definition to match runtime behavior (#97)

* Initial plan

* Fix boxPoints type definition to match runtime behavior

Co-authored-by: ttt43ttt <132509+ttt43ttt@users.noreply.github.com>

* Improve boxPoints test to check actual coordinate values

Co-authored-by: ttt43ttt <132509+ttt43ttt@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ttt43ttt <132509+ttt43ttt@users.noreply.github.com>

Author: Copilot

src/types/opencv/QRCodeDetector.ts

@@ -9,10 +9,10 @@ import type {
 
 /**
  * QR Code detection and decoding class.
- * 
+ *
  * This class implements QR code detection and decoding functionality.
  * It can detect QR codes in an image and decode their content.
- * 
+ *
  * Source:
  * [opencv2/objdetect.hpp](https://github.com/opencv/opencv/tree/master/modules/objdetect/include/opencv2/objdetect.hpp).
  */
@@ -24,49 +24,49 @@ export declare class QRCodeDetector {
 
   /**
    * Detects QR code in image and returns the quadrangle containing the code.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing (or not) QR code.
    * @param points Output vector of vertices of the minimum-area quadrangle containing the code.
    */
   public detect(img: InputArray, points: OutputArray): bool;
 
   /**
    * Decodes QR code in image once it's found by the detect() method.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR code.
    * @param points Quadrangle vertices found by detect() method (or some other algorithm).
    * @param straight_qrcode The optional output image containing rectified and binarized QR code
    */
   public decode(
     img: InputArray,
     points: InputArray,
-    straight_qrcode?: OutputArray
+    straight_qrcode?: OutputArray,
   ): String;
 
   /**
    * Both detects and decodes QR code
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR code.
    * @param points optional output array of vertices of the found QR code quadrangle. Will be empty if not found.
    * @param straight_qrcode The optional output image containing rectified and binarized QR code
    */
   public detectAndDecode(
     img: InputArray,
     points?: OutputArray,
-    straight_qrcode?: OutputArray
+    straight_qrcode?: OutputArray,
   ): String;
 
   /**
    * Detects QR codes in image and returns the vector of the quadrangles containing the codes.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing (or not) QR codes.
    * @param points Output vector of vector of vertices of the minimum-area quadrangle containing the codes.
    */
   public detectMulti(img: InputArray, points: OutputArrayOfArrays): bool;
 
   /**
    * Decodes QR codes in image once it's found by the detectMulti() method.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR codes.
    * @param points vector of Quadrangle vertices found by detectMulti() method (or some other algorithm).
    * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
@@ -76,12 +76,12 @@ export declare class QRCodeDetector {
     img: InputArray,
     points: InputArray,
     decoded_info: any,
-    straight_qrcode?: OutputArrayOfArrays
+    straight_qrcode?: OutputArrayOfArrays,
   ): bool;
 
   /**
    * Both detects and decodes QR codes
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR codes.
    * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
    * @param points optional output vector of vertices of the found QR code quadrangles. Will be empty if not found.
@@ -91,7 +91,7 @@ export declare class QRCodeDetector {
     img: InputArray,
     decoded_info: any,
     points?: OutputArrayOfArrays,
-    straight_qrcode?: OutputArrayOfArrays
+    straight_qrcode?: OutputArrayOfArrays,
   ): bool;
 
   /**
@@ -108,4 +108,4 @@ export declare class QRCodeDetector {
    * Releases the object
    */
   public delete(): void;
-}
+}

src/types/opencv/QRCodeDetectorAruco.ts

@@ -28,10 +28,10 @@ export declare class QRCodeDetectorAruco_Params {
 
 /**
  * QR Code detection and decoding class using Aruco-based detection.
- * 
+ *
  * This class implements QR code detection and decoding functionality using
  * Aruco marker detection techniques for improved robustness.
- * 
+ *
  * Source:
  * [opencv2/objdetect.hpp](https://github.com/opencv/opencv/tree/master/modules/objdetect/include/opencv2/objdetect.hpp).
  */
@@ -43,56 +43,56 @@ export declare class QRCodeDetectorAruco {
 
   /**
    * QRCodeDetectorAruco constructor with parameters
-   * 
+   *
    * @param params QRCodeDetectorAruco parameters
    */
   public constructor(params: QRCodeDetectorAruco_Params);
 
   /**
    * Detects QR code in image and returns the quadrangle containing the code.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing (or not) QR code.
    * @param points Output vector of vertices of the minimum-area quadrangle containing the code.
    */
   public detect(img: InputArray, points: OutputArray): bool;
 
   /**
    * Decodes QR code in image once it's found by the detect() method.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR code.
    * @param points Quadrangle vertices found by detect() method (or some other algorithm).
    * @param straight_qrcode The optional output image containing rectified and binarized QR code
    */
   public decode(
     img: InputArray,
     points: InputArray,
-    straight_qrcode?: OutputArray
+    straight_qrcode?: OutputArray,
   ): String;
 
   /**
    * Both detects and decodes QR code
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR code.
    * @param points optional output array of vertices of the found QR code quadrangle. Will be empty if not found.
    * @param straight_qrcode The optional output image containing rectified and binarized QR code
    */
   public detectAndDecode(
     img: InputArray,
     points?: OutputArray,
-    straight_qrcode?: OutputArray
+    straight_qrcode?: OutputArray,
   ): String;
 
   /**
    * Detects QR codes in image and returns the vector of the quadrangles containing the codes.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing (or not) QR codes.
    * @param points Output vector of vector of vertices of the minimum-area quadrangle containing the codes.
    */
   public detectMulti(img: InputArray, points: OutputArrayOfArrays): bool;
 
   /**
    * Decodes QR codes in image once it's found by the detectMulti() method.
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR codes.
    * @param points vector of Quadrangle vertices found by detectMulti() method (or some other algorithm).
    * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
@@ -102,12 +102,12 @@ export declare class QRCodeDetectorAruco {
     img: InputArray,
     points: InputArray,
     decoded_info: any,
-    straight_qrcode?: OutputArrayOfArrays
+    straight_qrcode?: OutputArrayOfArrays,
   ): bool;
 
   /**
    * Both detects and decodes QR codes
-   * 
+   *
    * @param img grayscale or color (BGR) image containing QR codes.
    * @param decoded_info UTF8-encoded output vector of String or empty vector of String if the codes cannot be decoded.
    * @param points optional output vector of vertices of the found QR code quadrangles. Will be empty if not found.
@@ -117,7 +117,7 @@ export declare class QRCodeDetectorAruco {
     img: InputArray,
     decoded_info: any,
     points?: OutputArrayOfArrays,
-    straight_qrcode?: OutputArrayOfArrays
+    straight_qrcode?: OutputArrayOfArrays,
   ): bool;
 
   /**
@@ -127,7 +127,7 @@ export declare class QRCodeDetectorAruco {
 
   /**
    * Set detector parameters
-   * 
+   *
    * @param params QRCodeDetectorAruco parameters
    */
   public setDetectorParameters(params: QRCodeDetectorAruco_Params): void;
@@ -136,4 +136,4 @@ export declare class QRCodeDetectorAruco {
    * Releases the object
    */
   public delete(): void;
-}
+}

src/types/opencv/imgproc_shape.ts

@@ -65,9 +65,9 @@ export declare function boundingRect(array: InputArray): Rect;
  *
  * @param box The input rotated rectangle. It may be the output of
  *
- * @param points The output array of four vertices of rectangles.
+ * @returns An array of four vertices of the rectangle (Point2f[])
  */
-export declare function boxPoints(box: RotatedRect, points: OutputArray): void;
+export declare function boxPoints(box: RotatedRect): Point2f[];
 
 /**
  * image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0

src/types/opencv/objdetect.ts

@@ -103,4 +103,7 @@ export declare const CASCADE_FIND_BIGGEST_OBJECT: any; // initializer: = 4
 export declare const CASCADE_DO_ROUGH_SEARCH: any; // initializer: = 8
 
 export { QRCodeDetector } from "./QRCodeDetector";
-export { QRCodeDetectorAruco, QRCodeDetectorAruco_Params } from "./QRCodeDetectorAruco";
+export {
+  QRCodeDetectorAruco,
+  QRCodeDetectorAruco_Params,
+} from "./QRCodeDetectorAruco";

test/rect.test.ts

@@ -16,4 +16,28 @@ describe("rect", () => {
     expect(Math.round(points[0].x)).toBe(cv.RotatedRect.boundingRect(rect).x);
     expect(Math.round(points[1].y)).toBe(cv.RotatedRect.boundingRect(rect).y);
   });
+
+  it("test boxPoints function", async () => {
+    const center = new cv.Point(50, 40);
+    const size = new cv.Size(80, 30);
+    const angle = 25;
+    const rotatedRect = new cv.RotatedRect(center, size, angle);
+
+    // Test that boxPoints accepts one argument and returns Point2f[]
+    const points = cv.boxPoints(rotatedRect);
+
+    // Verify it returns 4 points
+    expect(points.length).toBe(4);
+
+    // Check the actual values - boxPoints should return the same result as RotatedRect.points
+    const expectedPoints = cv.RotatedRect.points(rotatedRect);
+    expect(points[0].x).toBeCloseTo(expectedPoints[0].x, 5);
+    expect(points[0].y).toBeCloseTo(expectedPoints[0].y, 5);
+    expect(points[1].x).toBeCloseTo(expectedPoints[1].x, 5);
+    expect(points[1].y).toBeCloseTo(expectedPoints[1].y, 5);
+    expect(points[2].x).toBeCloseTo(expectedPoints[2].x, 5);
+    expect(points[2].y).toBeCloseTo(expectedPoints[2].y, 5);
+    expect(points[3].x).toBeCloseTo(expectedPoints[3].x, 5);
+    expect(points[3].y).toBeCloseTo(expectedPoints[3].y, 5);
+  });
 });