StartSliceJob.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  1. # Copyright (c) 2015 Ultimaker B.V.
  2. # Cura is released under the terms of the AGPLv3 or higher.
  3. import numpy
  4. from string import Formatter
  5. from enum import IntEnum
  6. from UM.Job import Job
  7. from UM.Application import Application
  8. from UM.Logger import Logger
  9. from UM.Scene.SceneNode import SceneNode
  10. from UM.Scene.Iterator.DepthFirstIterator import DepthFirstIterator
  11. from UM.Settings.Validator import ValidatorState
  12. from UM.Settings.SettingRelation import RelationType
  13. from cura.OneAtATimeIterator import OneAtATimeIterator
  14. import cura.Settings
  15. class StartJobResult(IntEnum):
  16. Finished = 1
  17. Error = 2
  18. SettingError = 3
  19. NothingToSlice = 4
  20. MaterialIncompatible = 5
  21. ## Formatter class that handles token expansion in start/end gcod
  22. class GcodeStartEndFormatter(Formatter):
  23. def get_value(self, key, args, kwargs): # [CodeStyle: get_value is an overridden function from the Formatter class]
  24. if isinstance(key, str):
  25. try:
  26. return kwargs[key]
  27. except KeyError:
  28. Logger.log("w", "Unable to replace '%s' placeholder in start/end gcode", key)
  29. return "{" + key + "}"
  30. else:
  31. Logger.log("w", "Incorrectly formatted placeholder '%s' in start/end gcode", key)
  32. return "{" + str(key) + "}"
  33. ## Job class that builds up the message of scene data to send to CuraEngine.
  34. class StartSliceJob(Job):
  35. def __init__(self, slice_message):
  36. super().__init__()
  37. self._scene = Application.getInstance().getController().getScene()
  38. self._slice_message = slice_message
  39. self._is_cancelled = False
  40. def getSliceMessage(self):
  41. return self._slice_message
  42. ## Check if a stack has any errors.
  43. ## returns true if it has errors, false otherwise.
  44. def _checkStackForErrors(self, stack):
  45. if stack is None:
  46. return False
  47. for key in stack.getAllKeys():
  48. validation_state = stack.getProperty(key, "validationState")
  49. if validation_state in (ValidatorState.Exception, ValidatorState.MaximumError, ValidatorState.MinimumError):
  50. Logger.log("w", "Setting %s is not valid, but %s. Aborting slicing.", key, validation_state)
  51. return True
  52. Job.yieldThread()
  53. return False
  54. ## Runs the job that initiates the slicing.
  55. def run(self):
  56. stack = Application.getInstance().getGlobalContainerStack()
  57. if not stack:
  58. self.setResult(StartJobResult.Error)
  59. return
  60. # Don't slice if there is a setting with an error value.
  61. if not Application.getInstance().getMachineManager().areStacksValid:
  62. self.setResult(StartJobResult.SettingError)
  63. return
  64. if Application.getInstance().getBuildVolume().hasErrors():
  65. self.setResult(StartJobResult.SettingError)
  66. return
  67. for extruder_stack in cura.Settings.ExtruderManager.getInstance().getMachineExtruders(stack.getId()):
  68. material = extruder_stack.findContainer({"type": "material"})
  69. if material:
  70. if material.getMetaDataEntry("compatible") == False:
  71. self.setResult(StartJobResult.MaterialIncompatible)
  72. return
  73. # Don't slice if there is a per object setting with an error value.
  74. for node in DepthFirstIterator(self._scene.getRoot()):
  75. if type(node) is not SceneNode or not node.isSelectable():
  76. continue
  77. if self._checkStackForErrors(node.callDecoration("getStack")):
  78. self.setResult(StartJobResult.SettingError)
  79. return
  80. with self._scene.getSceneLock():
  81. # Remove old layer data.
  82. for node in DepthFirstIterator(self._scene.getRoot()):
  83. if node.callDecoration("getLayerData"):
  84. node.getParent().removeChild(node)
  85. break
  86. # Get the objects in their groups to print.
  87. object_groups = []
  88. if stack.getProperty("print_sequence", "value") == "one_at_a_time":
  89. for node in OneAtATimeIterator(self._scene.getRoot()):
  90. temp_list = []
  91. # Node can't be printed, so don't bother sending it.
  92. if getattr(node, "_outside_buildarea", False):
  93. continue
  94. children = node.getAllChildren()
  95. children.append(node)
  96. for child_node in children:
  97. if type(child_node) is SceneNode and child_node.getMeshData() and child_node.getMeshData().getVertices() is not None:
  98. temp_list.append(child_node)
  99. if temp_list:
  100. object_groups.append(temp_list)
  101. Job.yieldThread()
  102. if len(object_groups) == 0:
  103. Logger.log("w", "No objects suitable for one at a time found, or no correct order found")
  104. else:
  105. temp_list = []
  106. for node in DepthFirstIterator(self._scene.getRoot()):
  107. if type(node) is SceneNode and node.getMeshData() and node.getMeshData().getVertices() is not None:
  108. if not getattr(node, "_outside_buildarea", False):
  109. temp_list.append(node)
  110. Job.yieldThread()
  111. if temp_list:
  112. object_groups.append(temp_list)
  113. # There are cases when there is nothing to slice. This can happen due to one at a time slicing not being
  114. # able to find a possible sequence or because there are no objects on the build plate (or they are outside
  115. # the build volume)
  116. if not object_groups:
  117. self.setResult(StartJobResult.NothingToSlice)
  118. return
  119. self._buildGlobalSettingsMessage(stack)
  120. self._buildGlobalInheritsStackMessage(stack)
  121. for extruder_stack in cura.Settings.ExtruderManager.getInstance().getMachineExtruders(stack.getId()):
  122. self._buildExtruderMessage(extruder_stack)
  123. for group in object_groups:
  124. group_message = self._slice_message.addRepeatedMessage("object_lists")
  125. if group[0].getParent().callDecoration("isGroup"):
  126. self._handlePerObjectSettings(group[0].getParent(), group_message)
  127. for object in group:
  128. mesh_data = object.getMeshData().getTransformed(object.getWorldTransformation())
  129. obj = group_message.addRepeatedMessage("objects")
  130. obj.id = id(object)
  131. verts = mesh_data.getVertices()
  132. indices = mesh_data.getIndices()
  133. if indices is not None:
  134. #TODO: This is a very slow way of doing it! It also locks up the GUI.
  135. verts = numpy.array([verts[vert_index] for face in indices for vert_index in face])
  136. else:
  137. verts = numpy.array(verts)
  138. # Convert from Y up axes to Z up axes. Equals a 90 degree rotation.
  139. verts[:, [1, 2]] = verts[:, [2, 1]]
  140. verts[:, 1] *= -1
  141. obj.vertices = verts
  142. self._handlePerObjectSettings(object, obj)
  143. Job.yieldThread()
  144. self.setResult(StartJobResult.Finished)
  145. def cancel(self):
  146. super().cancel()
  147. self._is_cancelled = True
  148. def isCancelled(self):
  149. return self._is_cancelled
  150. def _expandGcodeTokens(self, key, value, settings):
  151. try:
  152. # any setting can be used as a token
  153. fmt = GcodeStartEndFormatter()
  154. return str(fmt.format(value, **settings)).encode("utf-8")
  155. except:
  156. Logger.logException("w", "Unable to do token replacement on start/end gcode")
  157. return str(value).encode("utf-8")
  158. ## Create extruder message from stack
  159. def _buildExtruderMessage(self, stack):
  160. message = self._slice_message.addRepeatedMessage("extruders")
  161. message.id = int(stack.getMetaDataEntry("position"))
  162. material_instance_container = stack.findContainer({"type": "material"})
  163. for key in stack.getAllKeys():
  164. # Do not send settings that are not settable_per_extruder.
  165. if stack.getProperty(key, "settable_per_extruder") == False:
  166. continue
  167. setting = message.getMessage("settings").addRepeatedMessage("settings")
  168. setting.name = key
  169. if key == "material_guid" and material_instance_container:
  170. # Also send the material GUID. This is a setting in fdmprinter, but we have no interface for it.
  171. setting.value = str(material_instance_container.getMetaDataEntry("GUID", "")).encode("utf-8")
  172. else:
  173. setting.value = str(stack.getProperty(key, "value")).encode("utf-8")
  174. Job.yieldThread()
  175. ## Sends all global settings to the engine.
  176. #
  177. # The settings are taken from the global stack. This does not include any
  178. # per-extruder settings or per-object settings.
  179. def _buildGlobalSettingsMessage(self, stack):
  180. keys = stack.getAllKeys()
  181. settings = {}
  182. for key in keys:
  183. # Use resolvement value if available, or take the value
  184. resolved_value = stack.getProperty(key, "resolve")
  185. if resolved_value is not None:
  186. # There is a resolvement value. Check if we need to use it.
  187. user_container = stack.findContainer({"type": "user"})
  188. quality_changes_container = stack.findContainer({"type": "quality_changes"})
  189. if user_container.hasProperty(key,"value") or quality_changes_container.hasProperty(key,"value"):
  190. # Normal case
  191. settings[key] = stack.getProperty(key, "value")
  192. else:
  193. settings[key] = resolved_value
  194. else:
  195. # Normal case
  196. settings[key] = stack.getProperty(key, "value")
  197. start_gcode = settings["machine_start_gcode"]
  198. settings["material_bed_temp_prepend"] = "{material_bed_temperature}" not in start_gcode #Pre-compute material material_bed_temp_prepend and material_print_temp_prepend
  199. settings["material_print_temp_prepend"] = "{material_print_temperature}" not in start_gcode
  200. for key, value in settings.items(): #Add all submessages for each individual setting.
  201. setting_message = self._slice_message.getMessage("global_settings").addRepeatedMessage("settings")
  202. setting_message.name = key
  203. if key == "machine_start_gcode" or key == "machine_end_gcode": #If it's a g-code message, use special formatting.
  204. setting_message.value = self._expandGcodeTokens(key, value, settings)
  205. else:
  206. setting_message.value = str(value).encode("utf-8")
  207. ## Sends for some settings which extruder they should fallback to if not
  208. # set.
  209. #
  210. # This is only set for settings that have the limit_to_extruder
  211. # property.
  212. #
  213. # \param stack The global stack with all settings, from which to read the
  214. # limit_to_extruder property.
  215. def _buildGlobalInheritsStackMessage(self, stack):
  216. for key in stack.getAllKeys():
  217. extruder = int(round(float(stack.getProperty(key, "limit_to_extruder"))))
  218. if extruder >= 0: #Set to a specific extruder.
  219. setting_extruder = self._slice_message.addRepeatedMessage("limit_to_extruder")
  220. setting_extruder.name = key
  221. setting_extruder.extruder = extruder
  222. ## Check if a node has per object settings and ensure that they are set correctly in the message
  223. # \param node \type{SceneNode} Node to check.
  224. # \param message object_lists message to put the per object settings in
  225. def _handlePerObjectSettings(self, node, message):
  226. stack = node.callDecoration("getStack")
  227. # Check if the node has a stack attached to it and the stack has any settings in the top container.
  228. if stack:
  229. # Check all settings for relations, so we can also calculate the correct values for dependant settings.
  230. changed_setting_keys = set(stack.getTop().getAllKeys())
  231. for key in stack.getTop().getAllKeys():
  232. instance = stack.getTop().getInstance(key)
  233. self._addRelations(changed_setting_keys, instance.definition.relations)
  234. Job.yieldThread()
  235. # Ensure that the engine is aware what the build extruder is
  236. if stack.getProperty("machine_extruder_count", "value") > 1:
  237. changed_setting_keys.add("extruder_nr")
  238. # Get values for all changed settings
  239. for key in changed_setting_keys:
  240. setting = message.addRepeatedMessage("settings")
  241. setting.name = key
  242. setting.value = str(stack.getProperty(key, "value")).encode("utf-8")
  243. Job.yieldThread()
  244. ## Recursive function to put all settings that require eachother for value changes in a list
  245. # \param relations_set \type{set} Set of keys (strings) of settings that are influenced
  246. # \param relations list of relation objects that need to be checked.
  247. def _addRelations(self, relations_set, relations):
  248. for relation in filter(lambda r: r.role == "value", relations):
  249. if relation.type == RelationType.RequiresTarget:
  250. continue
  251. relations_set.add(relation.target.key)
  252. self._addRelations(relations_set, relation.target.relations)