ExtruderManager.py 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485
  1. # Copyright (c) 2022 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. from PyQt6.QtCore import pyqtSignal, pyqtProperty, QObject, QVariant # For communicating data and events to Qt.
  4. from UM.FlameProfiler import pyqtSlot
  5. import cura.CuraApplication # To get the global container stack to find the current machine.
  6. from cura.Settings.GlobalStack import GlobalStack
  7. from UM.Logger import Logger
  8. from UM.Scene.Iterator.DepthFirstIterator import DepthFirstIterator
  9. from UM.Scene.SceneNode import SceneNode
  10. from UM.Scene.Selection import Selection
  11. from UM.Scene.Iterator.BreadthFirstIterator import BreadthFirstIterator
  12. from UM.Settings.ContainerRegistry import ContainerRegistry # Finding containers by ID.
  13. from cura.Machines.ContainerTree import ContainerTree
  14. from typing import Any, cast, Dict, List, Optional, TYPE_CHECKING, Union
  15. if TYPE_CHECKING:
  16. from cura.Settings.ExtruderStack import ExtruderStack
  17. class ExtruderManager(QObject):
  18. """Manages all existing extruder stacks.
  19. This keeps a list of extruder stacks for each machine.
  20. """
  21. def __init__(self, parent = None):
  22. """Registers listeners and such to listen to changes to the extruders."""
  23. if ExtruderManager.__instance is not None:
  24. raise RuntimeError("Try to create singleton '%s' more than once" % self.__class__.__name__)
  25. super().__init__(parent)
  26. ExtruderManager.__instance = self
  27. self._application = cura.CuraApplication.CuraApplication.getInstance()
  28. # Per machine, a dictionary of extruder container stack IDs. Only for separately defined extruders.
  29. self._extruder_trains = {} # type: Dict[str, Dict[str, "ExtruderStack"]]
  30. self._active_extruder_index = -1 # Indicates the index of the active extruder stack. -1 means no active extruder stack
  31. # TODO; I have no idea why this is a union of ID's and extruder stacks. This needs to be fixed at some point.
  32. self._selected_object_extruders = [] # type: List[Union[str, "ExtruderStack"]]
  33. Selection.selectionChanged.connect(self.resetSelectedObjectExtruders)
  34. extrudersChanged = pyqtSignal(QVariant)
  35. """Signal to notify other components when the list of extruders for a machine definition changes."""
  36. activeExtruderChanged = pyqtSignal()
  37. """Notify when the user switches the currently active extruder."""
  38. @pyqtProperty(str, notify = activeExtruderChanged)
  39. def activeExtruderStackId(self) -> Optional[str]:
  40. """Gets the unique identifier of the currently active extruder stack.
  41. The currently active extruder stack is the stack that is currently being
  42. edited.
  43. :return: The unique ID of the currently active extruder stack.
  44. """
  45. if not self._application.getGlobalContainerStack():
  46. return None # No active machine, so no active extruder.
  47. try:
  48. return self._extruder_trains[self._application.getGlobalContainerStack().getId()][str(self.activeExtruderIndex)].getId()
  49. except KeyError: # Extruder index could be -1 if the global tab is selected, or the entry doesn't exist if the machine definition is wrong.
  50. return None
  51. @pyqtProperty("QVariantMap", notify = extrudersChanged)
  52. def extruderIds(self) -> Dict[str, str]:
  53. """Gets a dict with the extruder stack ids with the extruder number as the key."""
  54. extruder_stack_ids = {} # type: Dict[str, str]
  55. global_container_stack = self._application.getGlobalContainerStack()
  56. if global_container_stack:
  57. extruder_stack_ids = {extruder.getMetaDataEntry("position", ""): extruder.id for extruder in global_container_stack.extruderList}
  58. return extruder_stack_ids
  59. @pyqtSlot(int)
  60. def setActiveExtruderIndex(self, index: int) -> None:
  61. """Changes the active extruder by index.
  62. :param index: The index of the new active extruder.
  63. """
  64. if self._active_extruder_index != index:
  65. self._active_extruder_index = index
  66. self.activeExtruderChanged.emit()
  67. @pyqtProperty(int, notify = activeExtruderChanged)
  68. def activeExtruderIndex(self) -> int:
  69. return self._active_extruder_index
  70. selectedObjectExtrudersChanged = pyqtSignal()
  71. """Emitted whenever the selectedObjectExtruders property changes."""
  72. @pyqtProperty("QVariantList", notify = selectedObjectExtrudersChanged)
  73. def selectedObjectExtruders(self) -> List[Union[str, "ExtruderStack"]]:
  74. """Provides a list of extruder IDs used by the current selected objects."""
  75. if not self._selected_object_extruders:
  76. object_extruders = set()
  77. # First, build a list of the actual selected objects (including children of groups, excluding group nodes)
  78. selected_nodes = [] # type: List["SceneNode"]
  79. for node in Selection.getAllSelectedObjects():
  80. if node.callDecoration("isGroup"):
  81. for grouped_node in BreadthFirstIterator(node):
  82. if grouped_node.callDecoration("isGroup"):
  83. continue
  84. selected_nodes.append(grouped_node)
  85. else:
  86. selected_nodes.append(node)
  87. # Then, figure out which nodes are used by those selected nodes.
  88. current_extruder_trains = self.getActiveExtruderStacks()
  89. for node in selected_nodes:
  90. extruder = node.callDecoration("getActiveExtruder")
  91. if extruder:
  92. object_extruders.add(extruder)
  93. elif current_extruder_trains:
  94. object_extruders.add(current_extruder_trains[0].getId())
  95. self._selected_object_extruders = list(object_extruders)
  96. return self._selected_object_extruders
  97. def resetSelectedObjectExtruders(self) -> None:
  98. """Reset the internal list used for the selectedObjectExtruders property
  99. This will trigger a recalculation of the extruders used for the
  100. selection.
  101. """
  102. self._selected_object_extruders = []
  103. self.selectedObjectExtrudersChanged.emit()
  104. @pyqtSlot(result = QObject)
  105. def getActiveExtruderStack(self) -> Optional["ExtruderStack"]:
  106. return self.getExtruderStack(self.activeExtruderIndex)
  107. def getExtruderStack(self, index) -> Optional["ExtruderStack"]:
  108. """Get an extruder stack by index"""
  109. global_container_stack = self._application.getGlobalContainerStack()
  110. if global_container_stack:
  111. if global_container_stack.getId() in self._extruder_trains:
  112. if str(index) in self._extruder_trains[global_container_stack.getId()]:
  113. return self._extruder_trains[global_container_stack.getId()][str(index)]
  114. return None
  115. def getAllExtruderSettings(self, setting_key: str, prop: str) -> List[Any]:
  116. """Gets a property of a setting for all extruders.
  117. :param setting_key: :type{str} The setting to get the property of.
  118. :param prop: :type{str} The property to get.
  119. :return: :type{List} the list of results
  120. """
  121. result = []
  122. for extruder_stack in self.getActiveExtruderStacks():
  123. result.append(extruder_stack.getProperty(setting_key, prop))
  124. return result
  125. def extruderValueWithDefault(self, value: str) -> str:
  126. machine_manager = self._application.getMachineManager()
  127. if value == "-1":
  128. return machine_manager.defaultExtruderPosition
  129. else:
  130. return value
  131. def getUsedExtruderStacks(self) -> List["ExtruderStack"]:
  132. """Gets the extruder stacks that are actually being used at the moment.
  133. An extruder stack is being used if it is the extruder to print any mesh
  134. with, or if it is the support infill extruder, the support interface
  135. extruder, or the bed adhesion extruder.
  136. If there are no extruders, this returns the global stack as a singleton
  137. list.
  138. :return: A list of extruder stacks.
  139. """
  140. global_stack = self._application.getGlobalContainerStack()
  141. container_registry = ContainerRegistry.getInstance()
  142. used_extruder_stack_ids = set()
  143. # Get the extruders of all meshes in the scene
  144. support_enabled = False
  145. support_bottom_enabled = False
  146. support_roof_enabled = False
  147. scene_root = self._application.getController().getScene().getRoot()
  148. # If no extruders are registered in the extruder manager yet, return an empty array
  149. if len(self.extruderIds) == 0:
  150. return []
  151. number_active_extruders = len([extruder for extruder in self.getActiveExtruderStacks() if extruder.isEnabled])
  152. # Get the extruders of all printable meshes in the scene
  153. nodes = [node for node in DepthFirstIterator(scene_root) if node.isSelectable() and not node.callDecoration("isAntiOverhangMesh") and not node.callDecoration("isSupportMesh")] #type: ignore #Ignore type error because iter() should get called automatically by Python syntax.
  154. for node in nodes:
  155. extruder_stack_id = node.callDecoration("getActiveExtruder")
  156. if not extruder_stack_id:
  157. # No per-object settings for this node
  158. extruder_stack_id = self.extruderIds["0"]
  159. used_extruder_stack_ids.add(extruder_stack_id)
  160. if len(used_extruder_stack_ids) == number_active_extruders:
  161. # We're already done. Stop looking.
  162. # Especially with a lot of models on the buildplate, this will speed up things rather dramatically.
  163. break
  164. # Get whether any of them use support.
  165. stack_to_use = node.callDecoration("getStack") # if there is a per-mesh stack, we use it
  166. if not stack_to_use:
  167. # if there is no per-mesh stack, we use the build extruder for this mesh
  168. stack_to_use = container_registry.findContainerStacks(id = extruder_stack_id)[0]
  169. if not support_enabled:
  170. support_enabled |= stack_to_use.getProperty("support_enable", "value")
  171. if not support_bottom_enabled:
  172. support_bottom_enabled |= stack_to_use.getProperty("support_bottom_enable", "value")
  173. if not support_roof_enabled:
  174. support_roof_enabled |= stack_to_use.getProperty("support_roof_enable", "value")
  175. # Check limit to extruders
  176. limit_to_extruder_feature_list = ["wall_0_extruder_nr",
  177. "wall_x_extruder_nr",
  178. "roofing_extruder_nr",
  179. "top_bottom_extruder_nr",
  180. "infill_extruder_nr",
  181. ]
  182. for extruder_nr_feature_name in limit_to_extruder_feature_list:
  183. extruder_nr = int(global_stack.getProperty(extruder_nr_feature_name, "value"))
  184. if extruder_nr == -1:
  185. continue
  186. if str(extruder_nr) not in self.extruderIds:
  187. extruder_nr = int(self._application.getMachineManager().defaultExtruderPosition)
  188. used_extruder_stack_ids.add(self.extruderIds[str(extruder_nr)])
  189. # Check support extruders
  190. if support_enabled:
  191. used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_infill_extruder_nr", "value")))])
  192. used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_extruder_nr_layer_0", "value")))])
  193. if support_bottom_enabled:
  194. used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_bottom_extruder_nr", "value")))])
  195. if support_roof_enabled:
  196. used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_roof_extruder_nr", "value")))])
  197. # The platform adhesion extruders.
  198. used_adhesion_extruders = set()
  199. adhesion_type = global_stack.getProperty("adhesion_type", "value")
  200. if adhesion_type == "skirt" and (global_stack.getProperty("skirt_line_count", "value") > 0 or global_stack.getProperty("skirt_brim_minimal_length", "value") > 0):
  201. used_adhesion_extruders.add("skirt_brim_extruder_nr") # There's a skirt.
  202. if (adhesion_type == "brim" or global_stack.getProperty("prime_tower_brim_enable", "value")) and (global_stack.getProperty("brim_line_count", "value") > 0 or global_stack.getProperty("skirt_brim_minimal_length", "value") > 0):
  203. used_adhesion_extruders.add("skirt_brim_extruder_nr") # There's a brim or prime tower brim.
  204. if adhesion_type == "raft":
  205. used_adhesion_extruders.add("raft_base_extruder_nr")
  206. if global_stack.getProperty("raft_interface_layers", "value") > 0:
  207. used_adhesion_extruders.add("raft_interface_extruder_nr")
  208. if global_stack.getProperty("raft_surface_layers", "value") > 0:
  209. used_adhesion_extruders.add("raft_surface_extruder_nr")
  210. for extruder_setting in used_adhesion_extruders:
  211. extruder_str_nr = str(global_stack.getProperty(extruder_setting, "value"))
  212. if extruder_str_nr == "-1":
  213. extruder_str_nr = self._application.getMachineManager().defaultExtruderPosition
  214. if extruder_str_nr in self.extruderIds:
  215. used_extruder_stack_ids.add(self.extruderIds[extruder_str_nr])
  216. try:
  217. return [container_registry.findContainerStacks(id = stack_id)[0] for stack_id in used_extruder_stack_ids]
  218. except IndexError: # One or more of the extruders was not found.
  219. Logger.log("e", "Unable to find one or more of the extruders in %s", used_extruder_stack_ids)
  220. return []
  221. def getInitialExtruderNr(self) -> int:
  222. """Get the extruder that the print will start with.
  223. This should mirror the implementation in CuraEngine of
  224. ``FffGcodeWriter::getStartExtruder()``.
  225. """
  226. application = cura.CuraApplication.CuraApplication.getInstance()
  227. global_stack = application.getGlobalContainerStack()
  228. # Starts with the adhesion extruder.
  229. adhesion_type = global_stack.getProperty("adhesion_type", "value")
  230. if adhesion_type in {"skirt", "brim"}:
  231. return global_stack.getProperty("skirt_brim_extruder_nr", "value")
  232. if adhesion_type == "raft":
  233. return global_stack.getProperty("raft_base_extruder_nr", "value")
  234. # No adhesion? Well maybe there is still support brim.
  235. if (global_stack.getProperty("support_enable", "value") or global_stack.getProperty("support_structure", "value") == "tree") and global_stack.getProperty("support_brim_enable", "value"):
  236. return global_stack.getProperty("support_infill_extruder_nr", "value")
  237. # REALLY no adhesion? Use the first used extruder.
  238. return self.getUsedExtruderStacks()[0].getProperty("extruder_nr", "value")
  239. def removeMachineExtruders(self, machine_id: str) -> None:
  240. """Removes the container stack and user profile for the extruders for a specific machine.
  241. :param machine_id: The machine to remove the extruders for.
  242. """
  243. for extruder in self.getMachineExtruders(machine_id):
  244. ContainerRegistry.getInstance().removeContainer(extruder.userChanges.getId())
  245. ContainerRegistry.getInstance().removeContainer(extruder.definitionChanges.getId())
  246. ContainerRegistry.getInstance().removeContainer(extruder.getId())
  247. if machine_id in self._extruder_trains:
  248. del self._extruder_trains[machine_id]
  249. def getMachineExtruders(self, machine_id: str) -> List["ExtruderStack"]:
  250. """Returns extruders for a specific machine.
  251. :param machine_id: The machine to get the extruders of.
  252. """
  253. if machine_id not in self._extruder_trains:
  254. return []
  255. return [self._extruder_trains[machine_id][name] for name in self._extruder_trains[machine_id]]
  256. def getActiveExtruderStacks(self) -> List["ExtruderStack"]:
  257. """Returns the list of active extruder stacks, taking into account the machine extruder count.
  258. :return: :type{List[ContainerStack]} a list of
  259. """
  260. global_stack = self._application.getGlobalContainerStack()
  261. if not global_stack:
  262. return []
  263. return global_stack.extruderList
  264. def _globalContainerStackChanged(self) -> None:
  265. # If the global container changed, the machine changed and might have extruders that were not registered yet
  266. self._addCurrentMachineExtruders()
  267. self.resetSelectedObjectExtruders()
  268. def addMachineExtruders(self, global_stack: GlobalStack) -> None:
  269. """Adds the extruders to the selected machine."""
  270. extruders_changed = False
  271. container_registry = ContainerRegistry.getInstance()
  272. global_stack_id = global_stack.getId()
  273. # Gets the extruder trains that we just created as well as any that still existed.
  274. extruder_trains = container_registry.findContainerStacks(type = "extruder_train", machine = global_stack_id)
  275. # Make sure the extruder trains for the new machine can be placed in the set of sets
  276. if global_stack_id not in self._extruder_trains:
  277. self._extruder_trains[global_stack_id] = {}
  278. extruders_changed = True
  279. # Register the extruder trains by position
  280. for extruder_train in extruder_trains:
  281. extruder_position = extruder_train.getMetaDataEntry("position")
  282. self._extruder_trains[global_stack_id][extruder_position] = extruder_train
  283. # regardless of what the next stack is, we have to set it again, because of signal routing. ???
  284. extruder_train.setParent(global_stack)
  285. extruder_train.setNextStack(global_stack)
  286. extruders_changed = True
  287. self.fixSingleExtrusionMachineExtruderDefinition(global_stack)
  288. if extruders_changed:
  289. self.extrudersChanged.emit(global_stack_id)
  290. # After 3.4, all single-extrusion machines have their own extruder definition files instead of reusing
  291. # "fdmextruder". We need to check a machine here so its extruder definition is correct according to this.
  292. def fixSingleExtrusionMachineExtruderDefinition(self, global_stack: "GlobalStack") -> None:
  293. container_registry = ContainerRegistry.getInstance()
  294. expected_extruder_stack = global_stack.getMetaDataEntry("machine_extruder_trains")
  295. if expected_extruder_stack is None:
  296. return
  297. expected_extruder_definition_0_id = expected_extruder_stack["0"]
  298. try:
  299. extruder_stack_0 = global_stack.extruderList[0]
  300. except IndexError:
  301. extruder_stack_0 = None
  302. # At this point, extruder stacks for this machine may not have been loaded yet. In this case, need to look in
  303. # the container registry as well.
  304. if not global_stack.extruderList:
  305. extruder_trains = container_registry.findContainerStacks(type = "extruder_train",
  306. machine = global_stack.getId())
  307. if extruder_trains:
  308. for extruder in extruder_trains:
  309. if extruder.getMetaDataEntry("position") == "0":
  310. extruder_stack_0 = extruder
  311. break
  312. if extruder_stack_0 is None:
  313. Logger.log("i", "No extruder stack for global stack [%s], create one", global_stack.getId())
  314. # Single extrusion machine without an ExtruderStack, create it
  315. from cura.Settings.CuraStackBuilder import CuraStackBuilder
  316. CuraStackBuilder.createExtruderStackWithDefaultSetup(global_stack, 0)
  317. elif extruder_stack_0.definition.getId() != expected_extruder_definition_0_id:
  318. Logger.log("e", "Single extruder printer [{printer}] expected extruder [{expected}], but got [{got}]. I'm making it [{expected}].".format(
  319. printer = global_stack.getId(), expected = expected_extruder_definition_0_id, got = extruder_stack_0.definition.getId()))
  320. try:
  321. extruder_definition = container_registry.findDefinitionContainers(id = expected_extruder_definition_0_id)[0]
  322. except IndexError:
  323. # It still needs to break, but we want to know what extruder ID made it break.
  324. msg = "Unable to find extruder definition with the id [%s]" % expected_extruder_definition_0_id
  325. Logger.logException("e", msg)
  326. raise IndexError(msg)
  327. extruder_stack_0.definition = extruder_definition
  328. @pyqtSlot("QVariant", result = bool)
  329. def getExtruderHasQualityForMaterial(self, extruder_stack: "ExtruderStack") -> bool:
  330. """Checks if quality nodes exist for the variant/material combination."""
  331. application = cura.CuraApplication.CuraApplication.getInstance()
  332. global_stack = application.getGlobalContainerStack()
  333. if not global_stack or not extruder_stack:
  334. return False
  335. if not global_stack.getMetaDataEntry("has_materials"):
  336. return True
  337. machine_node = ContainerTree.getInstance().machines[global_stack.definition.getId()]
  338. active_variant_name = extruder_stack.variant.getMetaDataEntry("name")
  339. if active_variant_name not in machine_node.variants:
  340. Logger.log("w", "Could not find the variant %s", active_variant_name)
  341. return True
  342. active_variant_node = machine_node.variants[active_variant_name]
  343. try:
  344. active_material_node = active_variant_node.materials[extruder_stack.material.getMetaDataEntry("base_file")]
  345. except KeyError: # The material in this stack is not a supported material (e.g. wrong filament diameter, as loaded from a project file).
  346. return False
  347. active_material_node_qualities = active_material_node.qualities
  348. if not active_material_node_qualities:
  349. return False
  350. return list(active_material_node_qualities.keys())[0] != "empty_quality"
  351. @pyqtSlot(str, result="QVariant")
  352. def getInstanceExtruderValues(self, key: str) -> List:
  353. """Get all extruder values for a certain setting.
  354. This is exposed to qml for display purposes
  355. :param key: The key of the setting to retrieve values for.
  356. :return: String representing the extruder values
  357. """
  358. return self._application.getCuraFormulaFunctions().getValuesInAllExtruders(key)
  359. @staticmethod
  360. def getResolveOrValue(key: str) -> Any:
  361. """Get the resolve value or value for a given key
  362. This is the effective value for a given key, it is used for values in the global stack.
  363. This is exposed to SettingFunction to use in value functions.
  364. :param key: The key of the setting to get the value of.
  365. :return: The effective value
  366. """
  367. global_stack = cast(GlobalStack, cura.CuraApplication.CuraApplication.getInstance().getGlobalContainerStack())
  368. resolved_value = global_stack.getProperty(key, "value")
  369. return resolved_value
  370. __instance = None # type: ExtruderManager
  371. @classmethod
  372. def getInstance(cls, *args, **kwargs) -> "ExtruderManager":
  373. return cls.__instance