@thi.ng/geom-sdf 0.1.1 → 0.2.0

package/shapes.d.ts

@@ -2,8 +2,18 @@ import { ReadonlyVec } from "@thi.ng/vectors";
 import type { SDFAttribs, SDFn } from "./api.js";
 /** @internal */
 export declare const DEFAULT_ATTRIBS: SDFAttribs;
+/**
+ * Applies any SDF modifiers specified via {@link SDFAttribs} to the given
+ * distance function. Returns a possibly updated distance function.
+ *
+ * @remarks
+ * Order of application is: abs, offset, flip
+ *
+ * @param fn
+ * @param attribs
+ */
 export declare const withSDFAttribs: (fn: SDFn, attribs?: Partial<SDFAttribs>) => SDFn;
-export declare const arc2: (apert: ReadonlyVec, ra: number, rb: number, attribs?: Partial<SDFAttribs>) => SDFn;
+export declare const arc2: (center: ReadonlyVec, apert: ReadonlyVec, ra: number, rb: number, attribs?: Partial<SDFAttribs>) => SDFn;
 export declare const box2: (center: ReadonlyVec, size: ReadonlyVec, attribs?: Partial<SDFAttribs>) => SDFn;
 export declare const circle2: (center: ReadonlyVec, radius: number, attribs?: Partial<SDFAttribs>) => SDFn;
 export declare const ellipse2: (center: ReadonlyVec, radii: ReadonlyVec, attribs?: Partial<SDFAttribs>) => SDFn;
@@ -11,5 +21,19 @@ export declare const line2: (a: ReadonlyVec, b: ReadonlyVec, attribs?: Partial<S
 export declare const points2: (pts: ReadonlyVec[], attribs?: Partial<SDFAttribs>) => SDFn;
 export declare const polygon2: (pts: ReadonlyVec[], attribs?: Partial<SDFAttribs>) => SDFn;
 export declare const polyline2: (pts: ReadonlyVec[], attribs?: Partial<SDFAttribs>) => SDFn;
+/**
+ * SDF for a single quadratic bezier segment. Similar to {@link line2}, by
+ * default only computes the _unsigned_ distance to the segment. To obtain the
+ * signed distance (for the "interior" region, if any), set the `abs` attribute
+ * explicitly to `false`.
+ *
+ * @remarks
+ * See {@link SDFAttribs.abs} for details.
+ *
+ * @param a
+ * @param b
+ * @param c
+ * @param attribs
+ */
 export declare const quadratic2: (a: ReadonlyVec, b: ReadonlyVec, c: ReadonlyVec, attribs?: Partial<SDFAttribs>) => SDFn;
 //# sourceMappingURL=shapes.d.ts.map

package/shapes.js

@@ -1,33 +1,81 @@
+import { isFunction } from "@thi.ng/checks/is-function";
 import { distSq2 } from "@thi.ng/vectors";
 import { sub2 } from "@thi.ng/vectors/sub";
+import { withBoundingCircle } from "./bounds.js";
 import { distArc2, distBox2, distCircle2, distEllipse2, distPolygon2, distPolyline2, distQuadratic2, distSegment2, } from "./dist.js";
-import { abs as $abs, flip as $flip, round as $round } from "./ops.js";
+import { abs as $abs, flip as $flip, offset as $offset } from "./ops.js";
 /** @internal */
 export const DEFAULT_ATTRIBS = {
     abs: false,
+    bounds: false,
+    chamfer: 0,
     combine: "union",
     flip: false,
+    offset: 0,
     round: 0,
     smooth: 0,
 };
+/**
+ * Applies any SDF modifiers specified via {@link SDFAttribs} to the given
+ * distance function. Returns a possibly updated distance function.
+ *
+ * @remarks
+ * Order of application is: abs, offset, flip
+ *
+ * @param fn
+ * @param attribs
+ */
 export const withSDFAttribs = (fn, attribs) => {
     if (attribs) {
-        const { abs, flip, round } = { ...DEFAULT_ATTRIBS, ...attribs };
+        const { abs, flip, offset } = { ...DEFAULT_ATTRIBS, ...attribs };
         if (abs)
             fn = $abs(fn);
-        if (round > 0)
-            fn = $round(fn, round);
+        if (isFunction(offset) || offset > 0)
+            fn = $offset(fn, offset);
         if (flip)
             fn = $flip(fn);
     }
     return fn;
 };
-export const arc2 = (apert, ra, rb, attribs) => withSDFAttribs((p) => distArc2(p, apert, ra, rb), attribs);
+export const arc2 = (center, apert, ra, rb, attribs = {}) => {
+    const sdf = withSDFAttribs((p) => distArc2(sub2([], p, center), apert, ra, rb), attribs);
+    return attribs.bounds ? withBoundingCircle(sdf, center, ra + rb) : sdf;
+};
 export const box2 = (center, size, attribs) => withSDFAttribs((p) => distBox2(sub2([], p, center), size), attribs);
 export const circle2 = (center, radius, attribs) => withSDFAttribs((p) => distCircle2(sub2([], p, center), radius), attribs);
-export const ellipse2 = (center, radii, attribs) => withSDFAttribs((p) => distEllipse2(sub2([], p, center), radii), attribs);
-export const line2 = (a, b, attribs) => withSDFAttribs((p) => distSegment2(a, b, p), attribs);
-export const points2 = (pts, attribs) => withSDFAttribs((p) => pts.reduce((acc, q) => Math.min(acc, distSq2(p, q)), Infinity), attribs);
-export const polygon2 = (pts, attribs) => withSDFAttribs((p) => distPolygon2(pts, p), attribs);
-export const polyline2 = (pts, attribs) => withSDFAttribs((p) => distPolyline2(pts, p), attribs);
-export const quadratic2 = (a, b, c, attribs) => withSDFAttribs((p) => distQuadratic2(p, a, b, c), attribs);
+export const ellipse2 = (center, radii, attribs = {}) => {
+    const sdf = withSDFAttribs((p) => distEllipse2(sub2([], p, center), radii), attribs);
+    return attribs.bounds
+        ? withBoundingCircle(sdf, center, Math.max(...radii))
+        : sdf;
+};
+export const line2 = (a, b, attribs) => withSDFAttribs((p) => distSegment2(p, a, b), attribs);
+export const points2 = (pts, attribs = {}) => {
+    const sdf = withSDFAttribs((p) => pts.reduce((acc, q) => Math.min(acc, distSq2(p, q)), Infinity), attribs);
+    return attribs.bounds ? withBoundingCircle(sdf, pts) : sdf;
+};
+export const polygon2 = (pts, attribs = {}) => {
+    const sdf = withSDFAttribs((p) => distPolygon2(p, pts), attribs);
+    return attribs.bounds ? withBoundingCircle(sdf, pts) : sdf;
+};
+export const polyline2 = (pts, attribs = {}) => {
+    const sdf = withSDFAttribs((p) => distPolyline2(p, pts), attribs);
+    return attribs.bounds ? withBoundingCircle(sdf, pts) : sdf;
+};
+/**
+ * SDF for a single quadratic bezier segment. Similar to {@link line2}, by
+ * default only computes the _unsigned_ distance to the segment. To obtain the
+ * signed distance (for the "interior" region, if any), set the `abs` attribute
+ * explicitly to `false`.
+ *
+ * @remarks
+ * See {@link SDFAttribs.abs} for details.
+ *
+ * @param a
+ * @param b
+ * @param c
+ * @param attribs
+ */
+export const quadratic2 = (a, b, c, attribs) => withSDFAttribs(!attribs || attribs.abs !== false
+    ? (p) => distQuadratic2(p, a, b, c)
+    : (p) => distQuadratic2(p, a, b, c, true), { ...attribs, abs: false });