@pluot/react 0.1.16 → 0.1.17

package/dist-tsc/types.d.ts

@@ -0,0 +1,255 @@
+import type { ReactElement } from "react";
+import type { AspectRatioMode, AspectRatioAlignmentMode, CameraMatrix, StoreInput, StoresInput, StoresOutput } from "@pluot/core";
+/** Mirrors the Rust `ViewMode` enum (serde-renamed to lowercase). */
+export type ViewMode = "2d" | "3d";
+/** Mirrors the Rust `GraphicsFormat` enum. */
+export type GraphicsFormat = "Raster" | "Vector";
+/** Mirrors the adjacently-tagged Rust `PlotParams` enum discriminant. */
+export type PlotType = "LayeredPlot";
+/**
+ * One entry of `PlotParams.layers`, mirroring the adjacently-tagged Rust
+ * `LayerParams` enum: `{ "layer_type": "PointLayer", "layer_params": { ... } }`.
+ *
+ * `layer_type` must name a registered layer (see the `LayerParams` enum in
+ * `crates/pluot/src/render_params.rs`), and the shape of `layer_params`
+ * depends on which layer was named.
+ */
+export type LayerParams = {
+    layer_type: string;
+    layer_params: Record<string, unknown>;
+};
+/** Mirrors the Rust `LayeredPlotRenderParams` struct. */
+export type PlotParams = {
+    layers: LayerParams[];
+};
+/**
+ * The object handed to the wasm `render_wasm` / `pick_wasm` functions.
+ * Mirrors the Rust `RenderParams` struct (snake_case, unlike the props of
+ * the {@link PluotProps} React API).
+ */
+export type RenderParams = {
+    schema_version: string | null;
+    width: number;
+    height: number;
+    format: GraphicsFormat;
+    margin_top: number;
+    margin_right: number;
+    margin_bottom: number;
+    margin_left: number;
+    device_pixel_ratio: number;
+    aspect_ratio_mode: AspectRatioMode;
+    aspect_ratio_alignment_mode: AspectRatioAlignmentMode;
+    view_mode: ViewMode;
+    pickable: boolean;
+    camera_view: CameraMatrix | null;
+    plot_id: string;
+    plot_type: PlotType;
+    stores: StoresOutput | undefined;
+    plot_params: PlotParams;
+    /** In milliseconds. Has no effect when `wait_for_store_gets` is false. */
+    timeout: number | null;
+    wait_for_store_gets: boolean;
+    cache_enabled: boolean;
+    svg_compression_enabled: boolean;
+    svg_include_document: boolean;
+};
+/** Mirrors the Rust `ScreenCoord` struct. Y increases upwards. */
+export type ScreenCoord = {
+    x: number;
+    y: number;
+};
+/** Mirrors the externally-tagged Rust `DataCoord` enum. */
+export type DataCoord = {
+    TwoD: {
+        x: number;
+        y: number;
+    };
+} | {
+    ThreeD: {
+        x: number;
+        y: number;
+        z: number;
+    };
+};
+/** Mirrors the Rust `LayerPickingResult` struct. */
+export type LayerPickingResult = {
+    layer_id: string;
+    info: Record<string, string>;
+};
+/**
+ * Mirrors the Rust `PickingResult` struct, after normalization
+ * of the `info` Maps (produced by serde-wasm-bindgen) to plain objects.
+ *
+ * Note: `serde_wasm_bindgen` serializes a Rust `None` as `undefined`
+ * (not `null`), so `data_coord` is absent rather than null when picking
+ * did not resolve to a data coordinate.
+ */
+export type PickingResult = {
+    data_coord: DataCoord | undefined;
+    screen_coord: ScreenCoord;
+    layer_results: LayerPickingResult[];
+};
+/**
+ * The un-normalized shape that `pick_wasm` actually resolves to. It is typed
+ * `any` on the wasm-bindgen side, so this type is what documents the wire
+ * format: `serde_wasm_bindgen` converts the Rust `HashMap` behind `info` into
+ * a JS `Map`, which {@link PickingResult} flattens to a plain object.
+ */
+export type RawLayerPickingResult = Omit<LayerPickingResult, "info"> & {
+    info: Map<string, string>;
+};
+export type RawPickingResult = Omit<PickingResult, "layer_results"> & {
+    layer_results: RawLayerPickingResult[];
+};
+/**
+ * What a {@link PluotProps.onHover} callback may return for the tooltip to
+ * render. A plain object is rendered as a key/value table when `asTable`
+ * is set, and as pretty-printed JSON otherwise.
+ */
+export type TooltipContent = string | number | ReactElement | Record<string, unknown> | null | undefined;
+export type TooltipProps = {
+    content: TooltipContent;
+    /** Render a plain-object `content` as a two-column key/value table. */
+    asTable?: boolean;
+};
+/** The hovered point plus the tooltip content to show for it. */
+export type HoverInfo = {
+    content: TooltipContent;
+    /** Mouse position in the coordinate space of the outer (width x height) container. */
+    mouseX: number;
+    mouseY: number;
+};
+/**
+ * Which representation of a {@link BrushVertex} is authoritative for an axis.
+ *
+ * - `Pixels`: relative to the top-left of the outer (width x height) container,
+ *   with Y increasing downwards (the DOM/SVG convention). Unaffected by the camera.
+ * - `Data`: the data coordinate under the current camera, as reported by
+ *   `getBounds`, with Y increasing upwards. A brush in this mode is pinned to the
+ *   data, so it moves on screen as the user zooms/pans.
+ * - `Normalized`: a 0-to-1 fraction of the brushable region, with Y increasing
+ *   upwards (0 at the bottom edge, 1 at the top edge). Unaffected by the camera.
+ */
+export type BrushUnitsMode = "Pixels" | "Data" | "Normalized";
+export type BrushVertex = {
+    x_data: number;
+    y_data: number;
+    x_pixels: number;
+    y_pixels: number;
+    x_normalized: number;
+    y_normalized: number;
+};
+/**
+ * The shape the user draws, and which the resulting {@link BrushState} holds.
+ *
+ * - `Rect`: click and drag to draw a rectangle.
+ * - `Polygon`: click and drag to draw a lasso, defining vertices as the user
+ *   drags. The number of vertices is limited by using lodash-es throttle.
+ * - `RangeX`: select a horizontal range. The overlay renders as a rectangle
+ *   which takes up the full brush height, according to the brush margins.
+ * - `RangeY`: select a vertical range. The overlay renders as a rectangle
+ *   which takes up the full brush width, according to the brush margins.
+ */
+export type BrushMode = 'Rect' | 'Polygon' | 'RangeX' | 'RangeY';
+/** The axis-aligned modes, all of which are stored as four rectangle corners. */
+export type RectLikeBrushMode = Exclude<BrushMode, 'Polygon'>;
+export type BrushState = {
+    status: 'Drawing' | 'Complete';
+    shape: BrushMode;
+    vertices: BrushVertex[];
+};
+/**
+ * The value of {@link PluotProps.brush} meaning "controlled, but nothing is
+ * brushed right now".
+ *
+ * `undefined` cannot play this role: a prop that was never passed is
+ * indistinguishable from one explicitly set to `undefined`, and an absent
+ * `brush` has to mean uncontrolled. A parent that controls the brush therefore
+ * passes `NO_BRUSH` rather than `undefined` to show no brush, which keeps it
+ * controlled across the empty state instead of silently handing control back.
+ */
+export declare const NO_BRUSH = "NoBrush";
+export type NoBrush = typeof NO_BRUSH;
+export type BrushResult = {};
+export type PluotProps = {
+    /**
+     * The schema version used to generate the plot, for forward compatibility.
+     * A mismatch with the Rust crate version logs a warning.
+     */
+    schemaVersion?: string | null;
+    /** Width of the plot, in pixels. */
+    width: number;
+    /** Height of the plot, in pixels. */
+    height: number;
+    /**
+     * Unique-per-page plot ID, used to key caches of intermediate values.
+     * Also the default store name when `store` is used without `storeName`.
+     */
+    plotId: string;
+    plotType: PlotType;
+    plotParams: PlotParams;
+    /**
+     * A single Zarr store: a URL string, a zarrita store instance,
+     * or already-derived `ZarrStoreInfo` metadata.
+     * Mutually exclusive with `stores`.
+     */
+    store?: StoreInput;
+    /** The name to register `store` under. Defaults to `plotId`. */
+    storeName?: string;
+    /** Multiple Zarr stores, keyed by store name. Mutually exclusive with `store`. */
+    stores?: StoresInput;
+    /**
+     * Whether to register the store(s) with the wasm module.
+     * Set to false when they have already been registered elsewhere.
+     */
+    registerStores?: boolean;
+    viewMode?: ViewMode;
+    format?: GraphicsFormat;
+    marginTop?: number;
+    marginRight?: number;
+    marginBottom?: number;
+    marginLeft?: number;
+    aspectRatioMode?: AspectRatioMode;
+    aspectRatioAlignmentMode?: AspectRatioAlignmentMode;
+    /** Outline the margin box and the plot area, to help debug layout. */
+    debugMargins?: boolean;
+    backgroundColor?: string;
+    /** Lower bound (in ms) of the exponential backoff between bailed-early renders. */
+    minTimeout?: number;
+    /** Upper bound (in ms) of the exponential backoff between bailed-early renders. */
+    maxTimeout?: number;
+    /** Whether a new render may start while a previous one is still in flight. */
+    allowSimultaneousRenders?: boolean;
+    /**
+     * The 4x4 camera matrix. Without `setCameraMatrix`, this is treated as the
+     * initial value only, and the camera is managed internally.
+     */
+    cameraMatrix?: CameraMatrix | null;
+    /** Provide to take control of the camera matrix. */
+    setCameraMatrix?: ((cameraMatrix: CameraMatrix) => void) | null;
+    /** Whether clicking should run a picking query and call `onClick`. */
+    enableClick?: boolean;
+    /** Whether hovering should run a picking query and show a tooltip via `onHover`. */
+    enableTooltip?: boolean;
+    onClick?: ((result: PickingResult) => void) | null;
+    onHover?: ((result: PickingResult) => TooltipContent) | null;
+    brushUnitsModeX?: BrushUnitsMode;
+    brushUnitsModeY?: BrushUnitsMode;
+    brushMarginTop?: number;
+    brushMarginBottom?: number;
+    brushMarginLeft?: number;
+    brushMarginRight?: number;
+    enableBrushCreate?: boolean;
+    enableBrushEdit?: boolean;
+    enableBrushClear?: boolean;
+    brushDelay?: number;
+    maybeBrushDelay?: number;
+    persistBrush?: boolean;
+    brushMode?: BrushMode;
+    brushColor?: string;
+    brush?: BrushState | NoBrush | null;
+    onBrush?: (state: BrushState, snappedState: BrushState) => BrushResult;
+    onBrushEnd?: (state: BrushState, snappedState: BrushState) => BrushResult;
+    onBrushClear?: (state: BrushState) => void;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist-tsc/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,KAAK,EACV,eAAe,EACf,wBAAwB,EACxB,YAAY,EACZ,UAAU,EACV,WAAW,EACX,YAAY,EACb,MAAM,aAAa,CAAC;AAOrB,qEAAqE;AACrE,MAAM,MAAM,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC;AAEnC,8CAA8C;AAC9C,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjD,yEAAyE;AACzE,MAAM,MAAM,QAAQ,GAAG,aAAa,CAAC;AAErC;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,cAAc,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,eAAe,CAAC;IACnC,2BAA2B,EAAE,wBAAwB,CAAC;IACtD,SAAS,EAAE,QAAQ,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,QAAQ,CAAC;IACpB,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;IACjC,WAAW,EAAE,UAAU,CAAC;IACxB,0EAA0E;IAC1E,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,aAAa,EAAE,OAAO,CAAC;IACvB,uBAAuB,EAAE,OAAO,CAAC;IACjC,oBAAoB,EAAE,OAAO,CAAC;CAC/B,CAAC;AAIF,kEAAkE;AAClE,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX,CAAC;AAEF,2DAA2D;AAC3D,MAAM,MAAM,SAAS,GACjB;IAAE,IAAI,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAClC;IAAE,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC;AAEpD,oDAAoD;AACpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,UAAU,EAAE,SAAS,GAAG,SAAS,CAAC;IAClC,YAAY,EAAE,WAAW,CAAC;IAC1B,aAAa,EAAE,kBAAkB,EAAE,CAAC;CACrC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,CAAC,GAAG;IACrE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,aAAa,EAAE,eAAe,CAAC,GAAG;IACpE,aAAa,EAAE,qBAAqB,EAAE,CAAC;CACxC,CAAC;AAIF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,MAAM,GACN,YAAY,GACZ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,IAAI,GACJ,SAAS,CAAC;AAEd,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAC;IACxB,uEAAuE;IACvE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,cAAc,CAAC;IACxB,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAIF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,MAAM,GAAG,YAAY,CAAC;AAO9D,MAAM,MAAM,WAAW,GAAG;IAExB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IAEf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjE,iFAAiF;AACjF,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAE9D,MAAM,MAAM,UAAU,GAAG;IAEvB,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC;IAC/B,KAAK,EAAE,SAAS,CAAC;IAMjB,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,YAAY,CAAC;AAClC,MAAM,MAAM,OAAO,GAAG,OAAO,QAAQ,CAAC;AAGtC,MAAM,MAAM,WAAW,GAAG,EAKzB,CAAC;AAIF,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IAEvB;;;;OAIG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kFAAkF;IAClF,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;IACpD,sEAAsE;IACtE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8EAA8E;IAC9E,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACnC,oDAAoD;IACpD,eAAe,CAAC,EAAE,CAAC,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IAEhE,sEAAsE;IACtE,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oFAAoF;IACpF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACnD,OAAO,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,aAAa,KAAK,cAAc,CAAC,GAAG,IAAI,CAAC;IAU7D,eAAe,CAAC,EAAE,cAAc,CAAC;IACjC,eAAe,CAAC,EAAE,cAAc,CAAC;IAKjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAG1B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAI5B,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAK3B,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,eAAe,CAAC,EAAE,MAAM,CAAC;IAIzB,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,SAAS,CAAC,EAAE,SAAS,CAAC;IAItB,UAAU,CAAC,EAAE,MAAM,CAAC;IAepB,KAAK,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,IAAI,CAAC;IAMpC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,KAAK,WAAW,CAAC;IAEvE,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,KAAK,WAAW,CAAC;IAG1E,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;CAE5C,CAAC"}

package/dist-tsc/types.js

@@ -0,0 +1,11 @@
+/**
+ * The value of {@link PluotProps.brush} meaning "controlled, but nothing is
+ * brushed right now".
+ *
+ * `undefined` cannot play this role: a prop that was never passed is
+ * indistinguishable from one explicitly set to `undefined`, and an absent
+ * `brush` has to mean uncontrolled. A parent that controls the brush therefore
+ * passes `NO_BRUSH` rather than `undefined` to show no brush, which keeps it
+ * controlled across the empty state instead of silently handing control back.
+ */
+export const NO_BRUSH = "NoBrush";

package/dist-tsc/use-brush.d.ts

@@ -0,0 +1,53 @@
+import { type RefObject } from "react";
+import type { AspectRatioMode, AspectRatioAlignmentMode, CameraMatrix } from "@pluot/core";
+import { type BrushEdge, type BrushGeometry } from "./brush.js";
+import type { BrushState, PluotProps } from "./types.js";
+/** Radius (in pixels) of the hover target around the clear button. */
+export declare const CLEAR_BUTTON_RADIUS_PX = 9;
+/** What the overlay needs to draw the long-click progress indicator. */
+export type BrushPressProgress = {
+    xPixels: number;
+    yPixels: number;
+    /** 0 to 1, reaching 1 exactly when `brushDelay` elapses. */
+    fraction: number;
+};
+export type UseBrushParams = Pick<PluotProps, "brushUnitsModeX" | "brushUnitsModeY" | "brushMarginTop" | "brushMarginRight" | "brushMarginBottom" | "brushMarginLeft" | "enableBrushCreate" | "enableBrushEdit" | "enableBrushClear" | "brushDelay" | "maybeBrushDelay" | "persistBrush" | "brushMode" | "brush" | "onBrush" | "onBrushEnd" | "onBrushClear"> & {
+    containerRef: RefObject<HTMLDivElement | null>;
+    width: number;
+    height: number;
+    marginTop: number;
+    marginRight: number;
+    marginBottom: number;
+    marginLeft: number;
+    aspectRatioMode: AspectRatioMode;
+    aspectRatioAlignmentMode: AspectRatioAlignmentMode;
+    cameraMatrix: CameraMatrix;
+};
+export type UseBrushResult = {
+    /** The brush to draw, already reprojected into the current geometry. */
+    brushState: BrushState | undefined;
+    geometry: BrushGeometry;
+    /** Must be attached to the overlay SVG, so its handles are excluded from brush creation. */
+    overlayRef: RefObject<SVGSVGElement | null>;
+    pressProgress: BrushPressProgress | null;
+    /** Whether the clear button should be shown (hovering the brush, `enableBrushClear`). */
+    isBrushHovered: boolean;
+    /** True while a create/edit drag is in flight, so the camera can stand down. */
+    isBrushingRef: RefObject<boolean>;
+    /** Set when a brush drag just ended, so the ensuing `click` does not also pick. */
+    shouldSuppressClickRef: RefObject<boolean>;
+    onVertexMouseDown: (vertexIndex: number, event: React.MouseEvent) => void;
+    onEdgeMouseDown: (edge: BrushEdge, event: React.MouseEvent) => void;
+    onClearClick: (event: React.MouseEvent) => void;
+};
+/**
+ * Implements the brush interactions: long-click to create a rect/lasso, drag a
+ * vertex to edit, and click the clear button to cancel.
+ *
+ * Brushing is controlled when `brush` is a `BrushState` or `undefined`, and
+ * uncontrolled when `brush` is `null` (mirroring `cameraMatrix`/`setCameraMatrix`).
+ * When controlled, nothing is stored here: updates are emitted via `onBrush`/
+ * `onBrushEnd` and the parent is expected to feed them back through `brush`.
+ */
+export declare function useBrush(params: UseBrushParams): UseBrushResult;
+//# sourceMappingURL=use-brush.d.ts.map

package/dist-tsc/use-brush.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-brush.d.ts","sourceRoot":"","sources":["../src/use-brush.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAE1G,OAAO,KAAK,EAAE,eAAe,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAWL,KAAK,SAAS,EACd,KAAK,aAAa,EACnB,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,UAAU,EAAe,UAAU,EAAE,MAAM,YAAY,CAAC;AAQtE,sEAAsE;AACtE,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAExC,wEAAwE;AACxE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,EACxC,iBAAiB,GAAG,iBAAiB,GACrC,gBAAgB,GAAG,kBAAkB,GAAG,mBAAmB,GAAG,iBAAiB,GAC/E,mBAAmB,GAAG,iBAAiB,GAAG,kBAAkB,GAC5D,YAAY,GAAG,iBAAiB,GAAG,cAAc,GAAG,WAAW,GAC/D,OAAO,GAAG,SAAS,GAAG,YAAY,GAAG,cAAc,CACtD,GAAG;IACF,YAAY,EAAE,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAC/C,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,eAAe,CAAC;IACjC,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,wEAAwE;IACxE,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IACnC,QAAQ,EAAE,aAAa,CAAC;IACxB,4FAA4F;IAC5F,UAAU,EAAE,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAC5C,aAAa,EAAE,kBAAkB,GAAG,IAAI,CAAC;IACzC,yFAAyF;IACzF,cAAc,EAAE,OAAO,CAAC;IACxB,gFAAgF;IAChF,aAAa,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAClC,mFAAmF;IACnF,sBAAsB,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC3C,iBAAiB,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC;IAC1E,eAAe,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC;IACpE,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC;CACjD,CAAC;AAWF;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAwZ/D"}