StartSliceJob.py 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  1. # Copyright (c) 2017 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. import numpy
  4. from string import Formatter
  5. from enum import IntEnum
  6. import time
  7. import re
  8. from UM.Job import Job
  9. from UM.Application import Application
  10. from UM.Logger import Logger
  11. from UM.Scene.Iterator.DepthFirstIterator import DepthFirstIterator
  12. from UM.Settings.Validator import ValidatorState
  13. from UM.Settings.SettingRelation import RelationType
  14. from cura.Scene.CuraSceneNode import CuraSceneNode
  15. from cura.OneAtATimeIterator import OneAtATimeIterator
  16. from cura.Settings.ExtruderManager import ExtruderManager
  17. NON_PRINTING_MESH_SETTINGS = ["anti_overhang_mesh", "infill_mesh", "cutting_mesh"]
  18. class StartJobResult(IntEnum):
  19. Finished = 1
  20. Error = 2
  21. SettingError = 3
  22. NothingToSlice = 4
  23. MaterialIncompatible = 5
  24. BuildPlateError = 6
  25. ObjectSettingError = 7 #When an error occurs in per-object settings.
  26. ## Formatter class that handles token expansion in start/end gcod
  27. class GcodeStartEndFormatter(Formatter):
  28. def get_value(self, key, args, kwargs): # [CodeStyle: get_value is an overridden function from the Formatter class]
  29. # The kwargs dictionary contains a dictionary for each stack (with a string of the extruder_nr as their key),
  30. # and a default_extruder_nr to use when no extruder_nr is specified
  31. if isinstance(key, str):
  32. try:
  33. extruder_nr = kwargs["default_extruder_nr"]
  34. except ValueError:
  35. extruder_nr = -1
  36. key_fragments = [fragment.strip() for fragment in key.split(',')]
  37. if len(key_fragments) == 2:
  38. try:
  39. extruder_nr = int(key_fragments[1])
  40. except ValueError:
  41. try:
  42. extruder_nr = int(kwargs["-1"][key_fragments[1]]) # get extruder_nr values from the global stack
  43. except (KeyError, ValueError):
  44. # either the key does not exist, or the value is not an int
  45. Logger.log("w", "Unable to determine stack nr '%s' for key '%s' in start/end gcode, using global stack", key_fragments[1], key_fragments[0])
  46. elif len(key_fragments) != 1:
  47. Logger.log("w", "Incorrectly formatted placeholder '%s' in start/end gcode", key)
  48. return "{" + str(key) + "}"
  49. key = key_fragments[0]
  50. try:
  51. return kwargs[str(extruder_nr)][key]
  52. except KeyError:
  53. Logger.log("w", "Unable to replace '%s' placeholder in start/end gcode", key)
  54. return "{" + key + "}"
  55. else:
  56. Logger.log("w", "Incorrectly formatted placeholder '%s' in start/end gcode", key)
  57. return "{" + str(key) + "}"
  58. ## Job class that builds up the message of scene data to send to CuraEngine.
  59. class StartSliceJob(Job):
  60. def __init__(self, slice_message):
  61. super().__init__()
  62. self._scene = Application.getInstance().getController().getScene()
  63. self._slice_message = slice_message
  64. self._is_cancelled = False
  65. self._build_plate_number = None
  66. self._all_extruders_settings = None # cache for all setting values from all stacks (global & extruder) for the current machine
  67. def getSliceMessage(self):
  68. return self._slice_message
  69. def setBuildPlate(self, build_plate_number):
  70. self._build_plate_number = build_plate_number
  71. ## Check if a stack has any errors.
  72. ## returns true if it has errors, false otherwise.
  73. def _checkStackForErrors(self, stack):
  74. if stack is None:
  75. return False
  76. for key in stack.getAllKeys():
  77. validation_state = stack.getProperty(key, "validationState")
  78. if validation_state in (ValidatorState.Exception, ValidatorState.MaximumError, ValidatorState.MinimumError):
  79. Logger.log("w", "Setting %s is not valid, but %s. Aborting slicing.", key, validation_state)
  80. return True
  81. Job.yieldThread()
  82. return False
  83. ## Runs the job that initiates the slicing.
  84. def run(self):
  85. if self._build_plate_number is None:
  86. self.setResult(StartJobResult.Error)
  87. return
  88. stack = Application.getInstance().getGlobalContainerStack()
  89. if not stack:
  90. self.setResult(StartJobResult.Error)
  91. return
  92. # Don't slice if there is a setting with an error value.
  93. if Application.getInstance().getMachineManager().stacksHaveErrors:
  94. self.setResult(StartJobResult.SettingError)
  95. return
  96. if Application.getInstance().getBuildVolume().hasErrors():
  97. self.setResult(StartJobResult.BuildPlateError)
  98. return
  99. # Don't slice if the buildplate or the nozzle type is incompatible with the materials
  100. if not Application.getInstance().getMachineManager().variantBuildplateCompatible and \
  101. not Application.getInstance().getMachineManager().variantBuildplateUsable:
  102. self.setResult(StartJobResult.MaterialIncompatible)
  103. return
  104. for extruder_stack in ExtruderManager.getInstance().getMachineExtruders(stack.getId()):
  105. material = extruder_stack.findContainer({"type": "material"})
  106. if material:
  107. if material.getMetaDataEntry("compatible") == False:
  108. self.setResult(StartJobResult.MaterialIncompatible)
  109. return
  110. # Don't slice if there is a per object setting with an error value.
  111. for node in DepthFirstIterator(self._scene.getRoot()):
  112. if node.isSelectable():
  113. continue
  114. if self._checkStackForErrors(node.callDecoration("getStack")):
  115. self.setResult(StartJobResult.ObjectSettingError)
  116. return
  117. with self._scene.getSceneLock():
  118. # Remove old layer data.
  119. for node in DepthFirstIterator(self._scene.getRoot()):
  120. if node.callDecoration("getLayerData") and node.callDecoration("getBuildPlateNumber") == self._build_plate_number:
  121. node.getParent().removeChild(node)
  122. break
  123. # Get the objects in their groups to print.
  124. object_groups = []
  125. if stack.getProperty("print_sequence", "value") == "one_at_a_time":
  126. for node in OneAtATimeIterator(self._scene.getRoot()):
  127. temp_list = []
  128. # Node can't be printed, so don't bother sending it.
  129. if getattr(node, "_outside_buildarea", False):
  130. continue
  131. # Filter on current build plate
  132. build_plate_number = node.callDecoration("getBuildPlateNumber")
  133. if build_plate_number is not None and build_plate_number != self._build_plate_number:
  134. continue
  135. children = node.getAllChildren()
  136. children.append(node)
  137. for child_node in children:
  138. if child_node.getMeshData() and child_node.getMeshData().getVertices() is not None:
  139. temp_list.append(child_node)
  140. if temp_list:
  141. object_groups.append(temp_list)
  142. Job.yieldThread()
  143. if len(object_groups) == 0:
  144. Logger.log("w", "No objects suitable for one at a time found, or no correct order found")
  145. else:
  146. temp_list = []
  147. has_printing_mesh = False
  148. for node in DepthFirstIterator(self._scene.getRoot()):
  149. if node.callDecoration("isSliceable") and node.getMeshData() and node.getMeshData().getVertices() is not None:
  150. per_object_stack = node.callDecoration("getStack")
  151. is_non_printing_mesh = False
  152. if per_object_stack:
  153. is_non_printing_mesh = any(per_object_stack.getProperty(key, "value") for key in NON_PRINTING_MESH_SETTINGS)
  154. if node.callDecoration("getBuildPlateNumber") == self._build_plate_number:
  155. if not getattr(node, "_outside_buildarea", False) or is_non_printing_mesh:
  156. temp_list.append(node)
  157. if not is_non_printing_mesh:
  158. has_printing_mesh = True
  159. Job.yieldThread()
  160. #If the list doesn't have any model with suitable settings then clean the list
  161. # otherwise CuraEngine will crash
  162. if not has_printing_mesh:
  163. temp_list.clear()
  164. if temp_list:
  165. object_groups.append(temp_list)
  166. # There are cases when there is nothing to slice. This can happen due to one at a time slicing not being
  167. # able to find a possible sequence or because there are no objects on the build plate (or they are outside
  168. # the build volume)
  169. if not object_groups:
  170. self.setResult(StartJobResult.NothingToSlice)
  171. return
  172. self._buildGlobalSettingsMessage(stack)
  173. self._buildGlobalInheritsStackMessage(stack)
  174. # Build messages for extruder stacks
  175. for extruder_stack in ExtruderManager.getInstance().getMachineExtruders(stack.getId()):
  176. self._buildExtruderMessage(extruder_stack)
  177. for group in object_groups:
  178. group_message = self._slice_message.addRepeatedMessage("object_lists")
  179. if group[0].getParent().callDecoration("isGroup"):
  180. self._handlePerObjectSettings(group[0].getParent(), group_message)
  181. for object in group:
  182. mesh_data = object.getMeshData()
  183. rot_scale = object.getWorldTransformation().getTransposed().getData()[0:3, 0:3]
  184. translate = object.getWorldTransformation().getData()[:3, 3]
  185. # This effectively performs a limited form of MeshData.getTransformed that ignores normals.
  186. verts = mesh_data.getVertices()
  187. verts = verts.dot(rot_scale)
  188. verts += translate
  189. # Convert from Y up axes to Z up axes. Equals a 90 degree rotation.
  190. verts[:, [1, 2]] = verts[:, [2, 1]]
  191. verts[:, 1] *= -1
  192. obj = group_message.addRepeatedMessage("objects")
  193. obj.id = id(object)
  194. indices = mesh_data.getIndices()
  195. if indices is not None:
  196. flat_verts = numpy.take(verts, indices.flatten(), axis=0)
  197. else:
  198. flat_verts = numpy.array(verts)
  199. obj.vertices = flat_verts
  200. self._handlePerObjectSettings(object, obj)
  201. Job.yieldThread()
  202. self.setResult(StartJobResult.Finished)
  203. def cancel(self):
  204. super().cancel()
  205. self._is_cancelled = True
  206. def isCancelled(self):
  207. return self._is_cancelled
  208. ## Creates a dictionary of tokens to replace in g-code pieces.
  209. #
  210. # This indicates what should be replaced in the start and end g-codes.
  211. # \param stack The stack to get the settings from to replace the tokens
  212. # with.
  213. # \return A dictionary of replacement tokens to the values they should be
  214. # replaced with.
  215. def _buildReplacementTokens(self, stack) -> dict:
  216. result = {}
  217. for key in stack.getAllKeys():
  218. result[key] = stack.getProperty(key, "value")
  219. Job.yieldThread()
  220. result["print_bed_temperature"] = result["material_bed_temperature"] # Renamed settings.
  221. result["print_temperature"] = result["material_print_temperature"]
  222. result["time"] = time.strftime("%H:%M:%S") #Some extra settings.
  223. result["date"] = time.strftime("%d-%m-%Y")
  224. result["day"] = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"][int(time.strftime("%w"))]
  225. initial_extruder_stack = Application.getInstance().getExtruderManager().getUsedExtruderStacks()[0]
  226. initial_extruder_nr = initial_extruder_stack.getProperty("extruder_nr", "value")
  227. result["initial_extruder_nr"] = initial_extruder_nr
  228. return result
  229. ## Replace setting tokens in a piece of g-code.
  230. # \param value A piece of g-code to replace tokens in.
  231. # \param default_extruder_nr Stack nr to use when no stack nr is specified, defaults to the global stack
  232. def _expandGcodeTokens(self, value: str, default_extruder_nr: int = -1):
  233. if not self._all_extruders_settings:
  234. global_stack = Application.getInstance().getGlobalContainerStack()
  235. # NB: keys must be strings for the string formatter
  236. self._all_extruders_settings = {
  237. "-1": self._buildReplacementTokens(global_stack)
  238. }
  239. for extruder_stack in ExtruderManager.getInstance().getMachineExtruders(global_stack.getId()):
  240. extruder_nr = extruder_stack.getProperty("extruder_nr", "value")
  241. self._all_extruders_settings[str(extruder_nr)] = self._buildReplacementTokens(extruder_stack)
  242. try:
  243. # any setting can be used as a token
  244. fmt = GcodeStartEndFormatter()
  245. settings = self._all_extruders_settings.copy()
  246. settings["default_extruder_nr"] = default_extruder_nr
  247. return str(fmt.format(value, **settings))
  248. except:
  249. Logger.logException("w", "Unable to do token replacement on start/end gcode")
  250. return str(value)
  251. ## Create extruder message from stack
  252. def _buildExtruderMessage(self, stack):
  253. message = self._slice_message.addRepeatedMessage("extruders")
  254. message.id = int(stack.getMetaDataEntry("position"))
  255. settings = self._buildReplacementTokens(stack)
  256. # Also send the material GUID. This is a setting in fdmprinter, but we have no interface for it.
  257. settings["material_guid"] = stack.material.getMetaDataEntry("GUID", "")
  258. # Replace the setting tokens in start and end g-code.
  259. extruder_nr = stack.getProperty("extruder_nr", "value")
  260. settings["machine_extruder_start_code"] = self._expandGcodeTokens(settings["machine_extruder_start_code"], extruder_nr)
  261. settings["machine_extruder_end_code"] = self._expandGcodeTokens(settings["machine_extruder_end_code"], extruder_nr)
  262. for key, value in settings.items():
  263. # Do not send settings that are not settable_per_extruder.
  264. if not stack.getProperty(key, "settable_per_extruder"):
  265. continue
  266. setting = message.getMessage("settings").addRepeatedMessage("settings")
  267. setting.name = key
  268. setting.value = str(value).encode("utf-8")
  269. Job.yieldThread()
  270. ## Sends all global settings to the engine.
  271. #
  272. # The settings are taken from the global stack. This does not include any
  273. # per-extruder settings or per-object settings.
  274. def _buildGlobalSettingsMessage(self, stack):
  275. settings = self._buildReplacementTokens(stack)
  276. # Pre-compute material material_bed_temp_prepend and material_print_temp_prepend
  277. start_gcode = settings["machine_start_gcode"]
  278. bed_temperature_settings = ["material_bed_temperature", "material_bed_temperature_layer_0"]
  279. pattern = r"\{(%s)(,\s?\w+)?\}" % "|".join(bed_temperature_settings) # match {setting} as well as {setting, extruder_nr}
  280. settings["material_bed_temp_prepend"] = re.search(pattern, start_gcode) == None
  281. print_temperature_settings = ["material_print_temperature", "material_print_temperature_layer_0", "default_material_print_temperature", "material_initial_print_temperature", "material_final_print_temperature", "material_standby_temperature"]
  282. pattern = r"\{(%s)(,\s?\w+)?\}" % "|".join(print_temperature_settings) # match {setting} as well as {setting, extruder_nr}
  283. settings["material_print_temp_prepend"] = re.search(pattern, start_gcode) == None
  284. # Replace the setting tokens in start and end g-code.
  285. # Use values from the first used extruder by default so we get the expected temperatures
  286. initial_extruder_stack = Application.getInstance().getExtruderManager().getUsedExtruderStacks()[0]
  287. initial_extruder_nr = initial_extruder_stack.getProperty("extruder_nr", "value")
  288. settings["machine_start_gcode"] = self._expandGcodeTokens(settings["machine_start_gcode"], initial_extruder_nr)
  289. settings["machine_end_gcode"] = self._expandGcodeTokens(settings["machine_end_gcode"], initial_extruder_nr)
  290. # Add all sub-messages for each individual setting.
  291. for key, value in settings.items():
  292. setting_message = self._slice_message.getMessage("global_settings").addRepeatedMessage("settings")
  293. setting_message.name = key
  294. setting_message.value = str(value).encode("utf-8")
  295. Job.yieldThread()
  296. ## Sends for some settings which extruder they should fallback to if not
  297. # set.
  298. #
  299. # This is only set for settings that have the limit_to_extruder
  300. # property.
  301. #
  302. # \param stack The global stack with all settings, from which to read the
  303. # limit_to_extruder property.
  304. def _buildGlobalInheritsStackMessage(self, stack):
  305. for key in stack.getAllKeys():
  306. extruder = int(round(float(stack.getProperty(key, "limit_to_extruder"))))
  307. if extruder >= 0: #Set to a specific extruder.
  308. setting_extruder = self._slice_message.addRepeatedMessage("limit_to_extruder")
  309. setting_extruder.name = key
  310. setting_extruder.extruder = extruder
  311. Job.yieldThread()
  312. ## Check if a node has per object settings and ensure that they are set correctly in the message
  313. # \param node \type{SceneNode} Node to check.
  314. # \param message object_lists message to put the per object settings in
  315. def _handlePerObjectSettings(self, node, message):
  316. stack = node.callDecoration("getStack")
  317. # Check if the node has a stack attached to it and the stack has any settings in the top container.
  318. if not stack:
  319. return
  320. # Check all settings for relations, so we can also calculate the correct values for dependent settings.
  321. top_of_stack = stack.getTop() # Cache for efficiency.
  322. changed_setting_keys = set(top_of_stack.getAllKeys())
  323. # Add all relations to changed settings as well.
  324. for key in top_of_stack.getAllKeys():
  325. instance = top_of_stack.getInstance(key)
  326. self._addRelations(changed_setting_keys, instance.definition.relations)
  327. Job.yieldThread()
  328. # Ensure that the engine is aware what the build extruder is.
  329. if stack.getProperty("machine_extruder_count", "value") > 1:
  330. changed_setting_keys.add("extruder_nr")
  331. # Get values for all changed settings
  332. for key in changed_setting_keys:
  333. setting = message.addRepeatedMessage("settings")
  334. setting.name = key
  335. extruder = int(round(float(stack.getProperty(key, "limit_to_extruder"))))
  336. # Check if limited to a specific extruder, but not overridden by per-object settings.
  337. if extruder >= 0 and key not in changed_setting_keys:
  338. limited_stack = ExtruderManager.getInstance().getActiveExtruderStacks()[extruder]
  339. else:
  340. limited_stack = stack
  341. setting.value = str(limited_stack.getProperty(key, "value")).encode("utf-8")
  342. Job.yieldThread()
  343. ## Recursive function to put all settings that require each other for value changes in a list
  344. # \param relations_set \type{set} Set of keys (strings) of settings that are influenced
  345. # \param relations list of relation objects that need to be checked.
  346. def _addRelations(self, relations_set, relations):
  347. for relation in filter(lambda r: r.role == "value" or r.role == "limit_to_extruder", relations):
  348. if relation.type == RelationType.RequiresTarget:
  349. continue
  350. relations_set.add(relation.target.key)
  351. self._addRelations(relations_set, relation.target.relations)