@gradio/imageeditor 0.12.14 → 0.13.0

package/dist/shared/crop/crop.d.ts

@@ -0,0 +1,201 @@
+import { type ImageEditorContext, type Tool } from "../core/editor";
+import { type Tool as ToolbarTool, type Subtool } from "../Toolbar.svelte";
+/**
+ * @interface CropBounds
+ * @description Defines the bounds of a crop area
+ * @property {number} x - The x-coordinate of the crop area
+ * @property {number} y - The y-coordinate of the crop area
+ * @property {number} width - The width of the crop area
+ * @property {number} height - The height of the crop area
+ */
+interface CropBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/**
+ * @class CropTool
+ * @implements {Tool}
+ * @description Implements the crop tool functionality for the image editor
+ */
+export declare class CropTool implements Tool {
+    name: "crop";
+    private image_editor_context;
+    current_tool: ToolbarTool;
+    current_subtool: Subtool;
+    private readonly CORNER_SIZE;
+    private readonly LINE_THICKNESS;
+    private readonly HANDLE_COLOR;
+    private readonly HIT_AREA_SIZE;
+    private is_dragging;
+    private selected_handle;
+    private active_corner_index;
+    private active_edge_index;
+    private last_pointer_position;
+    crop_bounds: CropBounds;
+    private crop_ui_container;
+    private crop_mask;
+    private dimensions;
+    private position;
+    private scale;
+    private is_dragging_window;
+    private drag_start_position;
+    private drag_start_bounds;
+    private background_image_watcher;
+    private has_been_manually_changed;
+    private event_callbacks;
+    /**
+     * @method setup
+     * @async
+     * @description Sets up the crop tool with the given context and state
+     * @param {ImageEditorContext} context - The image editor context
+     * @param {ToolbarTool} tool - The current tool
+     * @param {Subtool} subtool - The current subtool
+     * @returns {Promise<void>}
+     */
+    setup(context: ImageEditorContext, tool: ToolbarTool, subtool: Subtool): Promise<void>;
+    /**
+     * @method cleanup
+     * @description Cleans up the crop tool resources and removes event listeners
+     * @returns {void}
+     */
+    cleanup(): void;
+    /**
+     * @method set_tool
+     * @description Sets the current tool and subtool, updating UI visibility
+     * @param {ToolbarTool} tool - The tool to set
+     * @param {Subtool} subtool - The subtool to set
+     * @returns {void}
+     */
+    set_tool(tool: ToolbarTool, subtool: Subtool): void;
+    /**
+     * @method set_crop_mask
+     * @private
+     * @description Sets up the crop mask for the image
+     * @returns {void}
+     */
+    private set_crop_mask;
+    /**
+     * @method init_crop_ui
+     * @private
+     * @async
+     * @description Initializes the crop UI elements and sets up the update loop
+     * @returns {Promise<void>}
+     */
+    private init_crop_ui;
+    /**
+     * @method make_crop_ui
+     * @private
+     * @description Creates the crop UI with the specified dimensions
+     * @param {number} width - Width of the crop area
+     * @param {number} height - Height of the crop area
+     * @returns {Container} The created crop UI container
+     */
+    private make_crop_ui;
+    /**
+     * @method create_handle
+     * @private
+     * @description Creates a handle for the crop UI
+     * @param {boolean} [is_edge=false] - Whether the handle is an edge handle
+     * @returns {Container} The created handle container
+     */
+    private create_handle;
+    /**
+     * @method create_edge_handles
+     * @private
+     * @description Creates edge handles for the crop UI
+     * @param {Container} container - The container to add handles to
+     * @param {number} width - Width of the crop area
+     * @param {number} height - Height of the crop area
+     * @returns {void}
+     */
+    private create_edge_handles;
+    /**
+     * @method create_corner_handles
+     * @private
+     * @description Creates corner handles for the crop UI
+     * @param {Container} container - The container to add handles to
+     * @param {number} width - Width of the crop area
+     * @param {number} height - Height of the crop area
+     * @returns {void}
+     */
+    private create_corner_handles;
+    /**
+     * @method handle_pointer_down
+     * @private
+     * @description Handles pointer down events on handles
+     * @param {FederatedPointerEvent} event - The pointer event
+     * @param {Container} handle - The handle that was clicked
+     * @param {number} corner_index - Index of the corner (-1 if not a corner)
+     * @param {number} edge_index - Index of the edge (-1 if not an edge)
+     * @returns {void}
+     */
+    private handle_pointer_down;
+    /**
+     * updates the crop bounds based on pointer movement
+     * @param delta - the change in position
+     */
+    private update_crop_bounds;
+    /**
+     * constrains the crop bounds to the image dimensions
+     */
+    private constrain_crop_bounds;
+    /**
+     * updates the crop mask graphics
+     */
+    private update_crop_mask;
+    /**
+     * updates the crop ui position and dimensions
+     */
+    private update_crop_ui;
+    /**
+     * updates the positions of all handles
+     * @param width - width of the crop area
+     * @param height - height of the crop area
+     */
+    private update_handle_positions;
+    /**
+     * sets up event listeners for the crop tool
+     */
+    private setup_event_listeners;
+    /**
+     * removes event listeners for the crop tool
+     */
+    private cleanup_event_listeners;
+    /**
+     * handles pointer move events
+     * @param event - the pointer event
+     */
+    private handle_pointer_move;
+    /**
+     * handles pointer up events
+     */
+    private handle_pointer_up;
+    /**
+     * handles the start of window dragging
+     * @param event - the pointer event
+     */
+    private handle_window_drag_start;
+    /**
+     * @returns whether the crop has been manually changed by the user
+     */
+    get crop_manually_changed(): boolean;
+    on<T extends string>(event: T, callback: () => void): void;
+    off<T extends string>(event: T, callback: () => void): void;
+    private notify;
+    get_crop_bounds(): {
+        x: number;
+        y: number;
+        crop_dimensions: {
+            width: number;
+            height: number;
+        };
+        image_dimensions: {
+            width: number;
+            height: number;
+        };
+    };
+    get_image(): Promise<Blob | null>;
+}
+export {};