@thi.ng/geom/resample.d.ts

Functional, polymorphic API for 2D geometry types & SVG generation

import type { MultiFn2 } from "@thi.ng/defmulti";
import type { IShape, IShape2, IShape3, SamplingOpts } from "./api.js";
import type { ComplexPolygon } from "./api/complex-polygon.js";
import type { Cubic } from "./api/cubic.js";
import type { Cubic3 } from "./api/cubic3.js";
import type { Group } from "./api/group.js";
import type { Line } from "./api/line.js";
import type { Line3 } from "./api/line3.js";
import type { Polygon } from "./api/polygon.js";
import type { Polygon3 } from "./api/polygon3.js";
import type { Polyline } from "./api/polyline.js";
import type { Polyline3 } from "./api/polyline3.js";
import type { Quad3 } from "./api/quad3.js";
import type { Quadratic } from "./api/quadratic.js";
import type { Quadratic3 } from "./api/quadratic3.js";
/**
 * Function overrides for {@link resample}.
 */
export type ResampleFn = {
    (shape: ComplexPolygon, opts: number | Partial<SamplingOpts>): ComplexPolygon;
    (shape: Cubic, opts: number | Partial<SamplingOpts>): Polyline;
    (shape: Cubic3, opts: number | Partial<SamplingOpts>): Polyline3;
    (shape: Group, opts: number | Partial<SamplingOpts>): Group;
    (shape: Line, opts: number | Partial<SamplingOpts>): Polyline;
    (shape: Line3, opts: number | Partial<SamplingOpts>): Polyline3;
    (shape: Polyline, opts: number | Partial<SamplingOpts>): Polyline;
    (shape: Polyline3, opts: number | Partial<SamplingOpts>): Polyline3;
    (shape: Quadratic, opts: number | Partial<SamplingOpts>): Polyline;
    (shape: Quadratic3, opts: number | Partial<SamplingOpts>): Polyline3;
    (shape: Quad3, opts: number | Partial<SamplingOpts>): Polygon3;
    (shape: IShape2, opts: number | Partial<SamplingOpts>): Polygon;
    (shape: IShape3, opts: number | Partial<SamplingOpts>): IShape3;
} & MultiFn2<IShape, number | Partial<SamplingOpts>, IShape>;
/**
 * Resamples given shape with given options and returns result as polygon (if
 * closed) or polyline (if open).
 *
 * @remarks
 * If the shape has a `__samples` attribute, it will be removed in the result to
 * ensure idempotent behavior.
 *
 * Currently implemented for:
 *
 * - {@link Arc}
 * - {@link Circle}
 * - {@link ComplexPolygon}
 * - {@link Cubic}
 * - {@link Cubic3}
 * - {@link Ellipse}
 * - {@link Line}
 * - {@link Line3}
 * - {@link Polygon}
 * - {@link Polygon3}
 * - {@link Polyline}
 * - {@link Polyline3}
 * - {@link Quad}
 * - {@link Quad3}
 * - {@link Quadratic}
 * - {@link Quadratic3}
 * - {@link Rect}
 * - {@link Triangle}
 * - {@link Triangle3}
 *
 * @param shape
 * @param opts
 */
export declare const resample: ResampleFn;
//# sourceMappingURL=resample.d.ts.map