@pixerate/editor 0.266.2 → 0.268.0

package/dist/vector/controller.d.ts

@@ -29,7 +29,7 @@ import { type VectorSnapGuides, type VectorTrackingPoint } from './snap.js';
 import { type VectorBlendMode, type VectorFilterType, type VectorWarpMesh } from './types.js';
 import { EffectsSlot } from '../effects/helpers.js';
 import type { EffectProvider, EffectValue } from '../effects/types.js';
-import type { Vec2, VectorEffectType, VectorAlign, VectorAnchor, VectorAnchorRef, VectorAnchorType, VectorArrange, VectorAverageAxis, VectorBlendOptions, VectorBooleanOperation, VectorBounds, VectorCornerKind, VectorDefaults, VectorDistribute, VectorDocument, VectorGroupNode, VectorProviderEffect, VectorHandleRef, VectorMask, VectorMaskType, VectorModifiers, VectorNode, VectorPathfinderOperation, VectorPathNode, VectorSegmentRef, VectorStyle, VectorSubpath, VectorTool, VectorTransformHandle, VectorViewport, VectorWidthPoint, VectorCharacterStyle, VectorParagraphStyle, VectorTextAlign, VectorTextFrame, VectorTextNode, VectorMatrix, VectorSymbol, VectorPaint, VectorConstraint, VectorConstraintKind, VectorParameter, VectorBrushstroke, VectorBrushstrokePaper } from './types.js';
+import type { Vec2, VectorEffectType, VectorAlign, VectorAnchor, VectorAnchorRef, VectorAnchorType, VectorArrange, VectorAverageAxis, VectorBlendOptions, VectorBooleanOperation, VectorBounds, VectorCornerKind, VectorDefaults, VectorDistribute, VectorDocument, VectorGroupNode, VectorProviderEffect, VectorHandleRef, VectorMask, VectorMaskType, VectorModifiers, VectorNode, VectorPathfinderOperation, VectorPathNode, VectorSegmentRef, VectorStyle, VectorSubpath, VectorTool, VectorTransformHandle, VectorViewport, VectorWidthPoint, VectorCharacterStyle, VectorParagraphStyle, VectorTextAlign, VectorTextFrame, VectorTextNode, VectorMatrix, VectorSymbol, VectorPaint, VectorConstraint, VectorConstraintKind, VectorParameter, VectorBrushstroke, VectorBrushstrokePaint, VectorBrushstrokePaper } from './types.js';
 export interface VectorSnapOptions {
     /** Grid size in document units (0 = off, default 0). Points and boxes that snap to no object snap to it. */
     grid: number;
@@ -113,6 +113,8 @@ export interface VectorEditorOptions {
     brushPreview?: BrushPreviewRenderer;
     /** The app's colour scheme, which picks the side of a brush's light / dark default colour (default light). */
     colorScheme?: 'light' | 'dark';
+    /** Start with the colour locked: new and rebrushed brushstrokes keep their colour (see `setColorLocked`). */
+    colorLocked?: boolean;
     /** History to record into, e.g. one shared with the rest of the app (default: a new one). */
     history?: HistoryManager;
     /** Starting tool (default `select`). */
@@ -408,6 +410,10 @@ export interface VectorEditorState {
      * a side skews along it (Alt: about the centre).
      */
     freeDistort: boolean;
+    /** The colour scheme that picks the side of a brush's light / dark default colour. */
+    colorScheme: 'light' | 'dark';
+    /** "Keep my colour": brushstrokes don't take a brush's default colour (`setColorLocked`). */
+    colorLocked: boolean;
     /** The text being edited on the canvas, or null. Typing goes to `textInput`, keys to `keyDown`. */
     textEdit: VectorTextEditState | null;
     /** Font and alignment new text gets. */
@@ -799,6 +805,7 @@ export declare class VectorEditorController {
     private revision;
     private state;
     private colorScheme;
+    private colorLocked;
     constructor(options?: VectorEditorOptions);
     /** Listens to the history (once; again after `destroy`). */
     private connect;
@@ -1133,7 +1140,7 @@ export declare class VectorEditorController {
      * Adds a brushstroke to the selected (or given) paths: a stroke layer that paints the path with
      * brush `brushId` (a preset, or a saved brush of the brush library: `listBrushstrokeBrushes`), `size` document
      * units across (default the brush's own), an optional `pressure` profile along the length, in
-     * `color` (default the brush's own default colour, unless `keepColour`; else the top stroke's
+     * `color` (default the brush's own default colour, unless `keepColour` or the colour is locked; else the top stroke's
      * paint, else black) at `opacity`. At the top of the stroke
      * stack or at `index`. A `seed` gives it the brush's character (jitter and the grain of `paper`,
      * `null` for none); without one it renders plain. One undo step.
@@ -1150,7 +1157,7 @@ export declare class VectorEditorController {
      * given) paths: another brush, size, pressure profile (null removes it), colour or opacity, the
      * character `seed` (null removes it: plain dabs) or the `paper` (replaced whole: `null` for no
      * grain, `{}` for the default paper). Another brush without a `color` takes that brush's default
-     * colour, if it has one, unless `keepColour`. Fails, changing nothing, when that layer is not a
+     * colour, if it has one, unless `keepColour` or the colour is locked. Fails, changing nothing, when that layer is not a
      * brushstroke. With `merge`, consecutive edits fold into one undo step.
      */
     setBrushstroke(index: number, patch: {
@@ -1162,12 +1169,19 @@ export declare class VectorEditorController {
         opacity?: number;
         seed?: number | null;
         paper?: VectorBrushstrokePaper | null;
+        paint?: VectorBrushstrokePaint | null;
     }, options?: {
         ids?: readonly string[];
         merge?: boolean | string;
     }): VectorActionResult;
     /** Sets the colour scheme that picks the side of a brush's light / dark default colour. Existing strokes keep their colour. */
     setColorScheme(scheme: 'light' | 'dark'): void;
+    /**
+     * Locks the brushstroke colour ("Keep my colour"): `addBrushstroke` and `setBrushstroke` with
+     * another brush keep the colour instead of taking the brush's default; an explicit `color` still
+     * applies. Existing strokes are unchanged. Editor state, not an undo step.
+     */
+    setColorLocked(locked: boolean): void;
     /** Removes layer `index` of the fill or stroke stack of the selected (or given) paths. */
     removePaintLayer(kind: 'fill' | 'stroke', index: number, options?: {
         ids?: readonly string[];