DWVv0.37.0

BrushMaskPaint

Source: brushMaskPaint.js:189

Mask offset computation and dab painting (moved from Brush).


Constructor

new BrushMaskPaint(options: object): BrushMaskPaint

Parameters

  • options (object) — Options.
    • options.app (App) — Application.

Instance Methods

getBrushSize(): number

Returns

  • number — Current brush size in display pixels.

getBrushMode(): string

Returns

  • string — Current add vs delete painting mode.

getSelectedSegmentNumber(): number | undefined

Returns

  • number | undefined — Active DICOM segment index.

setBrushMode(mode: string)

Parameters

  • mode (string) — Add vs delete painting mode ('add' | 'del').

setFeatures(features: object)

Parameters

  • features (object) — Fields from Brush#setFeatures: mask (createMask, maskDataId) and live brush (brushSize, brushMode, selectedSegmentNumber, brushSizeRange).

beginStroke(point: Point2D, layerGroup: LayerGroup): boolean

Parameters

  • point (Point2D) — Pointer position at stroke start.
  • layerGroup (LayerGroup) — The layer group.

Returns

  • boolean — False when first dab produced no offsets (drag aborted).

paintStep(point: Point2D, layerGroup: LayerGroup)

Parameters

  • point (Point2D) — Current pointer position.
  • layerGroup (LayerGroup) — The layer group under the pointer.

finalizeStroke()

Commit the stroke: undo command, labels, and brush events.

setFeatures(features: object)

Parameters

  • features (object) — Brush feature fields (segment, mode).

setBrushMode(mode: string)

Parameters

  • mode (string) — Add vs delete brush mode (add / del).