@faicad/faijs 0.18.2 → 0.19.0

package/dist/geometry2d/pen-sketcher.d.ts

@@ -0,0 +1,340 @@
+/**
+ * geometry2d — 2D `BaseSketcher2d` pen (C1), adapted for the pure-object base.
+ *
+ * Ported from brepjs `2d/blueprints/baseSketcher2d.ts` (Apache-2.0).
+ *
+ * The brepjs original accumulates kernel-backed `Curve2D` handles (mutable:
+ * `delete`/`reverse`/`tangentAt`). Here those are replaced by the pure
+ * `Curve2dObj` base of `geometry2d/curve2d` — each pen method emits a plain
+ * object, the pointer advances by plain arithmetic, and end-tangent lookup maps
+ * to `tangentCurve2d`. `curves()`/`close()` return the ordered `Curve2dObj[]`,
+ * which feeds `Blueprint` and the 2D→3D placement pipeline.
+ *
+ * Not-yet-ported (honest `throw`s, per the D-group/port plan):
+ *   · `ellipse*`     — needs the SVG ellipse→arc helper;
+ *   · `smoothSplit*` — needs the spline control helper;
+ *   · `customCorner`/`closeWithMirror` — needs 2D corner/mirror ops (D-group).
+ *
+ * @module
+ */
+import { type Curve2dObj } from './curve2d.js';
+/** A `[x, y]` 2D point (plain tuple). */
+export type Point2 = [number, number];
+/** Options accepted by the spline methods. */
+export type SplineOptions = {
+    /** Explicit start tangent; defaults to `[1,0]` or the previous segment's end tangent. */
+    startTangent?: Point2;
+    /** Explicit end tangent, or the literal `'symmetric'` (mirror of the start tangent). */
+    endTangent?: Point2 | 'symmetric';
+    /** Start control-length factor. */
+    startFactor?: number;
+    /** End control-length factor. */
+    endFactor?: number;
+};
+/** Corner modes accepted by `customCorner` (D-group, not yet ported). */
+export type CornerMode = 'fillet' | 'chamfer' | 'dogbone';
+/**
+ * Base class for 2D flood-pen sketchers that accumulate `Curve2dObj` segments.
+ *
+ * Provides the shared pen-drawing API (lines, arcs, beziers) used by the
+ * drawing DSL. Subclasses implement `close()` to package the accumulated curves
+ * as a `Blueprint` or plain curve list.
+ */
+export declare class BaseSketcher2d {
+    /** Current pen position `[x, y]`. */
+    pointer: Point2;
+    /** The starting point of the pen run. */
+    firstPoint: Point2;
+    /** Accumulated segments, in draw order. */
+    pendingCurves: Curve2dObj[];
+    /** A queued one-shot corner transform (D-group; unused until ported). */
+    _nextCorner: ((a: Curve2dObj, b: Curve2dObj) => Curve2dObj[]) | null;
+    constructor(origin?: Point2);
+    /**
+     * The most recently drawn curve, or `null`.
+     * @returns the last drawn curve, or `null` when nothing has been drawn.
+     */
+    _lastCurve(): Curve2dObj | null;
+    /**
+     * Fetch the last drawn curve, or throw a misuse error.
+     * @param caller - the calling method name (for the error message).
+     * @returns the last curve.
+     */
+    _requireLastCurve(caller: string): Curve2dObj;
+    /**
+     * Add a relative offset to the current pointer.
+     * @param xDist - relative x distance.
+     * @param yDist - relative y distance.
+     * @returns the resulting absolute point.
+     */
+    _resolveRelative(xDist: number, yDist: number): Point2;
+    /**
+     * Save a curve and advance the pen to `end`.
+     * @param curve - the curve to record.
+     * @param end - the new pen position.
+     * @returns this pen, for chaining.
+     */
+    _saveCurveAndAdvance(curve: Curve2dObj, end: Point2): this;
+    /** The current pen position `[x, y]`. */
+    get penPosition(): Point2;
+    /** The current pen angle in degrees (direction of the last segment's end tangent). */
+    get penAngle(): number;
+    /**
+     * Move the pen to an absolute position before any segment is drawn.
+     * @param point - the absolute start position.
+     * @returns this pen, for chaining.
+     */
+    movePointerTo(point: Point2): this;
+    /**
+     * Record a segment, applying a queued corner transform if present.
+     * @param curve - the curve to record.
+     */
+    saveCurve(curve: Curve2dObj): void;
+    /**
+     * Draw a straight line to an absolute point.
+     * @param point - the absolute end point.
+     * @returns this pen, for chaining.
+     */
+    lineTo(point: Point2): this;
+    /**
+     * Draw a straight line by relative horizontal and vertical distances.
+     * @param x - relative x distance.
+     * @param y - relative y distance.
+     * @returns this pen, for chaining.
+     */
+    line(x: number, y: number): this;
+    /**
+     * Draw a vertical line of the given signed distance.
+     * @param distance - signed vertical distance.
+     * @returns this pen, for chaining.
+     */
+    vLine(distance: number): this;
+    /**
+     * Draw a horizontal line of the given signed distance.
+     * @param distance - signed horizontal distance.
+     * @returns this pen, for chaining.
+     */
+    hLine(distance: number): this;
+    /**
+     * Draw a vertical line to an absolute Y coordinate.
+     * @param yPos - the absolute y.
+     * @returns this pen, for chaining.
+     */
+    vLineTo(yPos: number): this;
+    /**
+     * Draw a horizontal line to an absolute X coordinate.
+     * @param xPos - the absolute x.
+     * @returns this pen, for chaining.
+     */
+    hLineTo(xPos: number): this;
+    /**
+     * Draw a line to an absolute point in polar form.
+     * @param polar - `[radius, angleDeg]`.
+     * @returns this pen, for chaining.
+     */
+    polarLineTo(polar: Point2): this;
+    /**
+     * Draw a line in polar relative form.
+     * @param distance - radial distance.
+     * @param angle - angle in degrees.
+     * @returns this pen, for chaining.
+     */
+    polarLine(distance: number, angle: number): this;
+    /**
+     * Draw a line tangent to the previous curve.
+     * @param distance - distance along the tangent.
+     * @returns this pen, for chaining.
+     */
+    tangentLine(distance: number): this;
+    /**
+     * Draw a circular arc through a mid-point to an absolute end point.
+     * @param end - the absolute end point.
+     * @param midPoint - a point on the arc.
+     * @returns this pen, for chaining.
+     */
+    threePointsArcTo(end: Point2, midPoint: Point2): this;
+    /**
+     * Draw a circular arc through a via-point to an end point, both relative.
+     * @param x - relative x end distance.
+     * @param y - relative y end distance.
+     * @param viaX - relative via x distance.
+     * @param viaY - relative via y distance.
+     * @returns this pen, for chaining.
+     */
+    threePointsArc(x: number, y: number, viaX: number, viaY: number): this;
+    /**
+     * Draw a circular arc to an absolute end, bulging `sagitta` off the chord.
+     * @param end - the absolute end point.
+     * @param sagitta - the sagitta (signed bulge off the chord).
+     * @returns this pen, for chaining.
+     */
+    sagittaArcTo(end: Point2, sagitta: number): this;
+    /**
+     * Draw a circular arc to a relative end, bulging `sagitta`.
+     * @param x - relative x end distance.
+     * @param y - relative y end distance.
+     * @param sagitta - the sagitta.
+     * @returns this pen, for chaining.
+     */
+    sagittaArc(x: number, y: number, sagitta: number): this;
+    /**
+     * Draw a vertical sagitta arc of `distance` and `sagitta`.
+     * @param distance - vertical distance.
+     * @param sagitta - the sagitta.
+     * @returns this pen, for chaining.
+     */
+    vSagittaArc(distance: number, sagitta: number): this;
+    /**
+     * Draw a horizontal sagitta arc of `distance` and `sagitta`.
+     * @param distance - horizontal distance.
+     * @param sagitta - the sagitta.
+     * @returns this pen, for chaining.
+     */
+    hSagittaArc(distance: number, sagitta: number): this;
+    /**
+     * Draw a circular arc to an absolute end via a bulge factor.
+     * @param end - the absolute end point.
+     * @param bulge - the bulge factor.
+     * @returns this pen, for chaining.
+     */
+    bulgeArcTo(end: Point2, bulge: number): this;
+    /**
+     * Draw a circular arc to a relative end via a bulge factor.
+     * @param x - horizontal end distance.
+     * @param y - vertical end distance.
+     * @param bulge - the bulge factor.
+     * @returns this pen, for chaining.
+     */
+    bulgeArc(x: number, y: number, bulge: number): this;
+    /**
+     * Draw a vertical bulge arc.
+     * @param distance - vertical distance.
+     * @param bulge - the bulge factor.
+     * @returns this pen, for chaining.
+     */
+    vBulgeArc(distance: number, bulge: number): this;
+    /**
+     * Draw a horizontal bulge arc.
+     * @param distance - horizontal distance.
+     * @param bulge - the bulge factor.
+     * @returns this pen, for chaining.
+     */
+    hBulgeArc(distance: number, bulge: number): this;
+    /**
+     * Draw a circular arc tangent to the previous curve, ending at `end`.
+     * @param end - the absolute end point.
+     * @returns this pen, for chaining.
+     */
+    tangentArcTo(end: Point2): this;
+    /**
+     * Draw a tangent arc to a relative offset.
+     * @param x - horizontal end distance.
+     * @param y - vertical end distance.
+     * @returns this pen, for chaining.
+     */
+    tangentArc(x: number, y: number): this;
+    /**
+     * Draw an elliptical arc (SVG-style endpoint parameters).
+     * @param end - the absolute end point.
+     * @param horizontalRadius - the horizontal radius.
+     * @param verticalRadius - the vertical radius.
+     * @param rotation - rotation in degrees.
+     * @param longAxis - SVG large-arc flag.
+     * @param sweep - SVG sweep flag.
+     * @returns this pen, for chaining.
+     */
+    ellipseTo(end: Point2, horizontalRadius: number, verticalRadius: number, rotation?: number, longAxis?: boolean, sweep?: boolean): this;
+    /**
+     * Draw an elliptical arc to a relative end point.
+     * @param x - relative x end distance.
+     * @param y - relative y end distance.
+     * @param horizontalRadius - the horizontal radius.
+     * @param verticalRadius - the vertical radius.
+     * @param rotation - rotation in degrees.
+     * @param longAxis - SVG large-arc flag.
+     * @param sweep - SVG sweep flag.
+     * @returns this pen, for chaining.
+     */
+    ellipse(x: number, y: number, horizontalRadius: number, verticalRadius: number, rotation?: number, longAxis?: boolean, sweep?: boolean): this;
+    /**
+     * Draw a half-ellipse arc to an absolute end point with a given minor radius.
+     * @param end - the absolute end point.
+     * @param minorRadius - the minor radius.
+     * @param sweep - SVG sweep flag.
+     * @returns this pen, for chaining.
+     */
+    halfEllipseTo(end: Point2, minorRadius: number, sweep?: boolean): this;
+    /**
+     * Draw a half-ellipse arc to a relative end point with a given minor radius.
+     * @param x - relative x end distance.
+     * @param y - relative y end distance.
+     * @param minorRadius - the minor radius.
+     * @param sweep - SVG sweep flag.
+     * @returns this pen, for chaining.
+     */
+    halfEllipse(x: number, y: number, minorRadius: number, sweep?: boolean): this;
+    /**
+     * Draw a Bezier curve to an absolute end through control points.
+     * @param end - the absolute end point.
+     * @param controlPoints - one control point (quadratic) or two (cubic).
+     * @returns this pen, for chaining.
+     */
+    bezierCurveTo(end: Point2, controlPoints: Point2[]): this;
+    /**
+     * Draw a quadratic Bezier to an absolute end point.
+     * @param end - the absolute end point.
+     * @param controlPoint - the single control point.
+     * @returns this pen, for chaining.
+     */
+    quadraticBezierCurveTo(end: Point2, controlPoint: Point2): this;
+    /**
+     * Draw a cubic Bezier to an absolute end point.
+     * @param end - the absolute end point.
+     * @param startControlPoint - the start control point.
+     * @param endControlPoint - the end control point.
+     * @returns this pen, for chaining.
+     */
+    cubicBezierCurveTo(end: Point2, startControlPoint: Point2, endControlPoint: Point2): this;
+    /**
+     * Draw a smooth cubic spline to an absolute end point.
+     * @param _end - the absolute end point.
+     * @param _config - spline smoothing options.
+     * @returns this pen, for chaining.
+     * @throws not yet ported (needs the spline control helper).
+     */
+    smoothSplineTo(_end: Point2, _config?: SplineOptions): this;
+    /**
+     * Draw a smooth cubic spline to a relative end point.
+     * @param _x - relative x end distance.
+     * @param _y - relative y end distance.
+     * @param _config - spline smoothing options.
+     * @returns this pen, for chaining.
+     * @throws not yet ported (needs the spline control helper).
+     */
+    smoothSpline(_x: number, _y: number, _config?: SplineOptions): this;
+    /**
+     * Change the corner between the previous and next segment.
+     * @param _radius - the corner radius.
+     * @param _mode - the corner kind.
+     * @returns this pen, for chaining.
+     * @throws D-group corner ops (fillet/chamfer/dogbone) are not yet ported.
+     */
+    customCorner(_radius: number, _mode?: CornerMode): this;
+    /**
+     * Close the sketch by drawing a final segment back to the start.
+     * @returns the closed, ordered curve list.
+     */
+    close(): Curve2dObj[];
+    /**
+     * Close by mirroring the drawn segments across the start→current chord.
+     * @returns the closed, mirror-augmented curve list.
+     * @throws not yet ported (needs the curve-mirror transform).
+     */
+    closeWithMirror(): Curve2dObj[];
+    /**
+     * The ordered drawn curve list (no implicit close).
+     * @returns the drawn segments in draw order.
+     */
+    curves(): Curve2dObj[];
+}
+//# sourceMappingURL=pen-sketcher.d.ts.map

package/dist/geometry2d/pen-sketcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pen-sketcher.d.ts","sourceRoot":"","sources":["../../src/geometry2d/pen-sketcher.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAML,KAAK,UAAU,EAChB,MAAM,WAAW,CAAA;AAOlB,yCAAyC;AACzC,MAAM,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAErC,8CAA8C;AAC9C,MAAM,MAAM,aAAa,GAAG;IAC1B,yFAAyF;IACzF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;IACjC,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,yEAAyE;AACzE,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAA;AAYzD;;;;;;GAMG;AACH,qBAAa,cAAc;IACzB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAA;IACf,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAA;IAClB,2CAA2C;IAC3C,aAAa,EAAE,UAAU,EAAE,CAAA;IAC3B,yEAAyE;IACzE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,KAAK,UAAU,EAAE,CAAC,GAAG,IAAI,CAAA;gBAExD,MAAM,GAAE,MAAe;IAOnC;;;OAGG;IACH,UAAU,IAAI,UAAU,GAAG,IAAI;IAI/B;;;;OAIG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU;IAM7C;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IAItD;;;;;OAKG;IACH,oBAAoB,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAM1D,yCAAyC;IACzC,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,sFAAsF;IACtF,IAAI,QAAQ,IAAI,MAAM,CAKrB;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAOlC;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI;IAYlC;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI3B;;;;;OAKG;IACH,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAIhC;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI7B;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI7B;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI3B;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI3B;;;;OAIG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKhC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAKhD;;;;OAIG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMnC;;;;;OAKG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKrD;;;;;;;OAOG;IACH,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAKtE;;;;;OAKG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAahD;;;;;;OAMG;IACH,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAIvD;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAIpD;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAIpD;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAM5C;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAInD;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIhD;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIhD;;;;OAIG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAM/B;;;;;OAKG;IACH,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAItC;;;;;;;;;OASG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,SAAI,EAAE,QAAQ,UAAQ,EAAE,KAAK,UAAQ,GAAG,IAAI;IAM7H;;;;;;;;;;OAUG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,QAAQ,SAAI,EAAE,QAAQ,UAAQ,EAAE,KAAK,UAAQ,GAAG,IAAI;IAIpI;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI;IAMpE;;;;;;;OAOG;IACH,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,IAAI;IAI3E;;;;;OAKG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI;IAKzD;;;;;OAKG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAI/D;;;;;;OAMG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI;IAIzF;;;;;;OAMG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI;IAI3D;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI;IAInE;;;;;;OAMG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,UAAqB,GAAG,IAAI;IAIjE;;;OAGG;IACH,KAAK,IAAI,UAAU,EAAE;IAOrB;;;;OAIG;IACH,eAAe,IAAI,UAAU,EAAE;IAI/B;;;OAGG;IACH,MAAM,IAAI,UAAU,EAAE;CAGvB"}