ThreeMFReader.py 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. # Copyright (c) 2015 Ultimaker B.V.
  2. # Cura is released under the terms of the AGPLv3 or higher.
  3. from UM.Mesh.MeshReader import MeshReader
  4. from UM.Mesh.MeshBuilder import MeshBuilder
  5. from UM.Logger import Logger
  6. from UM.Math.Matrix import Matrix
  7. from UM.Math.Vector import Vector
  8. from UM.Scene.SceneNode import SceneNode
  9. from UM.Scene.GroupDecorator import GroupDecorator
  10. import UM.Application
  11. from UM.Job import Job
  12. import os.path
  13. import zipfile
  14. try:
  15. import xml.etree.cElementTree as ET
  16. except ImportError:
  17. import xml.etree.ElementTree as ET
  18. ## Base implementation for reading 3MF files. Has no support for textures. Only loads meshes!
  19. class ThreeMFReader(MeshReader):
  20. def __init__(self):
  21. super().__init__()
  22. self._supported_extensions = [".3mf"]
  23. self._root = None
  24. self._namespaces = {
  25. "3mf": "http://schemas.microsoft.com/3dmanufacturing/core/2015/02",
  26. "cura": "http://software.ultimaker.com/xml/cura/3mf/2015/10"
  27. }
  28. self._base_name = ""
  29. self._unit = None
  30. def _createNodeFromObject(self, object, name = ""):
  31. node = SceneNode()
  32. node.setName(name)
  33. mesh_builder = MeshBuilder()
  34. vertex_list = []
  35. components = object.find(".//3mf:components", self._namespaces)
  36. if components:
  37. for component in components:
  38. id = component.get("objectid")
  39. new_object = self._root.find("./3mf:resources/3mf:object[@id='{0}']".format(id), self._namespaces)
  40. new_node = self._createNodeFromObject(new_object, self._base_name + "_" + str(id))
  41. node.addChild(new_node)
  42. transform = component.get("transform")
  43. if transform is not None:
  44. new_node.setTransformation(self._createMatrixFromTransformationString(transform))
  45. # for vertex in entry.mesh.vertices.vertex:
  46. for vertex in object.findall(".//3mf:vertex", self._namespaces):
  47. vertex_list.append([vertex.get("x"), vertex.get("y"), vertex.get("z")])
  48. Job.yieldThread()
  49. if len(node.getChildren()) > 0:
  50. group_decorator = GroupDecorator()
  51. node.addDecorator(group_decorator)
  52. triangles = object.findall(".//3mf:triangle", self._namespaces)
  53. mesh_builder.reserveFaceCount(len(triangles))
  54. for triangle in triangles:
  55. v1 = int(triangle.get("v1"))
  56. v2 = int(triangle.get("v2"))
  57. v3 = int(triangle.get("v3"))
  58. mesh_builder.addFaceByPoints(vertex_list[v1][0], vertex_list[v1][1], vertex_list[v1][2],
  59. vertex_list[v2][0], vertex_list[v2][1], vertex_list[v2][2],
  60. vertex_list[v3][0], vertex_list[v3][1], vertex_list[v3][2])
  61. Job.yieldThread()
  62. # TODO: We currently do not check for normals and simply recalculate them.
  63. mesh_builder.calculateNormals()
  64. mesh_builder.setFileName(name)
  65. mesh_data = mesh_builder.build()
  66. if len(mesh_data.getVertices()):
  67. node.setMeshData(mesh_data)
  68. node.setSelectable(True)
  69. return node
  70. def _createMatrixFromTransformationString(self, transformation):
  71. splitted_transformation = transformation.split()
  72. ## Transformation is saved as:
  73. ## M00 M01 M02 0.0
  74. ## M10 M11 M12 0.0
  75. ## M20 M21 M22 0.0
  76. ## M30 M31 M32 1.0
  77. ## We switch the row & cols as that is how everyone else uses matrices!
  78. temp_mat = Matrix()
  79. # Rotation & Scale
  80. temp_mat._data[0, 0] = splitted_transformation[0]
  81. temp_mat._data[1, 0] = splitted_transformation[1]
  82. temp_mat._data[2, 0] = splitted_transformation[2]
  83. temp_mat._data[0, 1] = splitted_transformation[3]
  84. temp_mat._data[1, 1] = splitted_transformation[4]
  85. temp_mat._data[2, 1] = splitted_transformation[5]
  86. temp_mat._data[0, 2] = splitted_transformation[6]
  87. temp_mat._data[1, 2] = splitted_transformation[7]
  88. temp_mat._data[2, 2] = splitted_transformation[8]
  89. # Translation
  90. temp_mat._data[0, 3] = splitted_transformation[9]
  91. temp_mat._data[1, 3] = splitted_transformation[10]
  92. temp_mat._data[2, 3] = splitted_transformation[11]
  93. return temp_mat
  94. def read(self, file_name):
  95. result = SceneNode()
  96. # The base object of 3mf is a zipped archive.
  97. archive = zipfile.ZipFile(file_name, "r")
  98. self._base_name = os.path.basename(file_name)
  99. try:
  100. self._root = ET.parse(archive.open("3D/3dmodel.model"))
  101. self._unit = self._root.getroot().get("unit")
  102. build_items = self._root.findall("./3mf:build/3mf:item", self._namespaces)
  103. for build_item in build_items:
  104. id = build_item.get("objectid")
  105. object = self._root.find("./3mf:resources/3mf:object[@id='{0}']".format(id), self._namespaces)
  106. build_item_node = self._createNodeFromObject(object, self._base_name + "_" + str(id))
  107. transform = build_item.get("transform")
  108. if transform is not None:
  109. build_item_node.setTransformation(self._createMatrixFromTransformationString(transform))
  110. result.addChild(build_item_node)
  111. except Exception as e:
  112. Logger.log("e", "exception occured in 3mf reader: %s", e)
  113. try: # Selftest - There might be more functions that should fail
  114. bounding_box = result.getBoundingBox()
  115. bounding_box.isValid()
  116. except:
  117. return None
  118. global_container_stack = UM.Application.getInstance().getGlobalContainerStack()
  119. flip_matrix = Matrix()
  120. flip_matrix._data[1, 1] = 0
  121. flip_matrix._data[1, 2] = 1
  122. flip_matrix._data[2, 1] = -1
  123. flip_matrix._data[2, 2] = 0
  124. result.setTransformation(flip_matrix)
  125. if global_container_stack:
  126. translation = Vector(x=-global_container_stack.getProperty("machine_width", "value") / 2, z=0,
  127. y=-global_container_stack.getProperty("machine_depth", "value") / 2)
  128. result.translate(translation)
  129. result.scale(self._getScaleFromUnit(self._unit))
  130. result.setEnabled(False) # The result should not be moved in any way, so disable it.
  131. return result
  132. ## Create a scale vector based on a unit string.
  133. # The core spec defines the following:
  134. # * micron
  135. # * millimeter (default)
  136. # * centimeter
  137. # * inch
  138. # * foot
  139. # * meter
  140. def _getScaleFromUnit(self, unit):
  141. if unit is None:
  142. unit = "millimeter"
  143. if unit == "micron":
  144. scale = 0.001
  145. elif unit == "millimeter":
  146. scale = 1
  147. elif unit == "centimeter":
  148. scale = 10
  149. elif unit == "inch":
  150. scale = 25.4
  151. elif unit == "foot":
  152. scale = 304.8
  153. elif unit == "meter":
  154. scale = 1000
  155. else:
  156. Logger.log("w", "Unrecognised unit %s used. Assuming mm instead", unit)
  157. scale = 1
  158. return Vector(scale, scale, scale)