StartSliceJob.py 25 KB

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