Update Printer Functionality (#3092)

Implemented Print Preview and "standard engineering drawing template" as part of printouts

Author: dnikodem84

ugs-core/src/resources/MessagesBundle_en_US.properties

@@ -838,4 +838,27 @@ designer.panel.shape-settings.transform.title=Transform options
 designer.panel.shape-settings.cutting.title=Cutting options
 designer.panel.shape-settings.text.title=Text options
 designer.panel.shape-settings.rectangle.title=Rectangle options
-designer.panel.shape-settings.raster.title=Image options
+designer.panel.shape-settings.raster.title=Image options
+designer.print.preview.title=Print Preview
+designer.print.preview.page=Page {0}
+designer.print.preview.paper=Paper
+designer.print.preview.orientation=Orientation
+designer.print.preview.orientation.portrait=Portrait
+designer.print.preview.orientation.landscape=Landscape
+designer.print.preview.page-setup=Page Setup...
+designer.print.preview.offset.x=Offset X (mm)
+designer.print.preview.offset.y=Offset Y (mm)
+designer.print.preview.scale=Scale
+designer.print.preview.author=Author
+designer.print.preview.fit-to-page=Fit to single page
+designer.print.preview.include-template=Include engineering template
+designer.print.preview.include-template.tooltip.multipage=The engineering template is only added when the design fits on a single page.
+designer.print.preview.print=Print...
+designer.print.preview.cancel=Cancel
+designer.print.page.disable=Disable
+designer.print.page.disable.tooltip.last=At least one page must remain enabled.
+designer.print.template.file=FILE
+designer.print.template.author=AUTHOR
+designer.print.template.scale=SCALE
+designer.print.template.dimensions=DIMENSIONS
+designer.print.template.date=DATE

ugs-designer/src/main/java/com/willwinder/ugs/designer/actions/PrintDesignAction.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2025 Damian Nikodem
+    Copyright 2025-2026 Damian Nikodem
 
     This file is part of Universal Gcode Sender (UGS).
 
@@ -18,21 +18,32 @@ This file is part of Universal Gcode Sender (UGS).
  */
 package com.willwinder.ugs.designer.actions;
 
+import com.willwinder.ugs.designer.entities.entities.Entity;
+import com.willwinder.ugs.designer.entities.entities.controls.GridControl;
+import com.willwinder.ugs.designer.gui.Drawing;
 import com.willwinder.ugs.designer.logic.Controller;
 import com.willwinder.ugs.designer.logic.ControllerFactory;
+import com.willwinder.ugs.designer.print.DesignPrintable;
+import com.willwinder.ugs.designer.print.EngineeringTemplateRenderer;
+import com.willwinder.ugs.designer.print.PrintConfig;
+import com.willwinder.ugs.designer.print.PrintPreviewDialog;
+import com.willwinder.universalgcodesender.model.BackendAPI;
+import com.willwinder.universalgcodesender.model.UnitUtils;
+import com.willwinder.universalgcodesender.services.LookupService;
 import com.willwinder.universalgcodesender.utils.SvgIconLoader;
 
 import javax.swing.JOptionPane;
-import java.awt.Graphics;
+import java.awt.Color;
 import java.awt.Graphics2D;
-import java.awt.Point;
+import java.awt.RenderingHints;
 import java.awt.event.ActionEvent;
-import java.awt.geom.Point2D;
+import java.awt.geom.AffineTransform;
+import java.awt.geom.Rectangle2D;
 import java.awt.image.BufferedImage;
 import java.awt.print.PageFormat;
-import java.awt.print.Printable;
 import java.awt.print.PrinterException;
 import java.awt.print.PrinterJob;
+import java.time.LocalDate;
 
 /**
  * @author Damian Nikodem
@@ -41,8 +52,11 @@ public class PrintDesignAction extends AbstractDesignAction {
     public static final String SMALL_ICON_PATH = "img/print.svg";
     public static final String LARGE_ICON_PATH = "img/print24.svg";
 
-    private final static double MM_IN_INCH = 0.0393700787401575; // 5 / 127
-    private final static double PRINT_SYSTEM_DPI = 72.0;
+    private static final double MM_IN_INCH = 0.0393700787401575; // 5 / 127
+    private static final double PRINT_SYSTEM_DPI = 72.0;
+    private static final double MM_PER_POINT = 25.4 / 72.0;
+
+    private String filenameHint = "";
 
     public PrintDesignAction() {
         putValue("iconBase", SMALL_ICON_PATH);
@@ -52,78 +66,151 @@ public PrintDesignAction() {
         putValue(NAME, "Print");
     }
 
-    private int centerPos(double pageSize, double imageWidth) {
-        int result = 0;
-        if ((imageWidth / pageSize) < 1.0) {
-            result = (int) ((pageSize - imageWidth) / 2.0);
-        }
-        return result;
-    }
-
-    private Point centerPoint(PageFormat pageFormat, BufferedImage bi) {
-        return new Point(
-                centerPos(pageFormat.getImageableWidth(), bi.getWidth()),
-                centerPos(pageFormat.getImageableHeight(), bi.getHeight())
-        );
-    }
-
-    private boolean translateGraphicsForPage(PageFormat pageFormat, BufferedImage bi, int pageIndex, Graphics2D g2d) {
-        int xPageCount = (int) Math.ceil(bi.getWidth() / pageFormat.getImageableWidth());
-        int yPageCount = (int) Math.ceil(bi.getHeight() / pageFormat.getImageableHeight());
-
-        int totalPages = xPageCount * yPageCount;
-
-        if (pageIndex >= totalPages) {
-            return false;
-        }
-
-        int yPageIndex = (int) Math.floor(pageIndex / xPageCount);
-        int xPageIndex = pageIndex % xPageCount;
-
-        g2d.translate(pageFormat.getImageableX() - (xPageIndex * pageFormat.getImageableWidth()),
-                pageFormat.getImageableY() - (yPageIndex * pageFormat.getImageableHeight()));
-        // Page is valid
-        return true;
+    /**
+     * Platform wrappers set this so the printed title block can show the current file's name.
+     * The core {@link Controller} has no file-path concept of its own.
+     */
+    public void setFilenameHint(String filenameHint) {
+        this.filenameHint = filenameHint == null ? "" : filenameHint;
     }
 
     @Override
     public void actionPerformed(ActionEvent e) {
-        // Render image first. 
         Controller controller = ControllerFactory.getController();
         controller.getSelectionManager().clearSelection();
 
         PrinterJob job = PrinterJob.getPrinterJob();
-        double oldScale = controller.getDrawing().getScale();
-        Point2D.Double oldPos = controller.getDrawing().getPosition();
-
-        // Reset Scale so it draws properly. 
-        controller.getDrawing().setScale(MM_IN_INCH * PRINT_SYSTEM_DPI);
+        PageFormat pageFormat = job.defaultPage();
+        pageFormat.setOrientation(PageFormat.LANDSCAPE);
 
-        BufferedImage bi = controller.getDrawing().getImage();
+        PrintConfig config = buildConfig(controller, pageFormat);
+        BufferedImage bi = renderSourceImage(controller, config);
+        config.setSourceImageSize(bi.getWidth(), bi.getHeight());
 
-        controller.getDrawing().setScale(oldScale);
-        controller.getDrawing().setPosition(oldPos.x, oldPos.y);
+        EngineeringTemplateRenderer templateRenderer = new EngineeringTemplateRenderer();
+        DesignPrintable printable = new DesignPrintable(bi, config, templateRenderer);
 
-        job.setPrintable((Graphics graphics, PageFormat pageFormat, int pageIndex) -> {
-            Graphics2D g2d = (Graphics2D) graphics;
+        PrintPreviewDialog dialog = new PrintPreviewDialog(controller.getDrawing(), printable, job);
+        dialog.setVisible(true);
+        if (!dialog.isConfirmed()) {
+            return;
+        }
 
-            if (!translateGraphicsForPage(pageFormat, bi, pageIndex, g2d)) {
-                return Printable.NO_SUCH_PAGE;
+        job.setPrintable(printable, config.getPageFormat());
+        if (job.printDialog()) {
+            try {
+                job.print();
+            } catch (PrinterException exc) {
+                JOptionPane.showMessageDialog(null, "Error Printing: " + exc.getMessage(), "Error Printing!",
+                        JOptionPane.ERROR_MESSAGE);
             }
+        }
+    }
 
-            Point imagePosition = centerPoint(pageFormat, bi);
-            g2d.drawImage(bi, null, imagePosition.x, imagePosition.y);
+    private PrintConfig buildConfig(Controller controller, PageFormat pageFormat) {
+        PrintConfig config = new PrintConfig();
+        config.setPageFormat(pageFormat);
+        config.setFilename(filenameHint);
+        config.setAuthor(System.getProperty("user.name", ""));
+        config.setDate(LocalDate.now());
+        config.setIncludeTemplate(true);
+
+        BackendAPI backend = LookupService.lookup(BackendAPI.class);
+        if (backend != null && backend.getSettings() != null
+                && backend.getSettings().getPreferredUnits() != null) {
+            config.setDimensionsUnits(backend.getSettings().getPreferredUnits());
+        } else {
+            config.setDimensionsUnits(UnitUtils.Units.MM);
+        }
 
-            return Printable.PAGE_EXISTS;
-        });
+        Rectangle2D designBounds = controller.getDrawing().getRootEntity().getBounds();
+        config.setDesignWidthMm(designBounds.getWidth());
+        config.setDesignHeightMm(designBounds.getHeight());
+        return config;
+    }
 
-        if (job.printDialog()) {
+    /**
+     * Renders the current design to a {@link BufferedImage} at printer DPI.
+     *
+     * <p>Bypasses {@link Drawing#getImage()} because that method derives both image size and
+     * transform from {@code globalRoot.getBounds()}, which unions with empty controls anchored at
+     * the origin and silently clips designs whose minX/minY are non-zero. Here we own the bounds
+     * decision: when the design fits on a single page the image becomes page-sized with the
+     * design centered; otherwise the image matches the design bounds, so the grid clips and the
+     * page count is driven purely by the drawing extent.
+     */
+    private BufferedImage renderSourceImage(Controller controller, PrintConfig config) {
+        Drawing drawing = controller.getDrawing();
+        PageFormat pageFormat = config.getPageFormat();
+        double oldScale = drawing.getScale();
+        GridControl gridControl = drawing.getGridControl();
+
+        double pageWidthMm = pageFormat.getImageableWidth() * MM_PER_POINT;
+        double pageHeightMm = pageFormat.getImageableHeight() * MM_PER_POINT;
+        Rectangle2D designBounds = drawing.getRootEntity().getBounds();
+        Rectangle2D targetBounds = computeTargetBounds(designBounds, pageWidthMm, pageHeightMm);
+
+        double scale = MM_IN_INCH * PRINT_SYSTEM_DPI;
+        int imgWidth = Math.max(1, (int) Math.round(targetBounds.getWidth() * scale));
+        int imgHeight = Math.max(1, (int) Math.round(targetBounds.getHeight() * scale));
+
+        BufferedImage bi = new BufferedImage(imgWidth, imgHeight, BufferedImage.TYPE_INT_RGB);
+        Graphics2D g = bi.createGraphics();
+        try {
+            g.setColor(Color.WHITE);
+            g.fillRect(0, 0, imgWidth, imgHeight);
+            g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
+            g.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
+            g.setRenderingHint(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY);
+
+            // GridControl.drawLargeGridAndText reads getClipBounds() to skip off-image grid lines;
+            // it crashes if no clip is set. Set the clip in pixel space; once we apply the transform
+            // the clip becomes the design-space rectangle that maps to the full image.
+            g.setClip(0, 0, imgWidth, imgHeight);
+
+            // Map design (minX, minY) → pixel (0, imgHeight) and (maxX, maxY) → (imgWidth, 0).
+            AffineTransform tx = new AffineTransform();
+            tx.scale(1, -1);
+            tx.translate(0, -imgHeight);
+            tx.scale(scale, scale);
+            tx.translate(-targetBounds.getMinX(), -targetBounds.getMinY());
+            g.setTransform(tx);
+
+            drawing.setScale(scale);
             try {
-                job.print();
-            } catch (PrinterException exc) {
-                JOptionPane.showMessageDialog(null, "Error Printing: " + exc.getMessage(), "Error Printing!", JOptionPane.ERROR_MESSAGE);
+                gridControl.setPrintBoundsOverride(targetBounds);
+                try {
+                    gridControl.render(g, drawing);
+                } finally {
+                    gridControl.setPrintBoundsOverride(null);
+                }
+                for (Entity entity : drawing.getRootEntity().getChildren()) {
+                    entity.render(g, drawing);
+                }
+            } finally {
+                drawing.setScale(oldScale);
+                drawing.refresh();
             }
+        } finally {
+            g.dispose();
         }
+        return bi;
     }
 
+    private static Rectangle2D computeTargetBounds(Rectangle2D designBounds, double pageWidthMm, double pageHeightMm) {
+        double designW = designBounds.getWidth();
+        double designH = designBounds.getHeight();
+        if (designW <= pageWidthMm && designH <= pageHeightMm) {
+            // Single page — center a page-sized rectangle on the design's center so the design
+            // ends up centered within the rendered image.
+            double cx = (designBounds.getMinX() + designBounds.getMaxX()) / 2.0;
+            double cy = (designBounds.getMinY() + designBounds.getMaxY()) / 2.0;
+            return new Rectangle2D.Double(
+                    cx - pageWidthMm / 2.0, cy - pageHeightMm / 2.0, pageWidthMm, pageHeightMm);
+        }
+        // Multi-page — image matches design exactly so the grid clips at design bounds and the
+        // page count follows the drawing's actual extent.
+        return new Rectangle2D.Double(
+                designBounds.getMinX(), designBounds.getMinY(), designW, designH);
+    }
 }

ugs-designer/src/main/java/com/willwinder/ugs/designer/entities/entities/controls/GridControl.java

@@ -46,11 +46,22 @@ public class GridControl extends AbstractEntity implements Control {
     public static final int LARGE_GRID_SIZE = 100;
     public static final int SMALL_GRID_SIZE = 20;
     private final Controller controller;
+    private transient Rectangle2D printBoundsOverride;
 
     public GridControl(Controller controller) {
         this.controller = controller;
     }
 
+    /**
+     * When non-null, {@link #render} uses the supplied rectangle to size the grid instead of the
+     * design's content bounds. This makes the grid extend to page/template edges during printing.
+     * Must be called on the EDT; the caller is responsible for clearing it in a {@code finally}
+     * block so the on-screen rendering behaviour stays unchanged.
+     */
+    public void setPrintBoundsOverride(Rectangle2D bounds) {
+        this.printBoundsOverride = bounds;
+    }
+
     private static void drawZeroLines(Graphics2D graphics, Drawing drawing, int startPosX, int startPosY, int endPosX, int endPosY) {
         // Draw zero lines
         graphics.setStroke(new BasicStroke((float) (0.5 / drawing.getScale())));
@@ -117,7 +128,9 @@ public void render(Graphics2D graphics, Drawing drawing) {
         double gridSize = LARGE_GRID_SIZE;
 
 
-        Rectangle2D bounds = controller.getDrawing().getRootEntity().getBounds();
+        Rectangle2D bounds = printBoundsOverride != null
+                ? printBoundsOverride
+                : controller.getDrawing().getRootEntity().getBounds();
         double gridMargin = (gridSize * 100);
 
 
@@ -159,12 +172,17 @@ public Optional<Cursor> getHoverCursor() {
 
     @Override
     public Shape getShape() {
-        return new Rectangle();
+        return printBoundsOverride != null ? (Shape) printBoundsOverride.clone() : new Rectangle();
     }
 
     @Override
     public Shape getRelativeShape() {
-        return new Rectangle();
+        return printBoundsOverride != null ? (Shape) printBoundsOverride.clone() : new Rectangle();
+    }
+
+    @Override
+    public Rectangle2D getBounds() {
+        return printBoundsOverride != null ? (Rectangle2D) printBoundsOverride.clone() : super.getBounds();
     }
 
     @Override

ugs-designer/src/main/java/com/willwinder/ugs/designer/gui/Drawing.java

@@ -80,11 +80,14 @@ public class Drawing extends JPanel implements ISnapToGridListener {
     private transient DropHandler dropHandler;
     private transient DropTarget dropTarget;
 
+    private final transient GridControl gridControl;
+
     public Drawing(Controller controller) {
         refreshThrottler = new Throttler(this::refresh, 1000);
 
         globalRoot = new EntityGroup();
-        globalRoot.addChild(new GridControl(controller));
+        gridControl = new GridControl(controller);
+        globalRoot.addChild(gridControl);
         globalRoot.addListener(event -> refreshThrottler.run());
 
         entitiesRoot = new EntityGroup();
@@ -182,6 +185,10 @@ public EntityGroup getRootEntity() {
         return entitiesRoot;
     }
 
+    public GridControl getGridControl() {
+        return gridControl;
+    }
+
     private void recursiveCollectEntities(Entity shape, List<Entity> result) {
         if (shape instanceof EntityGroup entityGroup) {
             List<Entity> shapes = entityGroup.getChildren();