@gcode-viewer/plugins 0.3.0 → 0.3.1

package/dist/types/gcode-steps-bar/GCodeStepsBarPlugin.d.ts

@@ -17,6 +17,8 @@ export declare class GCodeStepsBarPlugin extends Plugin {
     private slider?;
     private rail?;
     private fill?;
+    private rangeStartEl?;
+    private rangeEndEl?;
     private thumb?;
     private valueEl?;
     private minLine;

package/dist/types/gcode-steps-bar/Locale.d.ts

@@ -1,9 +1,13 @@
 import { i18n } from "@gcode-viewer/core";
 export declare const en: {
     currentLine: string;
+    startLine: string;
+    endLine: string;
 };
 export declare const zh: {
     currentLine: string;
+    startLine: string;
+    endLine: string;
 };
 export declare const GCODE_STEPS_BAR_I18N_NAMESPACE: "gcodeStepsBar";
 export { i18n };

package/dist/types/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./axis-gizmo";
 export * from "./bottom-bar";
 export * from "./context-menu";
 export * from "./dat-gui";

package/dist/types/local-model-uploader/LocalModelUploader.d.ts

@@ -1,4 +1,4 @@
-import type { ModelConfig, Viewer3d } from "@gcode-viewer/core";
+import type { BaseViewer, ModelConfig } from "@gcode-viewer/core";
 import { IUploader, UploaderConfig } from "./IUploader";
 /**
  * @hidden
@@ -6,7 +6,7 @@ import { IUploader, UploaderConfig } from "./IUploader";
 export declare class LocalModelUploader extends IUploader {
     static readonly DEFAULT_ID = "LocalModelUploader";
     readonly defaultModelConfig: ModelConfig;
-    constructor(viewer: Viewer3d, cfg?: UploaderConfig);
+    constructor(viewer: BaseViewer, cfg?: UploaderConfig);
     protected formats(): string[];
     /**
      * Uploads model files. There are several cases:

package/dist/types/plate/PlatePlugin.d.ts

@@ -23,9 +23,9 @@ export interface PlatePluginConfig extends Partial<PluginConfig> {
     /** World Z of the plate top surface. Default `0`. */
     height?: number;
     /**
-     * Where world XY `(0,0)` sits on the plate.
-     * - `corner` (default): plate covers `[0, sizeX] × [0, sizeY]` (printer-style).
-     * - `center`: plate is centered on the origin.
+     * Where world XY `(0,0)` sits on the plate before {@link fitToBox} offsets.
+     * - `corner` (default): plate covers `[offset, offset+size]` (printer-style; offset defaults to 0).
+     * - `center`: plate is centered on `(offsetX, offsetY)` (defaults to world origin).
      */
     origin?: "corner" | "center";
     /** Plate fill color. Default dark charcoal. */
@@ -37,10 +37,42 @@ export interface PlatePluginConfig extends Partial<PluginConfig> {
     /** Plate edge outline color. */
     edgeColor?: number;
     /**
-     * Labeled scale marks along the origin edges, in mm from the plate min corner.
-     * Default `[100, 200, 300]`. Pass `[]` to disable. Marks are drawn outside the plate.
+     * Spacing (mm) between labeled scale marks along the origin edges.
+     * Default `100` — marks at `interval`, `2*interval`, … while strictly inside each edge.
+     * Pass `0` to disable all labels including origin {@code 0}.
+     * Marks are drawn outside the plate (slicer-style rulers use {@code 0}, not {@code (0, 0)}).
      */
-    scaleMarks?: number[];
+    scaleInterval?: number;
+}
+/**
+ * Options for {@link PlatePlugin.fitToBox} / {@link PlatePlugin.fitToLoadedModels}.
+ * Does not move models — only resizes / repositions the plate in XY.
+ */
+export interface FitPlateOptions {
+    /** Padding around the model XY AABB (mm). Default `20`. */
+    margin?: number;
+    /** Minimum plate width (mm). Default `100`. */
+    minSizeX?: number;
+    /** Minimum plate depth (mm). Default `100`. */
+    minSizeY?: number;
+    /**
+     * Snap plate sizes up to a multiple of this value (mm). Default `10`.
+     * Pass `0` to disable.
+     */
+    roundTo?: number;
+    /**
+     * How the plate is placed relative to the model.
+     * - `frame` (default): size = XY extent + `2 * margin`; plate is centered on the model
+     *   so the toolpath sits in the middle of the bed (equal margin on each side).
+     * - `coverOrigin`: keep plate corner at world `(0, 0)`; grow size to cover `box.max + margin`
+     *   (classic printer-bed layout when GCode uses the bed corner as origin).
+     */
+    placement?: "frame" | "coverOrigin";
+    /**
+     * When true, use a square plate with side = max(sizeX, sizeY).
+     * Default `false`.
+     */
+    square?: boolean;
 }
 /**
  * Finite build-plate with a dark surface and anti-aliased light gray grid.
@@ -49,9 +81,12 @@ export interface PlatePluginConfig extends Partial<PluginConfig> {
 export declare class PlatePlugin extends Plugin {
     static readonly DEFAULT_ID = "PlatePlugin";
     protected readonly NAME = "BUILD_PLATE";
-    protected cfg: Required<Pick<PlatePluginConfig, "visible" | "sizeX" | "sizeY" | "cellSize" | "majorEvery" | "height" | "origin" | "plateColor" | "gridColor" | "majorGridColor" | "edgeColor" | "scaleMarks">> & PlatePluginConfig;
+    protected cfg: Required<Pick<PlatePluginConfig, "visible" | "sizeX" | "sizeY" | "cellSize" | "majorEvery" | "height" | "origin" | "plateColor" | "gridColor" | "majorGridColor" | "edgeColor" | "scaleInterval">> & PlatePluginConfig;
     protected root?: THREE.Group;
     protected plateMesh?: THREE.Mesh;
+    /** World XY of the plate corner (`corner`) or plate center (`center`). */
+    protected plateOffsetX: number;
+    protected plateOffsetY: number;
     constructor(viewer: BaseViewer, cfg?: PlatePluginConfig);
     getSize(): {
         sizeX: number;
@@ -63,6 +98,35 @@ export declare class PlatePlugin extends Plugin {
      */
     getWorldBBox(): THREE.Box3;
     setSize(sizeX: number, sizeY: number): void;
+    /**
+     * Resize and reposition the plate so it covers {@link box} in XY.
+     * Does **not** move loaded models — GCode / CAD stay in world coordinates.
+     *
+     * Default {@link FitPlateOptions.placement|placement} is `frame`: the plate is sized to the
+     * model footprint plus margin and shifted so the model sits in the geometric center of the bed.
+     *
+     * @returns `false` if `box` is empty/invalid
+     */
+    fitToBox(box: THREE.Box3, options?: FitPlateOptions): boolean;
+    /**
+     * Fits the plate to the viewer's loaded-model bounds (`viewer.getBBox()`).
+     * @returns `false` if there is no valid model bbox
+     */
+    fitToLoadedModels(options?: FitPlateOptions): boolean;
+    /**
+     * Size and place the plate from a slicer build volume (mm).
+     * Uses corner origin at `volume.origin` (default `(0,0)`); does not move models.
+     */
+    applyBuildVolume(volume: {
+        size: {
+            x: number;
+            y: number;
+        };
+        origin?: {
+            x?: number;
+            y?: number;
+        };
+    }): boolean;
     getCellSize(): number;
     setCellSize(cellSize: number): void;
     getHeight(): number;
@@ -72,8 +136,9 @@ export declare class PlatePlugin extends Plugin {
     isVisible(): boolean;
     /** Rebuild geometry from the current config. */
     rebuild(): void;
-    protected normalizedScaleMarks(sizeX: number, sizeY: number): number[];
-    protected addScaleLabels(root: THREE.Group, marks: number[], minX: number, minY: number, z: number): void;
+    /** Marks at interval, 2*interval, … strictly inside `span` (capped). */
+    protected scaleMarksForSpan(span: number): number[];
+    protected addScaleLabels(root: THREE.Group, marksX: number[], marksY: number[], minX: number, minY: number, z: number): void;
     /** Flat label mesh on the XY plane (not a camera-facing sprite). */
     protected createScaleLabelMesh(text: string): THREE.Mesh;
     protected plateBounds(): {

package/dist/types/settings-3d/Locale.d.ts

@@ -3,10 +3,7 @@ export declare const en: {
     settings: string;
     showOutline: string;
     doubleSidedMaterials: string;
-    showGroundGrid: string;
-    groundGridHeight: string;
     showViewCube: string;
-    showAxesHelper: string;
     enableGroundShadow: string;
     enableQuantization: string;
     regenGroundShadowTitle: string;
@@ -31,10 +28,7 @@ export declare const zh: {
     settings: string;
     showOutline: string;
     doubleSidedMaterials: string;
-    showGroundGrid: string;
-    groundGridHeight: string;
     showViewCube: string;
-    showAxesHelper: string;
     enableGroundShadow: string;
     enableQuantization: string;
     regenGroundShadowTitle: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gcode-viewer/plugins",
-    "version": "0.3.0",
+    "version": "0.3.1",
     "homepage": "https://dwg.thingraph.site/",
     "description": "Plugin modules for @gcode-viewer/core: measurement tools, toolbar, screenshot and more.",
     "author": "Thingraph",

package/dist/types/axis-gizmo/AxisGizmoPlugin.d.ts

@@ -1,25 +0,0 @@
-import { BaseViewer, Plugin, PluginConfig } from "@gcode-viewer/core";
-/**
- * AxisGizmo plugin config.
- */
-export interface AxisGizmoPluginConfig extends Partial<PluginConfig> {
-    /**
-     * UI element id to contain the plugin.
-     */
-    containerId?: string;
-    /**
-     * Ignores z-axis. It is useful for Viewer2d.
-     */
-    ignoreZAxis?: boolean;
-}
-/**
- * This renderer monitors the host renderer's camera, and keeps a coordinate axes
- * the same direction as host renderer's
- */
-export declare class AxisGizmoPlugin extends Plugin {
-    static readonly DEFAULT_ID = "AxisGizmoPlugin";
-    constructor(viewer: BaseViewer, cfg?: AxisGizmoPluginConfig);
-    setVisible(visible: boolean): void;
-    isVisible(): boolean;
-    destroy(): void;
-}

package/dist/types/axis-gizmo/CoordinateAxes.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/axis-gizmo/index.d.ts

@@ -1,2 +0,0 @@
-import "./axisgizmo.scss";
-export * from "./AxisGizmoPlugin";