thi-ng/umbrella

View on GitHub
packages/geom-sdf/src/as-sdf.ts

Summary

Maintainability
A
35 mins
Test Coverage
import type { Fn, Fn2 } from "@thi.ng/api";
import type { MultiFn1 } from "@thi.ng/defmulti";
import { DEFAULT, defmulti } from "@thi.ng/defmulti/defmulti";
import { assert } from "@thi.ng/errors/assert";
import { unsupported } from "@thi.ng/errors/unsupported";
import type {
    Circle,
    ComplexPolygon,
    Ellipse,
    Group,
    Line,
    Points,
    Polyline,
    Quadratic,
    Rect,
} from "@thi.ng/geom";
import type { Attribs, IShape } from "@thi.ng/geom-api";
import { Path } from "@thi.ng/geom/api/path";
import { Polygon } from "@thi.ng/geom/api/polygon";
import { asPolygon } from "@thi.ng/geom/as-polygon";
import { asPolyline } from "@thi.ng/geom/as-polyline";
import { __dispatch } from "@thi.ng/geom/internal/dispatch";
import { simplify } from "@thi.ng/geom/simplify";
import { withAttribs } from "@thi.ng/geom/with-attribs";
import { add2 } from "@thi.ng/vectors/add";
import { mulN2 } from "@thi.ng/vectors/muln";
import type { FieldCoeff, SDFAttribs, SDFn } from "./api.js";
import {
    chamferDiff,
    chamferIsec,
    chamferUnion,
    diff,
    isec,
    roundDiff,
    roundIsec,
    roundUnion,
    smoothDiff,
    smoothIsec,
    smoothUnion,
    stepDiff,
    stepIsec,
    stepUnion,
    union,
} from "./ops.js";
import {
    DEFAULT_ATTRIBS,
    box2,
    circle2,
    ellipse2,
    line2,
    points2,
    polygon2,
    polyline2,
    quadratic2,
    withSDFAttribs,
} from "./shapes.js";

/** @internal */
interface ParametricOps {
    chamfer: Fn2<number | FieldCoeff, SDFn[], SDFn>;
    round: Fn2<number | FieldCoeff, SDFn[], SDFn>;
    smooth: Fn2<number | FieldCoeff, SDFn[], SDFn>;
    steps: Fn2<[number, number] | FieldCoeff<[number, number]>, SDFn[], SDFn>;
}

/**
 * Takes an
 * [`IShape`](https://docs.thi.ng/umbrella/geom-api/interfaces/IShape.html)
 * instance (possibly a tree, e.g. via
 * [`group()`](https://docs.thi.ng/umbrella/geom/functions/group.html)) and
 * converts it into a {@link SDFn}.
 *
 * @remarks
 * Currently supported shape types:
 *
 * - circle
 * - cubic (auto-converted to polyline)
 * - complexpoly (boundary only, holes ignored)
 * - ellipse
 * - group
 * - line
 * - path (auto-converted to polyline or complex polygon)
 * - points
 * - polygon
 * - polyline
 * - quadratic bezier
 * - rect
 *
 * For shapes which need to be converted to polygons/polylines, the
 * {@link SDFAttribs.samples} attribute can be used to control the resulting
 * number of vertices. If not specified
 * [`DEFAULT_SAMPLES`](https://docs.thi.ng/umbrella/geom-api/variables/DEFAULT_SAMPLES.html)
 * will be used (which can be globally set via
 * [`setDefaultSamples()`](https://docs.thi.ng/umbrella/geom-api/functions/setDefaultSamples.html)).
 */
export const asSDF: MultiFn1<IShape, SDFn> = defmulti<any, SDFn>(
    __dispatch,
    {
        quad: "poly",
        tri: "poly",
    },
    {
        [DEFAULT]: ($: IShape) => unsupported(`shape type: ${$.type}`),

        circle: ($: Circle) => circle2($.pos, $.r, __sdfAttribs($.attribs)),

        complexpoly: ($: ComplexPolygon) =>
            diff(
                [$.boundary, ...$.children].map((poly) =>
                    asSDF(withAttribs(poly, $.attribs))
                )
            ),

        cubic: ($: IShape) =>
            asSDF(
                simplify(
                    asPolyline($, (__sdfAttribs($.attribs) || {}).samples)[0],
                    0
                )
            ),

        ellipse: ($: Ellipse) => ellipse2($.pos, $.r, __sdfAttribs($.attribs)),

        group: ($: Group) => {
            const { attribs, children } = $;
            const attr = { ...DEFAULT_ATTRIBS, ...__sdfAttribs(attribs) };
            __validateAttribs(attr);
            const $children = children.map(asSDF);
            let res: SDFn;
            if ($children.length > 1) {
                switch (attr.combine) {
                    case "diff":
                        res = __selectCombineOp(attr, $children, diff, {
                            chamfer: chamferDiff,
                            round: roundDiff,
                            smooth: smoothDiff,
                            steps: stepDiff,
                        });
                        break;
                    case "isec":
                        res = __selectCombineOp(attr, $children, isec, {
                            chamfer: chamferIsec,
                            round: roundIsec,
                            smooth: smoothIsec,
                            steps: stepIsec,
                        });
                        break;
                    case "union":
                    default: {
                        res = __selectCombineOp(attr, $children, union, {
                            chamfer: chamferUnion,
                            round: roundUnion,
                            smooth: smoothUnion,
                            steps: stepUnion,
                        });
                    }
                }
            } else if ($children.length) {
                res = $children[0];
            } else {
                return attr.flip ? () => -Infinity : () => Infinity;
            }
            return withSDFAttribs(res, attr);
        },

        line: ({ points: [a, b], attribs }: Line) =>
            line2(a, b, __sdfAttribs(attribs)),

        path: ($: Path) => {
            const n = (__sdfAttribs($.attribs) || {}).samples;
            const path = new Path($.segments, [], $.attribs);
            const boundary = asSDF(
                simplify(
                    $.closed ? asPolygon(path, n)[0] : asPolyline(path, n)[0],
                    0
                )
            );
            if (!$.subPaths.length) return boundary;
            const fields = [
                boundary,
                ...$.subPaths.map((segments) =>
                    asSDF(new Path(segments, [], $.attribs))
                ),
            ];
            return $.closed ? diff(fields) : union(fields);
        },

        points: ($: Points) => points2($.points, __sdfAttribs($.attribs)),

        poly: ($: Polygon) => polygon2($.points, __sdfAttribs($.attribs)),

        polyline: ($: Polyline) => polyline2($.points, __sdfAttribs($.attribs)),

        quadratic: ({ points: [a, b, c], attribs }: Quadratic) =>
            quadratic2(a, b, c, __sdfAttribs(attribs)),

        rect: ({ pos, size, attribs }: Rect) => {
            const s = mulN2([], size, 0.5);
            return box2(add2([], s, pos), s, __sdfAttribs(attribs));
        },
    }
);

/** @internal */
const __sdfAttribs = (attribs?: Attribs): Partial<SDFAttribs> =>
    attribs ? attribs.__sdf : undefined;

const OPS = <const>["chamfer", "round", "smooth", "steps"];

const __validateAttribs = (attribs: SDFAttribs) =>
    assert(
        OPS.filter((x) => attribs[x]).length < 2,
        "only 1 of these options can be used at once: chamfer, round, smooth"
    );

const __selectCombineOp = (
    attribs: SDFAttribs,
    children: SDFn[],
    op: Fn<SDFn[], SDFn>,
    paramOps: ParametricOps
) => {
    for (let k of OPS) {
        if (attribs[k]) {
            return paramOps[k](<any>attribs[k], children);
        }
    }
    return op(children);
};