@thi.ng/geom 7.0.0 → 7.0.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-05-08T18:24:31Z
+- **Last updated**: 2024-05-09T14:25:15Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [7.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@7.0.1) (2024-05-09)
+
+#### 🩹 Bug fixes
+
+- update arc() arg defaults, add docs ([cc57a57](https://github.com/thi-ng/umbrella/commit/cc57a57))
+
 # [7.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/geom@7.0.0) (2024-05-08)
 
 #### 🛑 Breaking changes

package/README.md

@@ -213,7 +213,7 @@ For Node.js REPL:
 const geom = await import("@thi.ng/geom");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 14.59 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 14.61 KB
 
 ## Dependencies
 
@@ -266,7 +266,7 @@ directory are using this package:
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/geom-voronoi-mst.jpg" width="240"/>      | Poisson-disk shape-aware sampling, Voronoi & Minimum Spanning Tree visualization | [Demo](https://demo.thi.ng/umbrella/geom-voronoi-mst/)      | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/geom-voronoi-mst)      |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/gesture-analysis.png" width="240"/>      | Mouse gesture / stroke analysis, simplification, corner detection                | [Demo](https://demo.thi.ng/umbrella/gesture-analysis/)      | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/gesture-analysis)      |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hdom-canvas-particles.jpg" width="240"/> | 2D Bezier curve-guided particle system                                           | [Demo](https://demo.thi.ng/umbrella/hdom-canvas-particles/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/hdom-canvas-particles) |
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hiccup-canvas-arcs.png" width="240"/>    | Animated arcs & drawing using hiccup-canvas                                      | [Demo](https://demo.thi.ng/umbrella/hiccup-canvas-arcs/)    | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/hiccup-canvas-arcs)    |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/hiccup-canvas-arcs.jpg" width="240"/>    | Animated arcs & drawing using hiccup-canvas                                      | [Demo](https://demo.thi.ng/umbrella/hiccup-canvas-arcs/)    | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/hiccup-canvas-arcs)    |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/imgui/imgui-all.png" width="240"/>                | Canvas based Immediate Mode GUI components                                       | [Demo](https://demo.thi.ng/umbrella/imgui/)                 | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/imgui)                 |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/geom/geom-isoline.png" width="240"/>              | Animated sine plasma effect visualized using contour lines                       | [Demo](https://demo.thi.ng/umbrella/iso-plasma/)            | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/iso-plasma)            |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/kmeans-viz.jpg" width="240"/>            | k-means clustering visualization                                                 | [Demo](https://demo.thi.ng/umbrella/kmeans-viz/)            | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/kmeans-viz)            |

package/arc.d.ts

@@ -1,6 +1,56 @@
 import type { Attribs } from "@thi.ng/geom-api";
 import type { ReadonlyVec, Vec } from "@thi.ng/vectors";
 import { Arc } from "./api/arc.js";
-export declare const arc: (pos: Vec, r: number | Vec, axis: number, start: number, end: number, xl?: boolean, clockwise?: boolean) => Arc;
+/**
+ * Creates a new elliptic {@link Arc} from given `center`, `radii`, `axis`
+ * rotation, `start` and `end` angles (in radians).
+ *
+ * @remarks
+ * The `xl` (large arc) and `clockwise` params are defaulting to:
+ *
+ * - xl = true if |start-end| > PI
+ * - clockwise = true if end > start
+ *
+ * Reference:
+ * - https://svgwg.org/svg2-draft/paths.html#PathDataEllipticalArcCommands
+ * - https://svgwg.org/svg2-draft/images/paths/arcs02.svg
+ *
+ * Also see {@link arcFrom2Points}, {@link pathFromSvg} for an alternative construction.
+ *
+ * @param center
+ * @param radii
+ * @param axis
+ * @param start
+ * @param end
+ * @param xl
+ * @param clockwise
+ * @param attribs
+ */
+export declare const arc: (center: Vec, radii: number | Vec, axis: number, start: number, end: number, xl?: boolean, clockwise?: boolean, attribs?: Attribs) => Arc;
+/**
+ * Constructs a new {@link Arc} between the two given points `a` and `b` using
+ * `radii`, `axis` rotation (in radians) and `xl`, `clockwise` params to
+ * configure which of 4 possible arcs will be chosen.
+ *
+ * @remarks
+ * This function returns `undefined` if it's mathematically impossible to create
+ * an arc with the given parameters.
+ *
+ * Reference:
+ * - https://svgwg.org/svg2-draft/paths.html#PathDataEllipticalArcCommands
+ * - https://svgwg.org/svg2-draft/images/paths/arcs02.svg
+ * - https://svgwg.org/svg2-draft/implnote.html#ArcConversionEndpointToCenter
+ * - https://www.w3.org/TR/SVG11/implnote.html#ArcImplementationNotes
+ *
+ * Also see {@link arc}, {@link pathFromSvg} for an alternative construction.
+ *
+ * @param a
+ * @param b
+ * @param radii
+ * @param axis
+ * @param xl
+ * @param cw
+ * @param attribs
+ */
 export declare const arcFrom2Points: (a: ReadonlyVec, b: ReadonlyVec, radii: ReadonlyVec, axis?: number, xl?: boolean, cw?: boolean, attribs?: Attribs) => Arc | undefined;
 //# sourceMappingURL=arc.d.ts.map

package/arc.js

@@ -1,7 +1,18 @@
 import { isNumber } from "@thi.ng/checks/is-number";
 import { fromEndPoints } from "@thi.ng/geom-arc/from-endpoints";
 import { Arc } from "./api/arc.js";
-const arc = (pos, r, axis, start, end, xl = false, clockwise = false) => new Arc(pos, isNumber(r) ? [r, r] : r, axis, start, end, xl, clockwise);
+import { absDiff } from "@thi.ng/math/abs";
+import { PI } from "@thi.ng/math/api";
+const arc = (center, radii, axis, start, end, xl = absDiff(start, end) > PI, clockwise = end > start, attribs) => new Arc(
+  center,
+  isNumber(radii) ? [radii, radii] : radii,
+  axis,
+  start,
+  end,
+  xl,
+  clockwise,
+  attribs
+);
 const arcFrom2Points = (a, b, radii, axis = 0, xl = false, cw = false, attribs) => {
   const res = fromEndPoints(a, b, radii, axis, xl, cw);
   return res ? new Arc(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/geom",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "Functional, polymorphic API for 2D geometry types & SVG generation",
   "type": "module",
   "module": "./index.js",
@@ -413,5 +413,5 @@
     ],
     "year": 2013
   },
-  "gitHead": "df34b4a9e650cc7323575356de207d78933bdcf3\n"
+  "gitHead": "41bd769068da804eeace622ec7db50e4d48f1dc9\n"
 }