ExtrudersModel.py 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. # Copyright (c) 2018 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. from PyQt5.QtCore import Qt, pyqtSignal, pyqtProperty, QTimer
  4. from typing import Iterable
  5. from UM.i18n import i18nCatalog
  6. import UM.Qt.ListModel
  7. from UM.Application import Application
  8. import UM.FlameProfiler
  9. from cura.Settings.ExtruderStack import ExtruderStack # To listen to changes on the extruders.
  10. catalog = i18nCatalog("cura")
  11. ## Model that holds extruders.
  12. #
  13. # This model is designed for use by any list of extruders, but specifically
  14. # intended for drop-down lists of the current machine's extruders in place of
  15. # settings.
  16. class ExtrudersModel(UM.Qt.ListModel.ListModel):
  17. # The ID of the container stack for the extruder.
  18. IdRole = Qt.UserRole + 1
  19. ## Human-readable name of the extruder.
  20. NameRole = Qt.UserRole + 2
  21. ## Colour of the material loaded in the extruder.
  22. ColorRole = Qt.UserRole + 3
  23. ## Index of the extruder, which is also the value of the setting itself.
  24. #
  25. # An index of 0 indicates the first extruder, an index of 1 the second
  26. # one, and so on. This is the value that will be saved in instance
  27. # containers.
  28. IndexRole = Qt.UserRole + 4
  29. # The ID of the definition of the extruder.
  30. DefinitionRole = Qt.UserRole + 5
  31. # The material of the extruder.
  32. MaterialRole = Qt.UserRole + 6
  33. # The variant of the extruder.
  34. VariantRole = Qt.UserRole + 7
  35. StackRole = Qt.UserRole + 8
  36. MaterialBrandRole = Qt.UserRole + 9
  37. ColorNameRole = Qt.UserRole + 10
  38. ## Is the extruder enabled?
  39. EnabledRole = Qt.UserRole + 11
  40. ## List of colours to display if there is no material or the material has no known
  41. # colour.
  42. defaultColors = ["#ffc924", "#86ec21", "#22eeee", "#245bff", "#9124ff", "#ff24c8"]
  43. ## Initialises the extruders model, defining the roles and listening for
  44. # changes in the data.
  45. #
  46. # \param parent Parent QtObject of this list.
  47. def __init__(self, parent = None):
  48. super().__init__(parent)
  49. self.addRoleName(self.IdRole, "id")
  50. self.addRoleName(self.NameRole, "name")
  51. self.addRoleName(self.EnabledRole, "enabled")
  52. self.addRoleName(self.ColorRole, "color")
  53. self.addRoleName(self.IndexRole, "index")
  54. self.addRoleName(self.DefinitionRole, "definition")
  55. self.addRoleName(self.MaterialRole, "material")
  56. self.addRoleName(self.VariantRole, "variant")
  57. self.addRoleName(self.StackRole, "stack")
  58. self.addRoleName(self.MaterialBrandRole, "material_brand")
  59. self.addRoleName(self.ColorNameRole, "color_name")
  60. self._update_extruder_timer = QTimer()
  61. self._update_extruder_timer.setInterval(100)
  62. self._update_extruder_timer.setSingleShot(True)
  63. self._update_extruder_timer.timeout.connect(self.__updateExtruders)
  64. self._active_machine_extruders = [] # type: Iterable[ExtruderStack]
  65. self._add_optional_extruder = False
  66. # Listen to changes
  67. Application.getInstance().globalContainerStackChanged.connect(self._extrudersChanged) # When the machine is swapped we must update the active machine extruders
  68. Application.getInstance().getExtruderManager().extrudersChanged.connect(self._extrudersChanged) # When the extruders change we must link to the stack-changed signal of the new extruder
  69. Application.getInstance().getContainerRegistry().containerMetaDataChanged.connect(self._onExtruderStackContainersChanged) # When meta data from a material container changes we must update
  70. self._extrudersChanged() # Also calls _updateExtruders
  71. addOptionalExtruderChanged = pyqtSignal()
  72. def setAddOptionalExtruder(self, add_optional_extruder):
  73. if add_optional_extruder != self._add_optional_extruder:
  74. self._add_optional_extruder = add_optional_extruder
  75. self.addOptionalExtruderChanged.emit()
  76. self._updateExtruders()
  77. @pyqtProperty(bool, fset = setAddOptionalExtruder, notify = addOptionalExtruderChanged)
  78. def addOptionalExtruder(self):
  79. return self._add_optional_extruder
  80. ## Links to the stack-changed signal of the new extruders when an extruder
  81. # is swapped out or added in the current machine.
  82. #
  83. # \param machine_id The machine for which the extruders changed. This is
  84. # filled by the ExtruderManager.extrudersChanged signal when coming from
  85. # that signal. Application.globalContainerStackChanged doesn't fill this
  86. # signal; it's assumed to be the current printer in that case.
  87. def _extrudersChanged(self, machine_id = None):
  88. machine_manager = Application.getInstance().getMachineManager()
  89. if machine_id is not None:
  90. if machine_manager.activeMachine is None:
  91. # No machine, don't need to update the current machine's extruders
  92. return
  93. if machine_id != machine_manager.activeMachine.getId():
  94. # Not the current machine
  95. return
  96. # Unlink from old extruders
  97. for extruder in self._active_machine_extruders:
  98. extruder.containersChanged.disconnect(self._onExtruderStackContainersChanged)
  99. extruder.enabledChanged.disconnect(self._updateExtruders)
  100. # Link to new extruders
  101. self._active_machine_extruders = []
  102. extruder_manager = Application.getInstance().getExtruderManager()
  103. for extruder in extruder_manager.getActiveExtruderStacks():
  104. if extruder is None: #This extruder wasn't loaded yet. This happens asynchronously while this model is constructed from QML.
  105. continue
  106. extruder.containersChanged.connect(self._onExtruderStackContainersChanged)
  107. extruder.enabledChanged.connect(self._updateExtruders)
  108. self._active_machine_extruders.append(extruder)
  109. self._updateExtruders() # Since the new extruders may have different properties, update our own model.
  110. def _onExtruderStackContainersChanged(self, container):
  111. # Update when there is an empty container or material or variant change
  112. if container.getMetaDataEntry("type") in ["material", "variant", None]:
  113. # The ExtrudersModel needs to be updated when the material-name or -color changes, because the user identifies extruders by material-name
  114. self._updateExtruders()
  115. modelChanged = pyqtSignal()
  116. def _updateExtruders(self):
  117. self._update_extruder_timer.start()
  118. ## Update the list of extruders.
  119. #
  120. # This should be called whenever the list of extruders changes.
  121. @UM.FlameProfiler.profile
  122. def __updateExtruders(self):
  123. extruders_changed = False
  124. if self.count != 0:
  125. extruders_changed = True
  126. items = []
  127. global_container_stack = Application.getInstance().getGlobalContainerStack()
  128. if global_container_stack:
  129. # get machine extruder count for verification
  130. machine_extruder_count = global_container_stack.getProperty("machine_extruder_count", "value")
  131. for extruder in Application.getInstance().getExtruderManager().getActiveExtruderStacks():
  132. position = extruder.getMetaDataEntry("position", default = "0")
  133. try:
  134. position = int(position)
  135. except ValueError:
  136. # Not a proper int.
  137. position = -1
  138. if position >= machine_extruder_count:
  139. continue
  140. default_color = self.defaultColors[position] if 0 <= position < len(self.defaultColors) else self.defaultColors[0]
  141. color = extruder.material.getMetaDataEntry("color_code", default = default_color) if extruder.material else default_color
  142. material_brand = extruder.material.getMetaDataEntry("brand", default = "generic")
  143. color_name = extruder.material.getMetaDataEntry("color_name")
  144. # construct an item with only the relevant information
  145. item = {
  146. "id": extruder.getId(),
  147. "name": extruder.getName(),
  148. "enabled": extruder.isEnabled,
  149. "color": color,
  150. "index": position,
  151. "definition": extruder.getBottom().getId(),
  152. "material": extruder.material.getName() if extruder.material else "",
  153. "variant": extruder.variant.getName() if extruder.variant else "", # e.g. print core
  154. "stack": extruder,
  155. "material_brand": material_brand,
  156. "color_name": color_name
  157. }
  158. items.append(item)
  159. extruders_changed = True
  160. if extruders_changed:
  161. # sort by extruder index
  162. items.sort(key = lambda i: i["index"])
  163. # We need optional extruder to be last, so add it after we do sorting.
  164. # This way we can simply interpret the -1 of the index as the last item (which it now always is)
  165. if self._add_optional_extruder:
  166. item = {
  167. "id": "",
  168. "name": catalog.i18nc("@menuitem", "Not overridden"),
  169. "enabled": True,
  170. "color": "#ffffff",
  171. "index": -1,
  172. "definition": "",
  173. "material": "",
  174. "variant": "",
  175. "stack": None,
  176. "material_brand": "",
  177. "color_name": "",
  178. }
  179. items.append(item)
  180. if self._items != items:
  181. self.setItems(items)
  182. self.modelChanged.emit()