Browse Source

Add basic UFP writer plug-in

This already implements most of it. Just the thumbnail must still be gotten and put inside the container.

Contributes to issue CURA-4872.
Ghostkeeper 7 years ago
parent
commit
600e2abce1
3 changed files with 54 additions and 0 deletions
  1. 21 0
      plugins/UFPWriter/UFPWriter.py
  2. 25 0
      plugins/UFPWriter/__init__.py
  3. 8 0
      plugins/UFPWriter/plugin.json

+ 21 - 0
plugins/UFPWriter/UFPWriter.py

@@ -0,0 +1,21 @@
+#Copyright (c) 2018 Ultimaker B.V.
+#Cura is released under the terms of the LGPLv3 or higher.
+
+import charon
+
+from UM.Mesh.MeshWriter import MeshWriter #The writer we need to implement.
+from UM.PluginRegistry import PluginRegistry #To get the g-code writer.
+
+class UFPWriter(MeshWriter):
+    def write(self, stream, nodes, mode = MeshWriter.OutputMode.BinaryMode):
+        archive = charon.VirtualFile()
+        archive.open(stream, charon.OpenMode.WriteOnly)
+
+        #Store the g-code from the scene.
+        archive.addContentType(extension = "gcode", mime_type = "text/x-gcode")
+        gcode = archive.getStream("/3D/model.gcode")
+        PluginRegistry.getInstance().getPluginObject("GCodeWriter").write(gcode, None)
+        archive.addRelation(target = "/3D/model.gcode", file_type = "http://schemas.ultimaker.org/package/2018/relationships/gcode")
+
+        #Store the thumbnail.
+        #TODO

+ 25 - 0
plugins/UFPWriter/__init__.py

@@ -0,0 +1,25 @@
+#Copyright (c) 2018 Ultimaker B.V.
+#Cura is released under the terms of the LGPLv3 or higher.
+
+from . import UFPWriter
+from UM.i18n import i18nCatalog #To translate the file format description.
+from UM.Mesh.MeshWriter import MeshWriter #For the binary mode flag.
+
+i18n_catalog = i18nCatalog("cura")
+
+def getMetaData():
+    return {
+        "mesh_writer": {
+            "output": [
+                {
+                    "mime_type": "application/x-ufp",
+                    "mode": MeshWriter.OutputMode.BinaryMode,
+                    "extension": "ufp",
+                    "description": i18n_catalog.i18nc("@item:inlistbox", "Ultimaker Format Package")
+                }
+            ]
+        }
+    }
+
+def register(app):
+    return { "mesh_writer": UFPWriter.UFPWriter() }

+ 8 - 0
plugins/UFPWriter/plugin.json

@@ -0,0 +1,8 @@
+{
+    "name": "UFP Writer",
+    "author": "Ultimaker B.V.",
+    "version": "1.0.0",
+    "description": "Provides support for writing Ultimaker Format Packages.",
+    "api": 4,
+    "i18n-catalog": "cura"
+}