ExtrudersModel.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  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, TYPE_CHECKING
  5. from UM.i18n import i18nCatalog
  6. from UM.Qt.ListModel import ListModel
  7. from UM.Application import Application
  8. import UM.FlameProfiler
  9. if TYPE_CHECKING:
  10. from cura.Settings.ExtruderStack import ExtruderStack # To listen to changes on the extruders.
  11. catalog = i18nCatalog("cura")
  12. class ExtrudersModel(ListModel):
  13. """Model that holds extruders.
  14. This model is designed for use by any list of extruders, but specifically intended for drop-down lists of the
  15. current machine's extruders in place of settings.
  16. """
  17. # The ID of the container stack for the extruder.
  18. IdRole = Qt.UserRole + 1
  19. NameRole = Qt.UserRole + 2
  20. """Human-readable name of the extruder."""
  21. ColorRole = Qt.UserRole + 3
  22. """Colour of the material loaded in the extruder."""
  23. IndexRole = Qt.UserRole + 4
  24. """Index of the extruder, which is also the value of the setting itself.
  25. An index of 0 indicates the first extruder, an index of 1 the second one, and so on. This is the value that will
  26. be saved in instance containers. """
  27. # The ID of the definition of the extruder.
  28. DefinitionRole = Qt.UserRole + 5
  29. # The material of the extruder.
  30. MaterialRole = Qt.UserRole + 6
  31. # The variant of the extruder.
  32. VariantRole = Qt.UserRole + 7
  33. StackRole = Qt.UserRole + 8
  34. MaterialBrandRole = Qt.UserRole + 9
  35. ColorNameRole = Qt.UserRole + 10
  36. EnabledRole = Qt.UserRole + 11
  37. """Is the extruder enabled?"""
  38. MaterialTypeRole = Qt.UserRole + 12
  39. """The type of the material (e.g. PLA, ABS, PETG, etc.)."""
  40. defaultColors = ["#ffc924", "#86ec21", "#22eeee", "#245bff", "#9124ff", "#ff24c8"]
  41. """List of colours to display if there is no material or the material has no known colour. """
  42. MaterialNameRole = Qt.UserRole + 13
  43. def __init__(self, parent = None):
  44. """Initialises the extruders model, defining the roles and listening for changes in the data.
  45. :param parent: Parent QtObject of this list.
  46. """
  47. super().__init__(parent)
  48. self.addRoleName(self.IdRole, "id")
  49. self.addRoleName(self.NameRole, "name")
  50. self.addRoleName(self.EnabledRole, "enabled")
  51. self.addRoleName(self.ColorRole, "color")
  52. self.addRoleName(self.IndexRole, "index")
  53. self.addRoleName(self.DefinitionRole, "definition")
  54. self.addRoleName(self.MaterialRole, "material")
  55. self.addRoleName(self.VariantRole, "variant")
  56. self.addRoleName(self.StackRole, "stack")
  57. self.addRoleName(self.MaterialBrandRole, "material_brand")
  58. self.addRoleName(self.ColorNameRole, "color_name")
  59. self.addRoleName(self.MaterialTypeRole, "material_type")
  60. self.addRoleName(self.MaterialNameRole, "material_name")
  61. self._update_extruder_timer = QTimer()
  62. self._update_extruder_timer.setInterval(100)
  63. self._update_extruder_timer.setSingleShot(True)
  64. self._update_extruder_timer.timeout.connect(self.__updateExtruders)
  65. self._active_machine_extruders = [] # type: Iterable[ExtruderStack]
  66. self._add_optional_extruder = False
  67. # Listen to changes
  68. Application.getInstance().globalContainerStackChanged.connect(self._extrudersChanged) # When the machine is swapped we must update the active machine extruders
  69. Application.getInstance().getExtruderManager().extrudersChanged.connect(self._extrudersChanged) # When the extruders change we must link to the stack-changed signal of the new extruder
  70. Application.getInstance().getContainerRegistry().containerMetaDataChanged.connect(self._onExtruderStackContainersChanged) # When meta data from a material container changes we must update
  71. self._extrudersChanged() # Also calls _updateExtruders
  72. addOptionalExtruderChanged = pyqtSignal()
  73. def setAddOptionalExtruder(self, add_optional_extruder):
  74. if add_optional_extruder != self._add_optional_extruder:
  75. self._add_optional_extruder = add_optional_extruder
  76. self.addOptionalExtruderChanged.emit()
  77. self._updateExtruders()
  78. @pyqtProperty(bool, fset = setAddOptionalExtruder, notify = addOptionalExtruderChanged)
  79. def addOptionalExtruder(self):
  80. return self._add_optional_extruder
  81. def _extrudersChanged(self, machine_id = None):
  82. """Links to the stack-changed signal of the new extruders when an extruder is swapped out or added in the
  83. current machine.
  84. :param machine_id: The machine for which the extruders changed. This is filled by the
  85. ExtruderManager.extrudersChanged signal when coming from that signal. Application.globalContainerStackChanged
  86. doesn't fill this signal; it's assumed to be the current printer in that case.
  87. """
  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. @UM.FlameProfiler.profile
  119. def __updateExtruders(self):
  120. """Update the list of extruders.
  121. This should be called whenever the list of extruders changes.
  122. """
  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. "material_type": extruder.material.getMetaDataEntry("material") if extruder.material else "",
  158. "material_name": extruder.material.getMetaDataEntry("name") if extruder.material else "",
  159. }
  160. items.append(item)
  161. extruders_changed = True
  162. if extruders_changed:
  163. # sort by extruder index
  164. items.sort(key = lambda i: i["index"])
  165. # We need optional extruder to be last, so add it after we do sorting.
  166. # This way we can simply interpret the -1 of the index as the last item (which it now always is)
  167. if self._add_optional_extruder:
  168. item = {
  169. "id": "",
  170. "name": catalog.i18nc("@menuitem", "Not overridden"),
  171. "enabled": True,
  172. "color": "transparent",
  173. "index": -1,
  174. "definition": "",
  175. "material": "",
  176. "variant": "",
  177. "stack": None,
  178. "material_brand": "",
  179. "color_name": "",
  180. "material_type": "",
  181. "material_label": ""
  182. }
  183. items.append(item)
  184. if self._items != items:
  185. self.setItems(items)
  186. self.modelChanged.emit()