Write group content metadata for ufp export

CURA-6915

plugins/UFPWriter/UFPWriter.py

@@ -1,18 +1,19 @@
-#Copyright (c) 2020 Ultimaker B.V.
+# Copyright (c) 2020 Ultimaker B.V.
-#Cura is released under the terms of the LGPLv3 or higher.
+# Cura is released under the terms of the LGPLv3 or higher.
 
-from typing import cast
+from typing import cast, List, Dict
 
-from Charon.VirtualFile import VirtualFile #To open UFP files.
+from Charon.VirtualFile import VirtualFile  # To open UFP files.
-from Charon.OpenMode import OpenMode #To indicate that we want to write to UFP files.
+from Charon.OpenMode import OpenMode  # To indicate that we want to write to UFP files.
-from io import StringIO #For converting g-code to bytes.
+from io import StringIO  # For converting g-code to bytes.
 
 from UM.Logger import Logger
-from UM.Mesh.MeshWriter import MeshWriter #The writer we need to implement.
+from UM.Mesh.MeshWriter import MeshWriter  # The writer we need to implement.
 from UM.MimeTypeDatabase import MimeTypeDatabase, MimeType
-from UM.PluginRegistry import PluginRegistry #To get the g-code writer.
+from UM.PluginRegistry import PluginRegistry  # To get the g-code writer.
 from PyQt5.QtCore import QBuffer
 
+from UM.Scene.SceneNode import SceneNode
 from cura.CuraApplication import CuraApplication
 from cura.Snapshot import Snapshot
 from cura.Utils.Threading import call_on_qt_thread
@@ -26,13 +27,13 @@ catalog = i18nCatalog("cura")
 
 class UFPWriter(MeshWriter):
     def __init__(self):
-        super().__init__(add_to_recent_files = False)
+        super().__init__(add_to_recent_files=False)
 
         MimeTypeDatabase.addMimeType(
             MimeType(
-                name = "application/x-ufp",
+                name="application/x-ufp",
-                comment = "Ultimaker Format Package",
+                comment="Ultimaker Format Package",
-                suffixes = ["ufp"]
+                suffixes=["ufp"]
             )
         )
 
@@ -42,7 +43,7 @@ class UFPWriter(MeshWriter):
         # must be called from the main thread because of OpenGL
         Logger.log("d", "Creating thumbnail image...")
         try:
-            self._snapshot = Snapshot.snapshot(width = 300, height = 300)
+            self._snapshot = Snapshot.snapshot(width=300, height=300)
         except Exception:
             Logger.logException("w", "Failed to create snapshot image")
             self._snapshot = None  # Failing to create thumbnail should not fail creation of UFP
@@ -52,29 +53,30 @@ class UFPWriter(MeshWriter):
     # Qt thread. The File read/write operations right now are executed on separated threads because they are scheduled
     # by the Job class.
     @call_on_qt_thread
-    def write(self, stream, nodes, mode = MeshWriter.OutputMode.BinaryMode):
+    def write(self, stream, nodes, mode=MeshWriter.OutputMode.BinaryMode):
         archive = VirtualFile()
         archive.openStream(stream, "application/x-ufp", OpenMode.WriteOnly)
 
         self._writeObjectList(archive)
 
-        #Store the g-code from the scene.
+        # Store the g-code from the scene.
-        archive.addContentType(extension = "gcode", mime_type = "text/x-gcode")
+        archive.addContentType(extension="gcode", mime_type="text/x-gcode")
-        gcode_textio = StringIO() #We have to convert the g-code into bytes.
+        gcode_textio = StringIO()  # We have to convert the g-code into bytes.
         gcode_writer = cast(MeshWriter, PluginRegistry.getInstance().getPluginObject("GCodeWriter"))
         success = gcode_writer.write(gcode_textio, None)
-        if not success: #Writing the g-code failed. Then I can also not write the gzipped g-code.
+        if not success:  # Writing the g-code failed. Then I can also not write the gzipped g-code.
             self.setInformation(gcode_writer.getInformation())
             return False
         gcode = archive.getStream("/3D/model.gcode")
         gcode.write(gcode_textio.getvalue().encode("UTF-8"))
-        archive.addRelation(virtual_path = "/3D/model.gcode", relation_type = "http://schemas.ultimaker.org/package/2018/relationships/gcode")
+        archive.addRelation(virtual_path="/3D/model.gcode",
+                            relation_type="http://schemas.ultimaker.org/package/2018/relationships/gcode")
 
         self._createSnapshot()
 
-        #Store the thumbnail.
+        # Store the thumbnail.
         if self._snapshot:
-            archive.addContentType(extension = "png", mime_type = "image/png")
+            archive.addContentType(extension="png", mime_type="image/png")
             thumbnail = archive.getStream("/Metadata/thumbnail.png")
 
             thumbnail_buffer = QBuffer()
@@ -83,7 +85,9 @@ class UFPWriter(MeshWriter):
             thumbnail_image.save(thumbnail_buffer, "PNG")
 
             thumbnail.write(thumbnail_buffer.data())
-            archive.addRelation(virtual_path = "/Metadata/thumbnail.png", relation_type = "http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail", origin = "/3D/model.gcode")
+            archive.addRelation(virtual_path="/Metadata/thumbnail.png",
+                                relation_type="http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail",
+                                origin="/3D/model.gcode")
         else:
             Logger.log("d", "Thumbnail not created, cannot save it")
 
@@ -97,7 +101,7 @@ class UFPWriter(MeshWriter):
         material_mime_type = "application/x-ultimaker-material-profile"
 
         try:
-            archive.addContentType(extension = material_extension, mime_type = material_mime_type)
+            archive.addContentType(extension=material_extension, mime_type=material_mime_type)
         except:
             Logger.log("w", "The material extension: %s was already added", material_extension)
 
@@ -116,9 +120,10 @@ class UFPWriter(MeshWriter):
                 continue
 
             material_root_id = material.getMetaDataEntry("base_file")
-            material_root_query = container_registry.findContainers(id = material_root_id)
+            material_root_query = container_registry.findContainers(id=material_root_id)
             if not material_root_query:
-                Logger.log("e", "Cannot find material container with root id {root_id}".format(root_id = material_root_id))
+                Logger.log("e",
+                           "Cannot find material container with root id {root_id}".format(root_id=material_root_id))
                 return False
             material_container = material_root_query[0]
 
@@ -130,9 +135,9 @@ class UFPWriter(MeshWriter):
 
             material_file = archive.getStream(material_file_name)
             material_file.write(serialized_material.encode("UTF-8"))
-            archive.addRelation(virtual_path = material_file_name,
+            archive.addRelation(virtual_path=material_file_name,
-                                relation_type = "http://schemas.ultimaker.org/package/2018/relationships/material",
+                                relation_type="http://schemas.ultimaker.org/package/2018/relationships/material",
-                                origin = "/3D/model.gcode")
+                                origin="/3D/model.gcode")
 
             added_materials.append(material_file_name)
 
@@ -151,11 +156,30 @@ class UFPWriter(MeshWriter):
 
         To retrieve, use: `archive.getMetadata(METADATA_OBJECTS_PATH)`
         """
+
         objects_model = CuraApplication.getInstance().getObjectsModel()
-        object_metas = [{"name": item["name"]}
+        object_metas = []
-                        for item in objects_model.items
+
-                        if item["node"].getMeshData() is not None and not item["node"].callDecoration("isNonPrintingMesh")
+        for item in objects_model.items:
-                        ]
+            object_metas = object_metas + UFPWriter._getObjectMetas(item["node"])
 
         data = {METADATA_OBJECTS_PATH: object_metas}
         archive.setMetadata(data)
+
+    @staticmethod
+    def _getObjectMetas(node: SceneNode) -> List[Dict]:
+        """Get object metadata to write for a Node.
+
+        :return: List of object metadata dictionaries.
+                 Might contain > 1 element in case of a group node.
+                 Might be empty in case of nonPrintingMesh
+        """
+
+        nodes = [node]
+        if node.callDecoration("isGroup"):
+            nodes = nodes + node.getAllChildren()  # all descendants
+
+        return [{"name": item.getName()}
+                for item in nodes
+                if item.getMeshData() is not None and not item.callDecoration("isNonPrintingMesh")
+                ]