StartSliceJob.py 24 KB

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