Add sprite padding and clipping

Author: mimvoid

spritesheetExporter/spritesheet_exporter.py

@@ -27,6 +27,11 @@ class SpritesheetExporter:
     start: int
     end: int
 
+    pad_left: int
+    pad_top: int
+    pad_right: int
+    pad_bottom: int
+
     export_frame_sequence: bool
     custom_frames_dir: Optional[Path]
     base_name: str
@@ -172,8 +177,11 @@ def _copy_frames(self, src: Document, dest: Document):
         """
 
         root = dest.rootNode()
-        width = src.width()
-        height = src.height()
+
+        x = -self.pad_left
+        y = -self.pad_top
+        w = src.width() - x + self.pad_right
+        h = src.height() - y + self.pad_bottom
 
         pixel_set: Optional[set[QByteArray]] = set() if self.unique_frames else None
 
@@ -185,14 +193,16 @@ def _copy_frames(self, src: Document, dest: Document):
 
             # Export each visible layer
             for i, layer in enumerate(visible_layers):
+                pixel_data = layer.pixelData(x, y, w, h)
+
                 if pixel_set is not None:
-                    pixel_data = layer.pixelData(0, 0, width, height)
                     if pixel_data in pixel_set:
                         continue  # Got a non-unique frame
                     pixel_set.add(pixel_data)
 
-                clone_layer = dest.createCloneLayer(str(i), layer)
-                root.addChildNode(clone_layer, None)
+                new_layer = dest.createNode(str(i), "paintlayer")
+                new_layer.setPixelData(0, 0, w, h, pixel_data)
+                root.addChildNode(new_layer, None)
         else:
             if self.end == DEFAULT_TIME or self.start == DEFAULT_TIME:
                 self._set_frame_times(src)
@@ -206,15 +216,15 @@ def _copy_frames(self, src: Document, dest: Document):
 
                 # Ensure the time has been set before copying the pixel data
                 src.waitForDone()
-                pixel_data = src.pixelData(0, 0, width, height)
+                pixel_data = src.pixelData(x, y, w, h)
 
                 if pixel_set is not None:
                     if pixel_data in pixel_set:
                         continue  # Got a non-unique frame
                     pixel_set.add(pixel_data)
 
                 layer = dest.createNode(str(i), "paintlayer")
-                layer.setPixelData(pixel_data, 0, 0, width, height)
+                layer.setPixelData(pixel_data, 0, 0, w, h)
                 root.addChildNode(layer, None)
 
             src.setCurrentTime(initial_time)  # reset time
@@ -228,8 +238,8 @@ def _process_frames(self, src: Document, dest: Document):
         @param dest The document to contain the exported spritesheet
         """
 
-        width = src.width()
-        height = src.height()
+        width = src.width() + self.pad_left + self.pad_right
+        height = src.height() + self.pad_top + self.pad_bottom
 
         frames_dir = self._make_frames_dir() if self.export_frame_sequence else None
         texture_atlas = {"frames": []} if self.write_texture_atlas else None
@@ -287,8 +297,8 @@ def export(self, debug=False):
             print("spritesheetExporter: Export spritesheet start.")
 
         # Current document info to use for the new document
-        width = doc.width()
-        height = doc.height()
+        width = doc.width() + self.pad_left + self.pad_right
+        height = doc.height() + self.pad_top + self.pad_bottom
 
         if debug:
             print(

spritesheetExporter/ui.py

@@ -230,24 +230,59 @@ def apply_settings(self, exporter: SpritesheetExporter):
         exporter.step = self.step.value()
 
 
+class EdgePadding(QFormLayout):
+    """
+    Sets the padding (or clipping) of sprites.
+    """
+
+    def __init__(self):
+        super().__init__()
+
+        self.left = self._make_spin_box("left")
+        self.top = self._make_spin_box("top")
+        self.right = self._make_spin_box("right")
+        self.bottom = self._make_spin_box("bottom")
+
+        self.addRow("Padding left:", self.left)
+        self.addRow("Padding top:", self.top)
+        self.addRow("Padding right:", self.right)
+        self.addRow("Padding bottom:", self.bottom)
+
+    def apply_settings(self, exp: SpritesheetExporter) -> None:
+        exp.pad_left = self.left.value()
+        exp.pad_top = self.top.value()
+        exp.pad_right = self.right.value()
+        exp.pad_bottom = self.bottom.value()
+
+    @staticmethod
+    def _make_spin_box(edge: str) -> QSpinBox:
+        spin_box = QSpinBox(value=0, minimum=-99, maximum=99)
+        spin_box.setSuffix("px")
+        spin_box.setToolTip(
+            f"Pads the {edge} edge of each sprite, or clips it if negative"
+        )
+        return spin_box
+
+
 class UISpritesheetExporter:
     exporter = SpritesheetExporter()
     dialog = QDialog()  # the main window
 
     common_settings = CommonSettings()
     frames = FramesExport()
+    edges = EdgePadding()
 
     # Extra settings group
     layers_as_animation = QCheckBox("Use layers as animation frames")
     placement = SpritePlacement()
-    spin_boxes = SpinBoxes()
+    frame_times = SpinBoxes()
 
     dialog_buttons = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
 
     def __init__(self):
         self.dialog.setWindowTitle(i18n("SpritesheetExporter"))
         self.dialog.setWindowModality(Qt.NonModal)  # Don't block input to other windows
-        self.dialog.setMinimumSize(425, 450)
+        self.dialog.setMinimumSize(425, 480)
         self.dialog.setSizeGripEnabled(True)
 
         self.common_settings.change_dir.clicked.connect(self.change_export_dir)
@@ -264,6 +299,10 @@ def __init__(self):
         self.dialog_buttons.rejected.connect(self.dialog.close)
 
         # Setup layouts
+        spin_boxes = QHBoxLayout()
+        spin_boxes.addLayout(self.frame_times)
+        spin_boxes.addLayout(self.edges)
+
         extra_settings = QGroupBox("Extra Settings")
         extra_settings.setCheckable(True)
         extra_settings.setChecked(False)
@@ -273,7 +312,7 @@ def __init__(self):
         extras.addSpacing(10)
         extras.addLayout(self.placement)
         extras.addSpacing(10)
-        extras.addLayout(self.spin_boxes)
+        extras.addLayout(spin_boxes)
 
         root_layout = QVBoxLayout(self.dialog)  # the box holding everything
         root_layout.addLayout(self.common_settings)
@@ -342,7 +381,8 @@ def confirm_button(self):
         self.common_settings.apply_settings(self.exporter)
         self.frames.apply_settings(self.exporter)
         self.placement.apply_settings(self.exporter)
-        self.spin_boxes.apply_settings(self.exporter)
+        self.frame_times.apply_settings(self.exporter)
+        self.edges.apply_settings(self.exporter)
         self.exporter.layers_as_animation = self.layers_as_animation.isChecked()
 
         self.exporter.export()