MachineManager.py 61 KB

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