@pixerate/editor 0.202.0 → 0.203.0

package/dist/image-editor/controller.d.cts

@@ -163,6 +163,9 @@ export interface FocusAreaCommandOptions extends FocusAreaOptions {
 }
 /** Options of {@link ImageEditorController.selectSky}. */
 export interface SkyCommandOptions extends SkyOptions {
+    /** With a segmentation provider set, ask it for the sky (default true); false finds it classically. */
+    useModel?: boolean;
+    signal?: AbortSignal;
     /** How the sky combines with the selection (default `replace`). */
     mode?: SelectionMode;
     /** Sample every layer (default true) or only the active pixel layer. */
@@ -170,6 +173,12 @@ export interface SkyCommandOptions extends SkyOptions {
 }
 /** Options of {@link ImageEditorController.selectObject}. */
 export interface SelectObjectCommandOptions {
+    /**
+     * With a segmentation provider set, ask it for the object in the box or under the point (default
+     * true), falling back to GrabCut when nothing it returns fits; false always uses GrabCut.
+     */
+    useModel?: boolean;
+    signal?: AbortSignal;
     /** How the object combines with the selection (default `replace`). */
     mode?: SelectionMode;
     /** Sample every layer (default true) or only the active pixel layer. */
@@ -1549,13 +1558,26 @@ export declare class ImageEditorController {
      * one undo step. Resolves to the resulting selection.
      */
     quickSelect(strokes: ImagePoint[][], options?: QuickSelectCommandOptions): Promise<SelectionMask | null>;
+    /**
+     * Asks the segmentation provider (which must be set) for `request.target` in the flattened image
+     * and returns its results with masks decoded to pixels.
+     */
+    private modelSegments;
+    /**
+     * The model's object for Object Selection: of what it returns, the pieces mostly inside the box
+     * (clipped to the box grown by a tenth) or those under the point. `null` when none fits.
+     */
+    private modelObject;
     /**
      * Object Selection: the object inside `target.rect` (natural pixels; what is outside the box is
      * background) or under `target.point`, found by GrabCut (colour models of object and background
      * plus a graph cut along edges), combined with the selection by `mode` as one undo step.
      * Resolves to the resulting selection.
      */
-    selectObject(target: ObjectTarget, options?: SelectObjectCommandOptions): Promise<SelectionMask | null>;
+    selectObject(target: ObjectTarget, options?: SelectObjectCommandOptions): Promise<{
+        selection: SelectionMask | null;
+        method: 'model' | 'grabcut';
+    }>;
     /**
      * Select › Focus Area: selects the parts of the image that are in focus (fine detail above the
      * image's noise), fitted to its edges, combined with the selection by `mode` as one undo step.
@@ -1573,6 +1595,7 @@ export declare class ImageEditorController {
      */
     selectSky(options?: SkyCommandOptions): Promise<{
         selection: SelectionMask | null;
+        method: 'model' | 'classical';
         note?: string;
     }>;
     /**

package/dist/image-editor/controller.d.ts

@@ -163,6 +163,9 @@ export interface FocusAreaCommandOptions extends FocusAreaOptions {
 }
 /** Options of {@link ImageEditorController.selectSky}. */
 export interface SkyCommandOptions extends SkyOptions {
+    /** With a segmentation provider set, ask it for the sky (default true); false finds it classically. */
+    useModel?: boolean;
+    signal?: AbortSignal;
     /** How the sky combines with the selection (default `replace`). */
     mode?: SelectionMode;
     /** Sample every layer (default true) or only the active pixel layer. */
@@ -170,6 +173,12 @@ export interface SkyCommandOptions extends SkyOptions {
 }
 /** Options of {@link ImageEditorController.selectObject}. */
 export interface SelectObjectCommandOptions {
+    /**
+     * With a segmentation provider set, ask it for the object in the box or under the point (default
+     * true), falling back to GrabCut when nothing it returns fits; false always uses GrabCut.
+     */
+    useModel?: boolean;
+    signal?: AbortSignal;
     /** How the object combines with the selection (default `replace`). */
     mode?: SelectionMode;
     /** Sample every layer (default true) or only the active pixel layer. */
@@ -1549,13 +1558,26 @@ export declare class ImageEditorController {
      * one undo step. Resolves to the resulting selection.
      */
     quickSelect(strokes: ImagePoint[][], options?: QuickSelectCommandOptions): Promise<SelectionMask | null>;
+    /**
+     * Asks the segmentation provider (which must be set) for `request.target` in the flattened image
+     * and returns its results with masks decoded to pixels.
+     */
+    private modelSegments;
+    /**
+     * The model's object for Object Selection: of what it returns, the pieces mostly inside the box
+     * (clipped to the box grown by a tenth) or those under the point. `null` when none fits.
+     */
+    private modelObject;
     /**
      * Object Selection: the object inside `target.rect` (natural pixels; what is outside the box is
      * background) or under `target.point`, found by GrabCut (colour models of object and background
      * plus a graph cut along edges), combined with the selection by `mode` as one undo step.
      * Resolves to the resulting selection.
      */
-    selectObject(target: ObjectTarget, options?: SelectObjectCommandOptions): Promise<SelectionMask | null>;
+    selectObject(target: ObjectTarget, options?: SelectObjectCommandOptions): Promise<{
+        selection: SelectionMask | null;
+        method: 'model' | 'grabcut';
+    }>;
     /**
      * Select › Focus Area: selects the parts of the image that are in focus (fine detail above the
      * image's noise), fitted to its edges, combined with the selection by `mode` as one undo step.
@@ -1573,6 +1595,7 @@ export declare class ImageEditorController {
      */
     selectSky(options?: SkyCommandOptions): Promise<{
         selection: SelectionMask | null;
+        method: 'model' | 'classical';
         note?: string;
     }>;
     /**