@niivue/uikit 1.0.0-rc.37 → 1.0.0-rc.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -25,7 +25,8 @@ proven, core's overlays cut over onto it and the duplicate in core is removed.
25
25
 
26
26
  Each widget is a pure geometry builder (spec in, plain line + text draw data out,
27
27
  unit-testable without a GPU) paired with an overlay that owns the GPU resources
28
- and draws that data through the lifecycle hook. The overlays are the API. Of
28
+ and draws that data through the lifecycle hook (`buildAnnotationGeometry` is
29
+ the exception: it has no overlay of its own). The overlays are the API. Of
29
30
  the builders, only the measuring widgets' and the primitives' (`buildRuler`,
30
31
  `buildCrosshair`, `buildAnnotationGeometry`, `buildRect`, `buildLine`,
31
32
  `buildTerminatedLine`) are exported; the control widgets' models are
@@ -35,7 +36,7 @@ package-private (see "Conventions for contributors").
35
36
  | --- | --- | --- |
36
37
  | `buildRuler` | `UIKitRulerOverlay` | A measuring ruler with graduated ticks and a distance label |
37
38
  | `buildCrosshair` | `UIKitCrosshairOverlay` | A screen-space cross marking a point, optionally graduated and numbered |
38
- | `buildAnnotationGeometry` | `UIKitAnnotationOverlay` | Free-form annotation lines |
39
+ | `buildAnnotationGeometry` | none (draw it with `UIKitLineOverlay` + `UIKitTextOverlay`) | Annotation ROI outlines, arrows, rulers and stats labels |
39
40
  | `buildRect` | `UIKitRectOverlay` | Filled rounded rectangles with an optional border ring (the first filled primitive) |
40
41
  | `buildButton` | `UIKitButtonOverlay` | Clickable, stylable push buttons with a text label and a press animation |
41
42
  | `buildToggle` | `UIKitToggleOverlay` | Check boxes with a label: pointer or Space/Enter flips them |
@@ -1,6 +1,5 @@
1
- import { AnnotationScreenShape, UIKitOverlayFrame, UIKitOverlayRenderer } from '@niivue/niivue';
1
+ import { AnnotationScreenShape } from '@niivue/niivue';
2
2
  import { LineData } from './line';
3
- import { UIKitFont } from './text/font';
4
3
  import { UIKitTextItem } from './textOverlay';
5
4
  export interface AnnotationGeometryOptions {
6
5
  /** Device-pixel ratio; scales stroke width + label size for crisp output. */
@@ -17,15 +16,3 @@ export declare function buildAnnotationGeometry(shapes: readonly AnnotationScree
17
16
  lines: LineData[];
18
17
  text: UIKitTextItem[];
19
18
  };
20
- export declare class UIKitAnnotationOverlay implements UIKitOverlayRenderer {
21
- private readonly lines;
22
- private readonly labels;
23
- private shapes;
24
- private options;
25
- constructor(font: UIKitFont, options?: AnnotationGeometryOptions);
26
- /** Set the shapes to draw next frame. Trigger a redraw via the controller. */
27
- setShapes(shapes: readonly AnnotationScreenShape[], options?: AnnotationGeometryOptions): void;
28
- clear(): void;
29
- drawOverlay(frame: UIKitOverlayFrame): void;
30
- destroy(): void;
31
- }
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export type { AnnotationGeometryOptions } from './annotationOverlay';
2
- export { buildAnnotationGeometry, UIKitAnnotationOverlay, } from './annotationOverlay';
2
+ export { buildAnnotationGeometry } from './annotationOverlay';
3
3
  export type { ButtonLayout, ButtonSpec, ButtonStyle, ButtonVisual, } from './button';
4
4
  export { DEFAULT_BUTTON_STYLE } from './button';
5
5
  export type { UIKitButtonHost, UIKitButtonOverlayOptions, } from './buttonOverlay';