MachineManager.py 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288
  1. # Copyright (c) 2017 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. #Type hinting.
  4. from typing import Union, List, Dict
  5. from UM.Signal import Signal
  6. from PyQt5.QtCore import QObject, pyqtProperty, pyqtSignal, QTimer
  7. from UM.FlameProfiler import pyqtSlot
  8. from PyQt5.QtWidgets import QMessageBox
  9. from UM import Util
  10. from UM.Application import Application
  11. from UM.Preferences import Preferences
  12. from UM.Logger import Logger
  13. from UM.Message import Message
  14. from UM.Decorators import deprecated
  15. from UM.Settings.ContainerRegistry import ContainerRegistry
  16. from UM.Settings.ContainerStack import ContainerStack
  17. from UM.Settings.InstanceContainer import InstanceContainer
  18. from UM.Settings.SettingFunction import SettingFunction
  19. from UM.Signal import postponeSignals, CompressTechnique
  20. import UM.FlameProfiler
  21. from cura.QualityManager import QualityManager
  22. from cura.PrinterOutputDevice import PrinterOutputDevice
  23. from cura.Settings.ExtruderManager import ExtruderManager
  24. from .CuraStackBuilder import CuraStackBuilder
  25. from UM.i18n import i18nCatalog
  26. catalog = i18nCatalog("cura")
  27. from typing import TYPE_CHECKING, Optional
  28. if TYPE_CHECKING:
  29. from UM.Settings.DefinitionContainer import DefinitionContainer
  30. from cura.Settings.CuraContainerStack import CuraContainerStack
  31. from cura.Settings.GlobalStack import GlobalStack
  32. class MachineManager(QObject):
  33. def __init__(self, parent = None):
  34. super().__init__(parent)
  35. self._active_container_stack = None # type: CuraContainerStack
  36. self._global_container_stack = None # type: GlobalStack
  37. # Used to store the new containers until after confirming the dialog
  38. self._new_variant_container = None
  39. self._new_material_container = None
  40. self._new_quality_containers = []
  41. self._error_check_timer = QTimer()
  42. self._error_check_timer.setInterval(250)
  43. self._error_check_timer.setSingleShot(True)
  44. self._error_check_timer.timeout.connect(self._updateStacksHaveErrors)
  45. self._instance_container_timer = QTimer()
  46. self._instance_container_timer.setInterval(250)
  47. self._instance_container_timer.setSingleShot(True)
  48. self._instance_container_timer.timeout.connect(self.__onInstanceContainersChanged)
  49. Application.getInstance().globalContainerStackChanged.connect(self._onGlobalContainerChanged)
  50. ## When the global container is changed, active material probably needs to be updated.
  51. self.globalContainerChanged.connect(self.activeMaterialChanged)
  52. self.globalContainerChanged.connect(self.activeVariantChanged)
  53. self.globalContainerChanged.connect(self.activeQualityChanged)
  54. self._stacks_have_errors = None
  55. self._empty_variant_container = ContainerRegistry.getInstance().findContainers(id = "empty_variant")[0]
  56. self._empty_material_container = ContainerRegistry.getInstance().findContainers(id = "empty_material")[0]
  57. self._empty_quality_container = ContainerRegistry.getInstance().findContainers(id = "empty_quality")[0]
  58. self._empty_quality_changes_container = ContainerRegistry.getInstance().findContainers(id = "empty_quality_changes")[0]
  59. self._onGlobalContainerChanged()
  60. ExtruderManager.getInstance().activeExtruderChanged.connect(self._onActiveExtruderStackChanged)
  61. self._onActiveExtruderStackChanged()
  62. ExtruderManager.getInstance().activeExtruderChanged.connect(self.activeMaterialChanged)
  63. ExtruderManager.getInstance().activeExtruderChanged.connect(self.activeVariantChanged)
  64. ExtruderManager.getInstance().activeExtruderChanged.connect(self.activeQualityChanged)
  65. self.globalContainerChanged.connect(self.activeStackChanged)
  66. self.globalValueChanged.connect(self.activeStackValueChanged)
  67. ExtruderManager.getInstance().activeExtruderChanged.connect(self.activeStackChanged)
  68. self.activeStackChanged.connect(self.activeStackValueChanged)
  69. # when a user closed dialog check if any delayed material or variant changes need to be applied
  70. Application.getInstance().onDiscardOrKeepProfileChangesClosed.connect(self._executeDelayedActiveContainerStackChanges)
  71. Preferences.getInstance().addPreference("cura/active_machine", "")
  72. self._global_event_keys = set()
  73. active_machine_id = Preferences.getInstance().getValue("cura/active_machine")
  74. self._printer_output_devices = []
  75. Application.getInstance().getOutputDeviceManager().outputDevicesChanged.connect(self._onOutputDevicesChanged)
  76. # There might already be some output devices by the time the signal is connected
  77. self._onOutputDevicesChanged()
  78. if active_machine_id != "" and ContainerRegistry.getInstance().findContainerStacks(id = active_machine_id):
  79. # An active machine was saved, so restore it.
  80. self.setActiveMachine(active_machine_id)
  81. # Make sure _active_container_stack is properly initiated
  82. ExtruderManager.getInstance().setActiveExtruderIndex(0)
  83. self._auto_materials_changed = {}
  84. self._auto_hotends_changed = {}
  85. self._material_incompatible_message = Message(catalog.i18nc("@info:status",
  86. "The selected material is incompatible with the selected machine or configuration."),
  87. title = catalog.i18nc("@info:title", "Incompatible Material"))
  88. globalContainerChanged = pyqtSignal() # Emitted whenever the global stack is changed (ie: when changing between printers, changing a global profile, but not when changing a value)
  89. activeMaterialChanged = pyqtSignal()
  90. activeVariantChanged = pyqtSignal()
  91. activeQualityChanged = pyqtSignal()
  92. activeStackChanged = pyqtSignal() # Emitted whenever the active stack is changed (ie: when changing between extruders, changing a profile, but not when changing a value)
  93. globalValueChanged = pyqtSignal() # Emitted whenever a value inside global container is changed.
  94. activeStackValueChanged = pyqtSignal() # Emitted whenever a value inside the active stack is changed.
  95. activeStackValidationChanged = pyqtSignal() # Emitted whenever a validation inside active container is changed
  96. stacksValidationChanged = pyqtSignal() # Emitted whenever a validation is changed
  97. blurSettings = pyqtSignal() # Emitted to force fields in the advanced sidebar to un-focus, so they update properly
  98. outputDevicesChanged = pyqtSignal()
  99. def _onOutputDevicesChanged(self) -> None:
  100. for printer_output_device in self._printer_output_devices:
  101. printer_output_device.hotendIdChanged.disconnect(self._onHotendIdChanged)
  102. printer_output_device.materialIdChanged.disconnect(self._onMaterialIdChanged)
  103. self._printer_output_devices.clear()
  104. for printer_output_device in Application.getInstance().getOutputDeviceManager().getOutputDevices():
  105. if isinstance(printer_output_device, PrinterOutputDevice):
  106. self._printer_output_devices.append(printer_output_device)
  107. printer_output_device.hotendIdChanged.connect(self._onHotendIdChanged)
  108. printer_output_device.materialIdChanged.connect(self._onMaterialIdChanged)
  109. self.outputDevicesChanged.emit()
  110. @property
  111. def newVariant(self):
  112. return self._new_variant_container
  113. @property
  114. def newMaterial(self):
  115. return self._new_material_container
  116. @pyqtProperty("QVariantList", notify = outputDevicesChanged)
  117. def printerOutputDevices(self):
  118. return self._printer_output_devices
  119. @pyqtProperty(int, constant=True)
  120. def totalNumberOfSettings(self) -> int:
  121. return len(ContainerRegistry.getInstance().findDefinitionContainers(id = "fdmprinter")[0].getAllKeys())
  122. def _onHotendIdChanged(self, index: Union[str, int], hotend_id: str) -> None:
  123. if not self._global_container_stack:
  124. return
  125. containers = ContainerRegistry.getInstance().findInstanceContainers(type="variant", definition=self._global_container_stack.getBottom().getId(), name=hotend_id)
  126. if containers: # New material ID is known
  127. extruder_manager = ExtruderManager.getInstance()
  128. machine_id = self.activeMachineId
  129. extruders = extruder_manager.getMachineExtruders(machine_id)
  130. matching_extruder = None
  131. for extruder in extruders:
  132. if str(index) == extruder.getMetaDataEntry("position"):
  133. matching_extruder = extruder
  134. break
  135. if matching_extruder and matching_extruder.variant.getName() != hotend_id:
  136. # Save the material that needs to be changed. Multiple changes will be handled by the callback.
  137. self._auto_hotends_changed[str(index)] = containers[0].getId()
  138. self._printer_output_devices[0].materialHotendChangedMessage(self._materialHotendChangedCallback)
  139. else:
  140. Logger.log("w", "No variant found for printer definition %s with id %s" % (self._global_container_stack.getBottom().getId(), hotend_id))
  141. def _onMaterialIdChanged(self, index: Union[str, int], material_id: str):
  142. if not self._global_container_stack:
  143. return
  144. definition_id = "fdmprinter"
  145. if self._global_container_stack.getMetaDataEntry("has_machine_materials", False):
  146. definition_id = self.activeQualityDefinitionId
  147. extruder_manager = ExtruderManager.getInstance()
  148. containers = ContainerRegistry.getInstance().findInstanceContainers(type = "material", definition = definition_id, GUID = material_id)
  149. if containers: # New material ID is known
  150. extruders = list(extruder_manager.getMachineExtruders(self.activeMachineId))
  151. matching_extruder = None
  152. for extruder in extruders:
  153. if str(index) == extruder.getMetaDataEntry("position"):
  154. matching_extruder = extruder
  155. break
  156. if matching_extruder and matching_extruder.material.getMetaDataEntry("GUID") != material_id:
  157. # Save the material that needs to be changed. Multiple changes will be handled by the callback.
  158. if self._global_container_stack.getBottom().getMetaDataEntry("has_variants") and matching_extruder.variant:
  159. variant_id = self.getQualityVariantId(self._global_container_stack.getBottom(), matching_extruder.variant)
  160. for container in containers:
  161. if container.getMetaDataEntry("variant") == variant_id:
  162. self._auto_materials_changed[str(index)] = container.getId()
  163. break
  164. else:
  165. # Just use the first result we found.
  166. self._auto_materials_changed[str(index)] = containers[0].getId()
  167. self._printer_output_devices[0].materialHotendChangedMessage(self._materialHotendChangedCallback)
  168. else:
  169. Logger.log("w", "No material definition found for printer definition %s and GUID %s" % (definition_id, material_id))
  170. def _materialHotendChangedCallback(self, button):
  171. if button == QMessageBox.No:
  172. self._auto_materials_changed = {}
  173. self._auto_hotends_changed = {}
  174. return
  175. self._autoUpdateMaterials()
  176. self._autoUpdateHotends()
  177. def _autoUpdateMaterials(self):
  178. extruder_manager = ExtruderManager.getInstance()
  179. for position in self._auto_materials_changed:
  180. material_id = self._auto_materials_changed[position]
  181. old_index = extruder_manager.activeExtruderIndex
  182. if old_index != int(position):
  183. extruder_manager.setActiveExtruderIndex(int(position))
  184. else:
  185. old_index = None
  186. Logger.log("d", "Setting material of hotend %s to %s" % (position, material_id))
  187. self.setActiveMaterial(material_id)
  188. if old_index is not None:
  189. extruder_manager.setActiveExtruderIndex(old_index)
  190. self._auto_materials_changed = {} #Processed all of them now.
  191. def _autoUpdateHotends(self):
  192. extruder_manager = ExtruderManager.getInstance()
  193. for position in self._auto_hotends_changed:
  194. hotend_id = self._auto_hotends_changed[position]
  195. old_index = extruder_manager.activeExtruderIndex
  196. if old_index != int(position):
  197. extruder_manager.setActiveExtruderIndex(int(position))
  198. else:
  199. old_index = None
  200. Logger.log("d", "Setting hotend variant of hotend %s to %s" % (position, hotend_id))
  201. self.setActiveVariant(hotend_id)
  202. if old_index is not None:
  203. extruder_manager.setActiveExtruderIndex(old_index)
  204. self._auto_hotends_changed = {} # Processed all of them now.
  205. def _onGlobalContainerChanged(self):
  206. if self._global_container_stack:
  207. try:
  208. self._global_container_stack.nameChanged.disconnect(self._onMachineNameChanged)
  209. except TypeError: # pyQtSignal gives a TypeError when disconnecting from something that was already disconnected.
  210. pass
  211. try:
  212. self._global_container_stack.containersChanged.disconnect(self._onInstanceContainersChanged)
  213. except TypeError:
  214. pass
  215. try:
  216. self._global_container_stack.propertyChanged.disconnect(self._onPropertyChanged)
  217. except TypeError:
  218. pass
  219. # TODO: remove this - CURA-4482
  220. material = self._global_container_stack.material
  221. material.nameChanged.disconnect(self._onMaterialNameChanged)
  222. # TODO: remove this - CURA-4482
  223. quality = self._global_container_stack.quality
  224. quality.nameChanged.disconnect(self._onQualityNameChanged)
  225. for extruder_stack in ExtruderManager.getInstance().getActiveExtruderStacks():
  226. extruder_stack.propertyChanged.disconnect(self._onPropertyChanged)
  227. extruder_stack.containersChanged.disconnect(self._onInstanceContainersChanged)
  228. # update the local global container stack reference
  229. self._global_container_stack = Application.getInstance().getGlobalContainerStack()
  230. self.globalContainerChanged.emit()
  231. # after switching the global stack we reconnect all the signals and set the variant and material references
  232. if self._global_container_stack:
  233. Preferences.getInstance().setValue("cura/active_machine", self._global_container_stack.getId())
  234. self._global_container_stack.nameChanged.connect(self._onMachineNameChanged)
  235. self._global_container_stack.containersChanged.connect(self._onInstanceContainersChanged)
  236. self._global_container_stack.propertyChanged.connect(self._onPropertyChanged)
  237. # set the global variant to empty as we now use the extruder stack at all times - CURA-4482
  238. global_variant = self._global_container_stack.variant
  239. if global_variant != self._empty_variant_container:
  240. self._global_container_stack.setVariant(self._empty_variant_container)
  241. # set the global material to empty as we now use the extruder stack at all times - CURA-4482
  242. global_material = self._global_container_stack.material
  243. if global_material != self._empty_material_container:
  244. self._global_container_stack.setMaterial(self._empty_material_container)
  245. # TODO: update stack builder since this is not always a user created stack
  246. # if len(self._global_container_stack.extruders) == 0:
  247. # extruder_stack = CuraStackBuilder.createExtruderStack(
  248. # self._global_container_stack.getId(),
  249. # definition = self._global_container_stack.definition,
  250. # machine_definition = self._global_container_stack.definition,
  251. # )
  252. # extruder_stack.setNextStack(self._global_container_stack)
  253. # extruder_stack.propertyChanged.connect(self._onPropertyChanged)
  254. # extruder_stack.containersChanged.connect(self._onInstanceContainersChanged)
  255. # Listen for changes on all extruder stacks
  256. for extruder_stack in ExtruderManager.getInstance().getActiveExtruderStacks():
  257. extruder_stack.propertyChanged.connect(self._onPropertyChanged)
  258. extruder_stack.containersChanged.connect(self._onInstanceContainersChanged)
  259. self._error_check_timer.start()
  260. ## Update self._stacks_valid according to _checkStacksForErrors and emit if change.
  261. def _updateStacksHaveErrors(self):
  262. old_stacks_have_errors = self._stacks_have_errors
  263. self._stacks_have_errors = self._checkStacksHaveErrors()
  264. if old_stacks_have_errors != self._stacks_have_errors:
  265. self.stacksValidationChanged.emit()
  266. Application.getInstance().stacksValidationFinished.emit()
  267. def _onActiveExtruderStackChanged(self):
  268. self.blurSettings.emit() # Ensure no-one has focus.
  269. old_active_container_stack = self._active_container_stack
  270. self._active_container_stack = ExtruderManager.getInstance().getActiveExtruderStack()
  271. self._error_check_timer.start()
  272. if old_active_container_stack != self._active_container_stack:
  273. # Many methods and properties related to the active quality actually depend
  274. # on _active_container_stack. If it changes, then the properties change.
  275. self.activeQualityChanged.emit()
  276. def __onInstanceContainersChanged(self):
  277. self.activeQualityChanged.emit()
  278. self.activeVariantChanged.emit()
  279. self.activeMaterialChanged.emit()
  280. self._updateStacksHaveErrors() # Prevents unwanted re-slices after changing machine
  281. self._error_check_timer.start()
  282. def _onInstanceContainersChanged(self, container):
  283. self._instance_container_timer.start()
  284. def _onPropertyChanged(self, key: str, property_name: str):
  285. if property_name == "value":
  286. # Notify UI items, such as the "changed" star in profile pull down menu.
  287. self.activeStackValueChanged.emit()
  288. elif property_name == "validationState":
  289. self._error_check_timer.start()
  290. @pyqtSlot(str)
  291. def setActiveMachine(self, stack_id: str) -> None:
  292. self.blurSettings.emit() # Ensure no-one has focus.
  293. self._cancelDelayedActiveContainerStackChanges()
  294. containers = ContainerRegistry.getInstance().findContainerStacks(id = stack_id)
  295. if containers:
  296. Application.getInstance().setGlobalContainerStack(containers[0])
  297. self.__onInstanceContainersChanged()
  298. @pyqtSlot(str, str)
  299. def addMachine(self, name: str, definition_id: str) -> None:
  300. new_stack = CuraStackBuilder.createMachine(name, definition_id)
  301. if new_stack:
  302. # Instead of setting the global container stack here, we set the active machine and so the signals are emitted
  303. self.setActiveMachine(new_stack.getId())
  304. else:
  305. Logger.log("w", "Failed creating a new machine!")
  306. def _checkStacksHaveErrors(self) -> bool:
  307. if self._global_container_stack is None: #No active machine.
  308. return False
  309. if self._global_container_stack.hasErrors():
  310. return True
  311. for stack in ExtruderManager.getInstance().getMachineExtruders(self._global_container_stack.getId()):
  312. if stack.hasErrors():
  313. return True
  314. return False
  315. ## Remove all instances from the top instanceContainer (effectively removing all user-changed settings)
  316. @pyqtSlot()
  317. def clearUserSettings(self):
  318. if not self._active_container_stack:
  319. return
  320. self.blurSettings.emit()
  321. user_settings = self._active_container_stack.getTop()
  322. user_settings.clear()
  323. ## Check if the global_container has instances in the user container
  324. @pyqtProperty(bool, notify = activeStackValueChanged)
  325. def hasUserSettings(self) -> bool:
  326. if not self._global_container_stack:
  327. return False
  328. if self._global_container_stack.getTop().findInstances():
  329. return True
  330. stacks = list(ExtruderManager.getInstance().getMachineExtruders(self._global_container_stack.getId()))
  331. for stack in stacks:
  332. if stack.getTop().findInstances():
  333. return True
  334. return False
  335. @pyqtProperty(int, notify = activeStackValueChanged)
  336. def numUserSettings(self) -> int:
  337. if not self._global_container_stack:
  338. return 0
  339. num_user_settings = 0
  340. num_user_settings += len(self._global_container_stack.getTop().findInstances())
  341. stacks = list(ExtruderManager.getInstance().getMachineExtruders(self._global_container_stack.getId()))
  342. for stack in stacks:
  343. num_user_settings += len(stack.getTop().findInstances())
  344. return num_user_settings
  345. ## Delete a user setting from the global stack and all extruder stacks.
  346. # \param key \type{str} the name of the key to delete
  347. @pyqtSlot(str)
  348. def clearUserSettingAllCurrentStacks(self, key: str):
  349. if not self._global_container_stack:
  350. return
  351. send_emits_containers = []
  352. top_container = self._global_container_stack.getTop()
  353. top_container.removeInstance(key, postpone_emit=True)
  354. send_emits_containers.append(top_container)
  355. linked = not self._global_container_stack.getProperty(key, "settable_per_extruder") or \
  356. self._global_container_stack.getProperty(key, "limit_to_extruder") != "-1"
  357. if not linked:
  358. stack = ExtruderManager.getInstance().getActiveExtruderStack()
  359. stacks = [stack]
  360. else:
  361. stacks = ExtruderManager.getInstance().getMachineExtruders(self._global_container_stack.getId())
  362. for stack in stacks:
  363. if stack is not None:
  364. container = stack.getTop()
  365. container.removeInstance(key, postpone_emit=True)
  366. send_emits_containers.append(container)
  367. for container in send_emits_containers:
  368. container.sendPostponedEmits()
  369. ## Check if none of the stacks contain error states
  370. # Note that the _stacks_have_errors is cached due to performance issues
  371. # Calling _checkStack(s)ForErrors on every change is simply too expensive
  372. @pyqtProperty(bool, notify = stacksValidationChanged)
  373. def stacksHaveErrors(self) -> bool:
  374. return bool(self._stacks_have_errors)
  375. @pyqtProperty(str, notify = activeStackChanged)
  376. def activeUserProfileId(self) -> str:
  377. if self._active_container_stack:
  378. return self._active_container_stack.getTop().getId()
  379. return ""
  380. @pyqtProperty(str, notify = globalContainerChanged)
  381. def activeMachineName(self) -> str:
  382. if self._global_container_stack:
  383. return self._global_container_stack.getName()
  384. return ""
  385. @pyqtProperty(str, notify = globalContainerChanged)
  386. def activeMachineId(self) -> str:
  387. if self._global_container_stack:
  388. return self._global_container_stack.getId()
  389. return ""
  390. @pyqtProperty(QObject, notify = globalContainerChanged)
  391. def activeMachine(self) -> Optional["GlobalStack"]:
  392. return self._global_container_stack
  393. @pyqtProperty(str, notify = activeStackChanged)
  394. def activeStackId(self) -> str:
  395. if self._active_container_stack:
  396. return self._active_container_stack.getId()
  397. return ""
  398. @pyqtProperty(str, notify = activeMaterialChanged)
  399. def activeMaterialName(self) -> str:
  400. if self._active_container_stack:
  401. material = self._active_container_stack.material
  402. if material:
  403. return material.getName()
  404. return ""
  405. @pyqtProperty("QVariantList", notify=activeVariantChanged)
  406. def activeVariantNames(self) -> List[str]:
  407. result = []
  408. active_stacks = ExtruderManager.getInstance().getActiveGlobalAndExtruderStacks()
  409. if active_stacks is not None:
  410. for stack in active_stacks:
  411. variant_container = stack.variant
  412. if variant_container and variant_container != self._empty_variant_container:
  413. result.append(variant_container.getName())
  414. return result
  415. @pyqtProperty("QVariantList", notify = activeMaterialChanged)
  416. def activeMaterialNames(self) -> List[str]:
  417. result = []
  418. active_stacks = ExtruderManager.getInstance().getActiveGlobalAndExtruderStacks()
  419. if active_stacks is not None:
  420. for stack in active_stacks:
  421. material_container = stack.material
  422. if material_container and material_container != self._empty_material_container:
  423. result.append(material_container.getName())
  424. return result
  425. @pyqtProperty(str, notify=activeMaterialChanged)
  426. def activeMaterialId(self) -> str:
  427. if self._active_container_stack:
  428. material = self._active_container_stack.material
  429. if material:
  430. return material.getId()
  431. return ""
  432. @pyqtProperty("QVariantMap", notify = activeVariantChanged)
  433. def allActiveVariantIds(self) -> Dict[str, str]:
  434. result = {}
  435. active_stacks = ExtruderManager.getInstance().getActiveExtruderStacks()
  436. if active_stacks is not None: #If we have a global stack.
  437. for stack in active_stacks:
  438. variant_container = stack.variant
  439. if not variant_container:
  440. continue
  441. result[stack.getId()] = variant_container.getId()
  442. return result
  443. ## Gets a dict with the active materials ids set in all extruder stacks and the global stack
  444. # (when there is one extruder, the material is set in the global stack)
  445. #
  446. # \return The material ids in all stacks
  447. @pyqtProperty("QVariantMap", notify = activeMaterialChanged)
  448. def allActiveMaterialIds(self) -> Dict[str, str]:
  449. result = {}
  450. active_stacks = ExtruderManager.getInstance().getActiveExtruderStacks()
  451. result[self._global_container_stack.getId()] = self._global_container_stack.material.getId()
  452. if active_stacks is not None: # If we have extruder stacks
  453. for stack in active_stacks:
  454. material_container = stack.material
  455. if not material_container:
  456. continue
  457. result[stack.getId()] = material_container.getId()
  458. return result
  459. ## Gets the layer height of the currently active quality profile.
  460. #
  461. # This is indicated together with the name of the active quality profile.
  462. #
  463. # \return The layer height of the currently active quality profile. If
  464. # there is no quality profile, this returns 0.
  465. @pyqtProperty(float, notify=activeQualityChanged)
  466. def activeQualityLayerHeight(self) -> float:
  467. if not self._global_container_stack:
  468. return 0
  469. quality_changes = self._global_container_stack.qualityChanges
  470. if quality_changes:
  471. value = self._global_container_stack.getRawProperty("layer_height", "value", skip_until_container = quality_changes.getId())
  472. if isinstance(value, SettingFunction):
  473. value = value(self._global_container_stack)
  474. return value
  475. quality = self._global_container_stack.quality
  476. if quality:
  477. value = self._global_container_stack.getRawProperty("layer_height", "value", skip_until_container = quality.getId())
  478. if isinstance(value, SettingFunction):
  479. value = value(self._global_container_stack)
  480. return value
  481. return 0 # No quality profile.
  482. ## Get the Material ID associated with the currently active material
  483. # \returns MaterialID (string) if found, empty string otherwise
  484. @pyqtProperty(str, notify=activeQualityChanged)
  485. def activeQualityMaterialId(self) -> str:
  486. if self._active_container_stack:
  487. quality = self._active_container_stack.quality
  488. if quality:
  489. material_id = quality.getMetaDataEntry("material")
  490. if material_id:
  491. # if the currently active machine inherits its qualities from a different machine
  492. # definition, make sure to return a material that is relevant to that machine definition
  493. definition_id = self.activeDefinitionId
  494. quality_definition_id = self.activeQualityDefinitionId
  495. if definition_id != quality_definition_id:
  496. material_id = material_id.replace(definition_id, quality_definition_id, 1)
  497. return material_id
  498. return ""
  499. @pyqtProperty(str, notify=activeQualityChanged)
  500. def activeQualityName(self) -> str:
  501. if self._active_container_stack and self._global_container_stack:
  502. quality = self._global_container_stack.qualityChanges
  503. if quality and not isinstance(quality, type(self._empty_quality_changes_container)):
  504. return quality.getName()
  505. quality = self._active_container_stack.quality
  506. if quality:
  507. return quality.getName()
  508. return ""
  509. @pyqtProperty(str, notify=activeQualityChanged)
  510. def activeQualityId(self) -> str:
  511. if self._active_container_stack:
  512. quality = self._active_container_stack.qualityChanges
  513. if quality and not isinstance(quality, type(self._empty_quality_changes_container)):
  514. return quality.getId()
  515. quality = self._active_container_stack.quality
  516. if quality:
  517. return quality.getId()
  518. return ""
  519. @pyqtProperty(str, notify=activeQualityChanged)
  520. def globalQualityId(self) -> str:
  521. if self._global_container_stack:
  522. quality = self._global_container_stack.qualityChanges
  523. if quality and not isinstance(quality, type(self._empty_quality_changes_container)):
  524. return quality.getId()
  525. quality = self._global_container_stack.quality
  526. if quality:
  527. return quality.getId()
  528. return ""
  529. @pyqtProperty(str, notify = activeQualityChanged)
  530. def activeQualityType(self) -> str:
  531. if self._active_container_stack:
  532. quality = self._active_container_stack.quality
  533. if quality:
  534. return quality.getMetaDataEntry("quality_type")
  535. return ""
  536. @pyqtProperty(bool, notify = activeQualityChanged)
  537. def isActiveQualitySupported(self) -> bool:
  538. if self._active_container_stack:
  539. quality = self._active_container_stack.quality
  540. if quality:
  541. return Util.parseBool(quality.getMetaDataEntry("supported", True))
  542. return False
  543. ## Returns whether there is anything unsupported in the current set-up.
  544. #
  545. # The current set-up signifies the global stack and all extruder stacks,
  546. # so this indicates whether there is any container in any of the container
  547. # stacks that is not marked as supported.
  548. @pyqtProperty(bool, notify = activeQualityChanged)
  549. def isCurrentSetupSupported(self) -> bool:
  550. if not self._global_container_stack:
  551. return False
  552. for stack in [self._global_container_stack] + list(self._global_container_stack.extruders.values()):
  553. for container in stack.getContainers():
  554. if not container:
  555. return False
  556. if not Util.parseBool(container.getMetaDataEntry("supported", True)):
  557. return False
  558. return True
  559. ## Get the Quality ID associated with the currently active extruder
  560. # Note that this only returns the "quality", not the "quality_changes"
  561. # \returns QualityID (string) if found, empty string otherwise
  562. # \sa activeQualityId()
  563. # \todo Ideally, this method would be named activeQualityId(), and the other one
  564. # would be named something like activeQualityOrQualityChanges() for consistency
  565. @pyqtProperty(str, notify = activeQualityChanged)
  566. def activeQualityContainerId(self) -> str:
  567. # We're using the active stack instead of the global stack in case the list of qualities differs per extruder
  568. if self._global_container_stack:
  569. quality = self._active_container_stack.quality
  570. if quality:
  571. return quality.getId()
  572. return ""
  573. @pyqtProperty(str, notify = activeQualityChanged)
  574. def activeQualityChangesId(self) -> str:
  575. if self._active_container_stack:
  576. changes = self._active_container_stack.qualityChanges
  577. if changes and changes.getId() != "empty":
  578. return changes.getId()
  579. return ""
  580. ## Check if a container is read_only
  581. @pyqtSlot(str, result = bool)
  582. def isReadOnly(self, container_id: str) -> bool:
  583. containers = ContainerRegistry.getInstance().findInstanceContainers(id = container_id)
  584. if not containers or not self._active_container_stack:
  585. return True
  586. return containers[0].isReadOnly()
  587. ## Copy the value of the setting of the current extruder to all other extruders as well as the global container.
  588. @pyqtSlot(str)
  589. def copyValueToExtruders(self, key: str):
  590. new_value = self._active_container_stack.getProperty(key, "value")
  591. extruder_stacks = [stack for stack in ExtruderManager.getInstance().getMachineExtruders(self._global_container_stack.getId())]
  592. # check in which stack the value has to be replaced
  593. for extruder_stack in extruder_stacks:
  594. if extruder_stack != self._active_container_stack and extruder_stack.getProperty(key, "value") != new_value:
  595. extruder_stack.userChanges.setProperty(key, "value", new_value) # TODO: nested property access, should be improved
  596. ## Set the active material by switching out a container
  597. # Depending on from/to material+current variant, a quality profile is chosen and set.
  598. @pyqtSlot(str)
  599. def setActiveMaterial(self, material_id: str):
  600. with postponeSignals(*self._getContainerChangedSignals(), compress = CompressTechnique.CompressPerParameterValue):
  601. containers = ContainerRegistry.getInstance().findInstanceContainers(id = material_id)
  602. if not containers or not self._active_container_stack:
  603. return
  604. material_container = containers[0]
  605. Logger.log("d", "Attempting to change the active material to %s", material_id)
  606. old_material = self._active_container_stack.material
  607. old_quality = self._active_container_stack.quality
  608. old_quality_changes = self._active_container_stack.qualityChanges
  609. if not old_material:
  610. Logger.log("w", "While trying to set the active material, no material was found to replace it.")
  611. return
  612. if old_quality_changes and isinstance(old_quality_changes, type(self._empty_quality_changes_container)):
  613. old_quality_changes = None
  614. self.blurSettings.emit()
  615. old_material.nameChanged.disconnect(self._onMaterialNameChanged)
  616. self._new_material_container = material_container # self._active_container_stack will be updated with a delay
  617. Logger.log("d", "Active material changed")
  618. material_container.nameChanged.connect(self._onMaterialNameChanged)
  619. if material_container.getMetaDataEntry("compatible") == False:
  620. self._material_incompatible_message.show()
  621. else:
  622. self._material_incompatible_message.hide()
  623. quality_type = None
  624. new_quality_id = None
  625. if old_quality:
  626. new_quality_id = old_quality.getId()
  627. quality_type = old_quality.getMetaDataEntry("quality_type")
  628. if old_quality_changes:
  629. quality_type = old_quality_changes.getMetaDataEntry("quality_type")
  630. new_quality_id = old_quality_changes.getId()
  631. # See if the requested quality type is available in the new situation.
  632. machine_definition = self._active_container_stack.getBottom()
  633. quality_manager = QualityManager.getInstance()
  634. candidate_quality = None
  635. if quality_type:
  636. candidate_quality = quality_manager.findQualityByQualityType(quality_type,
  637. quality_manager.getWholeMachineDefinition(machine_definition),
  638. [material_container])
  639. if not candidate_quality or isinstance(candidate_quality, type(self._empty_quality_changes_container)):
  640. Logger.log("d", "Attempting to find fallback quality")
  641. # Fall back to a quality (which must be compatible with all other extruders)
  642. new_qualities = quality_manager.findAllUsableQualitiesForMachineAndExtruders(
  643. self._global_container_stack, ExtruderManager.getInstance().getExtruderStacks())
  644. if new_qualities:
  645. new_quality_id = new_qualities[0].getId() # Just pick the first available one
  646. else:
  647. Logger.log("w", "No quality profile found that matches the current machine and extruders.")
  648. else:
  649. if not old_quality_changes:
  650. new_quality_id = candidate_quality.getId()
  651. self.setActiveQuality(new_quality_id)
  652. @pyqtSlot(str)
  653. def setActiveVariant(self, variant_id: str):
  654. with postponeSignals(*self._getContainerChangedSignals(), compress = CompressTechnique.CompressPerParameterValue):
  655. containers = ContainerRegistry.getInstance().findInstanceContainers(id = variant_id)
  656. if not containers or not self._active_container_stack:
  657. return
  658. Logger.log("d", "Attempting to change the active variant to %s", variant_id)
  659. old_variant = self._active_container_stack.variant
  660. old_material = self._active_container_stack.material
  661. if old_variant:
  662. self.blurSettings.emit()
  663. self._new_variant_container = containers[0] # self._active_container_stack will be updated with a delay
  664. Logger.log("d", "Active variant changed to {active_variant_id}".format(active_variant_id = containers[0].getId()))
  665. preferred_material_name = None
  666. if old_material:
  667. preferred_material_name = old_material.getName()
  668. preferred_material_id = self._updateMaterialContainer(self._global_container_stack.getBottom(), self._global_container_stack, containers[0], preferred_material_name).id
  669. self.setActiveMaterial(preferred_material_id)
  670. else:
  671. Logger.log("w", "While trying to set the active variant, no variant was found to replace.")
  672. ## set the active quality
  673. # \param quality_id The quality_id of either a quality or a quality_changes
  674. @pyqtSlot(str)
  675. def setActiveQuality(self, quality_id: str):
  676. with postponeSignals(*self._getContainerChangedSignals(), compress = CompressTechnique.CompressPerParameterValue):
  677. self.blurSettings.emit()
  678. containers = ContainerRegistry.getInstance().findInstanceContainers(id = quality_id)
  679. if not containers or not self._global_container_stack:
  680. return
  681. # Quality profile come in two flavours: type=quality and type=quality_changes
  682. # If we found a quality_changes profile then look up its parent quality profile.
  683. container_type = containers[0].getMetaDataEntry("type")
  684. quality_name = containers[0].getName()
  685. quality_type = containers[0].getMetaDataEntry("quality_type")
  686. # Get quality container and optionally the quality_changes container.
  687. if container_type == "quality":
  688. new_quality_settings_list = self.determineQualityAndQualityChangesForQualityType(quality_type)
  689. elif container_type == "quality_changes":
  690. new_quality_settings_list = self._determineQualityAndQualityChangesForQualityChanges(quality_name)
  691. else:
  692. Logger.log("e", "Tried to set quality to a container that is not of the right type")
  693. return
  694. # Check if it was at all possible to find new settings
  695. if new_quality_settings_list is None:
  696. return
  697. # check if any of the stacks have a not supported profile
  698. # if that is the case, all stacks should have a not supported state (otherwise it will show quality_type normal)
  699. has_not_supported_quality = False
  700. # check all stacks for not supported
  701. for setting_info in new_quality_settings_list:
  702. if setting_info["quality"].getMetaDataEntry("quality_type") == "not_supported":
  703. has_not_supported_quality = True
  704. break
  705. # set all stacks to not supported if that's the case
  706. if has_not_supported_quality:
  707. for setting_info in new_quality_settings_list:
  708. setting_info["quality"] = self._empty_quality_container
  709. self._new_quality_containers.clear()
  710. # store the upcoming quality profile changes per stack for later execution
  711. # this prevents re-slicing before the user has made a choice in the discard or keep dialog
  712. # (see _executeDelayedActiveContainerStackChanges)
  713. for setting_info in new_quality_settings_list:
  714. stack = setting_info["stack"]
  715. stack_quality = setting_info["quality"]
  716. stack_quality_changes = setting_info["quality_changes"]
  717. self._new_quality_containers.append({
  718. "stack": stack,
  719. "quality": stack_quality,
  720. "quality_changes": stack_quality_changes
  721. })
  722. has_user_interaction = False
  723. if self.hasUserSettings and Preferences.getInstance().getValue("cura/active_mode") == 1:
  724. # Show the keep/discard user settings dialog
  725. has_user_interaction = Application.getInstance().discardOrKeepProfileChanges()
  726. # If there is no interaction with the user (it means the dialog showing "keep" or "discard" was not shown)
  727. # because either there are not user changes or because the used already decided to always keep or discard,
  728. # then the quality instance container is replaced, in which case, the activeQualityChanged signal is emitted.
  729. if not has_user_interaction:
  730. self._executeDelayedActiveContainerStackChanges()
  731. ## Used to update material and variant in the active container stack with a delay.
  732. # This delay prevents the stack from triggering a lot of signals (eventually resulting in slicing)
  733. # before the user decided to keep or discard any of their changes using the dialog.
  734. # The Application.onDiscardOrKeepProfileChangesClosed signal triggers this method.
  735. def _executeDelayedActiveContainerStackChanges(self):
  736. if self._new_variant_container is not None:
  737. self._active_container_stack.variant = self._new_variant_container
  738. self._new_variant_container = None
  739. if self._new_material_container is not None:
  740. self._active_container_stack.material = self._new_material_container
  741. self._new_material_container = None
  742. # apply the new quality to all stacks
  743. if self._new_quality_containers:
  744. for new_quality in self._new_quality_containers:
  745. self._replaceQualityOrQualityChangesInStack(new_quality["stack"], new_quality["quality"], postpone_emit = True)
  746. self._replaceQualityOrQualityChangesInStack(new_quality["stack"], new_quality["quality_changes"], postpone_emit = True)
  747. for new_quality in self._new_quality_containers:
  748. new_quality["stack"].nameChanged.connect(self._onQualityNameChanged)
  749. new_quality["stack"].sendPostponedEmits() # Send the signals that were postponed in _replaceQualityOrQualityChangesInStack
  750. self._new_quality_containers.clear()
  751. ## Cancel set changes for material and variant in the active container stack.
  752. # Used for ignoring any changes when switching between printers (setActiveMachine)
  753. def _cancelDelayedActiveContainerStackChanges(self):
  754. self._new_material_container = None
  755. self._new_variant_container = None
  756. ## Determine the quality and quality changes settings for the current machine for a quality name.
  757. #
  758. # \param quality_name \type{str} the name of the quality.
  759. # \return \type{List[Dict]} with keys "stack", "quality" and "quality_changes".
  760. @UM.FlameProfiler.profile
  761. def determineQualityAndQualityChangesForQualityType(self, quality_type: str) -> List[Dict[str, Union["CuraContainerStack", InstanceContainer]]]:
  762. quality_manager = QualityManager.getInstance()
  763. result = []
  764. empty_quality_changes = self._empty_quality_changes_container
  765. global_container_stack = self._global_container_stack
  766. if not global_container_stack:
  767. return []
  768. global_machine_definition = quality_manager.getParentMachineDefinition(global_container_stack.getBottom())
  769. extruder_stacks = ExtruderManager.getInstance().getActiveExtruderStacks()
  770. # find qualities for extruders
  771. for extruder_stack in extruder_stacks:
  772. material = extruder_stack.material
  773. # TODO: fix this
  774. if self._new_material_container and extruder_stack.getId() == self._active_container_stack.getId():
  775. material = self._new_material_container
  776. quality = quality_manager.findQualityByQualityType(quality_type, global_machine_definition, [material])
  777. if not quality:
  778. # No quality profile is found for this quality type.
  779. quality = self._empty_quality_container
  780. result.append({
  781. "stack": extruder_stack,
  782. "quality": quality,
  783. "quality_changes": empty_quality_changes
  784. })
  785. # also find a global quality for the machine
  786. global_quality = quality_manager.findQualityByQualityType(quality_type, global_machine_definition, [], global_quality = True)
  787. # if there is not global quality but we're using a single extrusion machine, copy the quality of the first extruder - CURA-4482
  788. if not global_quality and len(extruder_stacks) == 1:
  789. global_quality = result[0]["quality"]
  790. # if there is still no global quality, set it to empty (not supported)
  791. if not global_quality:
  792. global_quality = self._empty_quality_container
  793. result.append({
  794. "stack": global_container_stack,
  795. "quality": global_quality,
  796. "quality_changes": empty_quality_changes
  797. })
  798. return result
  799. ## Determine the quality and quality changes settings for the current machine for a quality changes name.
  800. #
  801. # \param quality_changes_name \type{str} the name of the quality changes.
  802. # \return \type{List[Dict]} with keys "stack", "quality" and "quality_changes".
  803. def _determineQualityAndQualityChangesForQualityChanges(self, quality_changes_name: str) -> Optional[List[Dict[str, Union["CuraContainerStack", InstanceContainer]]]]:
  804. result = []
  805. quality_manager = QualityManager.getInstance()
  806. global_container_stack = self._global_container_stack
  807. global_machine_definition = quality_manager.getParentMachineDefinition(global_container_stack.definition)
  808. quality_changes_profiles = quality_manager.findQualityChangesByName(quality_changes_name, global_machine_definition)
  809. global_quality_changes = [qcp for qcp in quality_changes_profiles if qcp.getMetaDataEntry("extruder") is None]
  810. if global_quality_changes:
  811. global_quality_changes = global_quality_changes[0]
  812. else:
  813. Logger.log("e", "Could not find the global quality changes container with name %s", quality_changes_name)
  814. return None
  815. material = global_container_stack.material
  816. # find a quality type that matches both machine and materials
  817. if self._new_material_container and self._active_container_stack.getId() == global_container_stack.getId():
  818. material = self._new_material_container
  819. # For the global stack, find a quality which matches the quality_type in
  820. # the quality changes profile and also satisfies any material constraints.
  821. quality_type = global_quality_changes.getMetaDataEntry("quality_type")
  822. extruder_stacks = ExtruderManager.getInstance().getActiveExtruderStacks()
  823. # append the extruder quality changes
  824. for extruder_stack in extruder_stacks:
  825. extruder_definition = quality_manager.getParentMachineDefinition(extruder_stack.definition)
  826. quality_changes_list = [qcp for qcp in quality_changes_profiles if qcp.getMetaDataEntry("extruder") == extruder_definition.getId()]
  827. if quality_changes_list:
  828. quality_changes = quality_changes_list[0]
  829. else:
  830. quality_changes = global_quality_changes
  831. if not quality_changes:
  832. quality_changes = self._empty_quality_changes_container
  833. material = extruder_stack.material
  834. if self._new_material_container and self._active_container_stack.getId() == extruder_stack.getId():
  835. material = self._new_material_container
  836. quality = quality_manager.findQualityByQualityType(quality_type, global_machine_definition, [material])
  837. if not quality:
  838. # No quality profile found for this quality type.
  839. quality = self._empty_quality_container
  840. result.append({
  841. "stack": extruder_stack,
  842. "quality": quality,
  843. "quality_changes": quality_changes
  844. })
  845. # append the global quality changes
  846. global_quality = quality_manager.findQualityByQualityType(quality_type, global_machine_definition, [material], global_quality = True)
  847. # if there is not global quality but we're using a single extrusion machine, copy the quality of the first extruder - CURA-4482
  848. if not global_quality and len(extruder_stacks) == 1:
  849. global_quality = result[0]["quality_changes"]
  850. # if still no global quality changes are found we set it to empty (not supported)
  851. if not global_quality:
  852. global_quality = self._empty_quality_container
  853. result.append({
  854. "stack": global_container_stack,
  855. "quality": global_quality,
  856. "quality_changes": global_quality_changes
  857. })
  858. return result
  859. def _replaceQualityOrQualityChangesInStack(self, stack: "CuraContainerStack", container: "InstanceContainer", postpone_emit = False):
  860. # Disconnect the signal handling from the old container.
  861. container_type = container.getMetaDataEntry("type")
  862. if container_type == "quality":
  863. stack.quality.nameChanged.disconnect(self._onQualityNameChanged)
  864. stack.setQuality(container, postpone_emit = postpone_emit)
  865. stack.quality.nameChanged.connect(self._onQualityNameChanged)
  866. elif container_type == "quality_changes" or container_type is None:
  867. # If the container is an empty container, we need to change the quality_changes.
  868. # Quality can never be set to empty.
  869. stack.qualityChanges.nameChanged.disconnect(self._onQualityNameChanged)
  870. stack.setQualityChanges(container, postpone_emit = postpone_emit)
  871. stack.qualityChanges.nameChanged.connect(self._onQualityNameChanged)
  872. self._onQualityNameChanged()
  873. @pyqtProperty(str, notify = activeVariantChanged)
  874. def activeVariantName(self) -> str:
  875. if self._active_container_stack:
  876. variant = self._active_container_stack.variant
  877. if variant:
  878. return variant.getName()
  879. return ""
  880. @pyqtProperty(str, notify = activeVariantChanged)
  881. def activeVariantId(self) -> str:
  882. if self._active_container_stack:
  883. variant = self._active_container_stack.variant
  884. if variant:
  885. return variant.getId()
  886. return ""
  887. @pyqtProperty(str, notify = globalContainerChanged)
  888. def activeDefinitionId(self) -> str:
  889. if self._global_container_stack:
  890. definition = self._global_container_stack.getBottom()
  891. if definition:
  892. return definition.id
  893. return ""
  894. @pyqtProperty(str, notify=globalContainerChanged)
  895. def activeDefinitionName(self) -> str:
  896. if self._global_container_stack:
  897. definition = self._global_container_stack.getBottom()
  898. if definition:
  899. return definition.getName()
  900. return ""
  901. ## Get the Definition ID to use to select quality profiles for the currently active machine
  902. # \returns DefinitionID (string) if found, empty string otherwise
  903. # \sa getQualityDefinitionId
  904. @pyqtProperty(str, notify = globalContainerChanged)
  905. def activeQualityDefinitionId(self) -> str:
  906. if self._global_container_stack:
  907. return self.getQualityDefinitionId(self._global_container_stack.getBottom())
  908. return ""
  909. ## Get the Definition ID to use to select quality profiles for machines of the specified definition
  910. # This is normally the id of the definition itself, but machines can specify a different definition to inherit qualities from
  911. # \param definition (DefinitionContainer) machine definition
  912. # \returns DefinitionID (string) if found, empty string otherwise
  913. def getQualityDefinitionId(self, definition: "DefinitionContainer") -> str:
  914. return QualityManager.getInstance().getParentMachineDefinition(definition).getId()
  915. ## Get the Variant ID to use to select quality profiles for the currently active variant
  916. # \returns VariantID (string) if found, empty string otherwise
  917. # \sa getQualityVariantId
  918. @pyqtProperty(str, notify = activeVariantChanged)
  919. def activeQualityVariantId(self) -> str:
  920. if self._active_container_stack:
  921. variant = self._active_container_stack.variant
  922. if variant:
  923. return self.getQualityVariantId(self._global_container_stack.getBottom(), variant)
  924. return ""
  925. ## Get the Variant ID to use to select quality profiles for variants of the specified definitions
  926. # This is normally the id of the variant itself, but machines can specify a different definition
  927. # to inherit qualities from, which has consequences for the variant to use as well
  928. # \param definition (DefinitionContainer) machine definition
  929. # \param variant (InstanceContainer) variant definition
  930. # \returns VariantID (string) if found, empty string otherwise
  931. def getQualityVariantId(self, definition: "DefinitionContainer", variant: "InstanceContainer") -> str:
  932. variant_id = variant.getId()
  933. definition_id = definition.getId()
  934. quality_definition_id = self.getQualityDefinitionId(definition)
  935. if definition_id != quality_definition_id:
  936. variant_id = variant_id.replace(definition_id, quality_definition_id, 1)
  937. return variant_id
  938. ## Gets how the active definition calls variants
  939. # Caveat: per-definition-variant-title is currently not translated (though the fallback is)
  940. @pyqtProperty(str, notify = globalContainerChanged)
  941. def activeDefinitionVariantsName(self) -> str:
  942. fallback_title = catalog.i18nc("@label", "Nozzle")
  943. if self._global_container_stack:
  944. return self._global_container_stack.getBottom().getMetaDataEntry("variants_name", fallback_title)
  945. return fallback_title
  946. @pyqtSlot(str, str)
  947. def renameMachine(self, machine_id: str, new_name: str):
  948. container_registry = ContainerRegistry.getInstance()
  949. machine_stack = container_registry.findContainerStacks(id = machine_id)
  950. if machine_stack:
  951. new_name = container_registry.createUniqueName("machine", machine_stack[0].getName(), new_name, machine_stack[0].getBottom().getName())
  952. machine_stack[0].setName(new_name)
  953. self.globalContainerChanged.emit()
  954. @pyqtSlot(str)
  955. def removeMachine(self, machine_id: str):
  956. # If the machine that is being removed is the currently active machine, set another machine as the active machine.
  957. activate_new_machine = (self._global_container_stack and self._global_container_stack.getId() == machine_id)
  958. # activate a new machine before removing a machine because this is safer
  959. if activate_new_machine:
  960. machine_stacks = ContainerRegistry.getInstance().findContainerStacks(type = "machine")
  961. other_machine_stacks = [s for s in machine_stacks if s.getId() != machine_id]
  962. if other_machine_stacks:
  963. self.setActiveMachine(other_machine_stacks[0].getId())
  964. ExtruderManager.getInstance().removeMachineExtruders(machine_id)
  965. containers = ContainerRegistry.getInstance().findInstanceContainers(type = "user", machine = machine_id)
  966. for container in containers:
  967. ContainerRegistry.getInstance().removeContainer(container.getId())
  968. ContainerRegistry.getInstance().removeContainer(machine_id)
  969. @pyqtProperty(bool, notify = globalContainerChanged)
  970. def hasMaterials(self) -> bool:
  971. if self._global_container_stack:
  972. return bool(self._global_container_stack.getMetaDataEntry("has_materials", False))
  973. return False
  974. @pyqtProperty(bool, notify = globalContainerChanged)
  975. def hasVariants(self) -> bool:
  976. if self._global_container_stack:
  977. return bool(self._global_container_stack.getMetaDataEntry("has_variants", False))
  978. return False
  979. ## Property to indicate if a machine has "specialized" material profiles.
  980. # Some machines have their own material profiles that "override" the default catch all profiles.
  981. @pyqtProperty(bool, notify = globalContainerChanged)
  982. def filterMaterialsByMachine(self) -> bool:
  983. if self._global_container_stack:
  984. return bool(self._global_container_stack.getMetaDataEntry("has_machine_materials", False))
  985. return False
  986. ## Property to indicate if a machine has "specialized" quality profiles.
  987. # Some machines have their own quality profiles that "override" the default catch all profiles.
  988. @pyqtProperty(bool, notify = globalContainerChanged)
  989. def filterQualityByMachine(self) -> bool:
  990. if self._global_container_stack:
  991. return bool(self._global_container_stack.getMetaDataEntry("has_machine_quality", False))
  992. return False
  993. ## Get the Definition ID of a machine (specified by ID)
  994. # \param machine_id string machine id to get the definition ID of
  995. # \returns DefinitionID (string) if found, None otherwise
  996. @pyqtSlot(str, result = str)
  997. def getDefinitionByMachineId(self, machine_id: str) -> str:
  998. containers = ContainerRegistry.getInstance().findContainerStacks(id=machine_id)
  999. if containers:
  1000. return containers[0].getBottom().getId()
  1001. @staticmethod
  1002. def createMachineManager():
  1003. return MachineManager()
  1004. @deprecated("Use ExtruderStack.material = ... and it won't be necessary", "2.7")
  1005. def _updateMaterialContainer(self, definition: "DefinitionContainer", stack: "ContainerStack", variant_container: Optional["InstanceContainer"] = None, preferred_material_name: Optional[str] = None) -> InstanceContainer:
  1006. if not definition.getMetaDataEntry("has_materials"):
  1007. return self._empty_material_container
  1008. approximate_material_diameter = str(round(stack.getProperty("material_diameter", "value")))
  1009. search_criteria = { "type": "material", "approximate_diameter": approximate_material_diameter }
  1010. if definition.getMetaDataEntry("has_machine_materials"):
  1011. search_criteria["definition"] = self.getQualityDefinitionId(definition)
  1012. if definition.getMetaDataEntry("has_variants") and variant_container:
  1013. search_criteria["variant"] = self.getQualityVariantId(definition, variant_container)
  1014. else:
  1015. search_criteria["definition"] = "fdmprinter"
  1016. if preferred_material_name:
  1017. search_criteria["name"] = preferred_material_name
  1018. else:
  1019. preferred_material = definition.getMetaDataEntry("preferred_material")
  1020. if preferred_material:
  1021. search_criteria["id"] = preferred_material
  1022. containers = ContainerRegistry.getInstance().findInstanceContainers(**search_criteria)
  1023. if containers:
  1024. return containers[0]
  1025. if "variant" in search_criteria or "id" in search_criteria:
  1026. # If a material by this name can not be found, try a wider set of search criteria
  1027. search_criteria.pop("variant", None)
  1028. search_criteria.pop("id", None)
  1029. containers = ContainerRegistry.getInstance().findInstanceContainers(**search_criteria)
  1030. if containers:
  1031. return containers[0]
  1032. Logger.log("w", "Unable to find a material container with provided criteria, returning an empty one instead.")
  1033. return self._empty_material_container
  1034. def _onMachineNameChanged(self):
  1035. self.globalContainerChanged.emit()
  1036. def _onMaterialNameChanged(self):
  1037. self.activeMaterialChanged.emit()
  1038. def _onQualityNameChanged(self):
  1039. self.activeQualityChanged.emit()
  1040. def _getContainerChangedSignals(self) -> List[Signal]:
  1041. stacks = ExtruderManager.getInstance().getActiveExtruderStacks()
  1042. stacks.append(self._global_container_stack)
  1043. return [ s.containersChanged for s in stacks ]