# Copyright (c) 2022 Ultimaker B.V. # Cura is released under the terms of the LGPLv3 or higher. from PyQt6.QtCore import pyqtSignal, pyqtProperty, QObject, QVariant # For communicating data and events to Qt. from UM.Application import Application from UM.FlameProfiler import pyqtSlot import cura.CuraApplication # To get the global container stack to find the current machine. from UM.Util import parseBool from cura.Settings.GlobalStack import GlobalStack from UM.Logger import Logger from UM.Scene.Iterator.DepthFirstIterator import DepthFirstIterator from UM.Scene.Selection import Selection from UM.Scene.Iterator.BreadthFirstIterator import BreadthFirstIterator from UM.Settings.ContainerRegistry import ContainerRegistry # Finding containers by ID. from cura.Machines.ContainerTree import ContainerTree from typing import Any, cast, Dict, List, Optional, TYPE_CHECKING, Union if TYPE_CHECKING: from cura.Settings.ExtruderStack import ExtruderStack class ExtruderManager(QObject): """Manages all existing extruder stacks. This keeps a list of extruder stacks for each machine. """ def __init__(self, parent = None): """Registers listeners and such to listen to changes to the extruders.""" if ExtruderManager.__instance is not None: raise RuntimeError("Try to create singleton '%s' more than once" % self.__class__.__name__) super().__init__(parent) ExtruderManager.__instance = self self._application = cura.CuraApplication.CuraApplication.getInstance() # Per machine, a dictionary of extruder container stack IDs. Only for separately defined extruders. self._extruder_trains = {} # type: Dict[str, Dict[str, "ExtruderStack"]] self._active_extruder_index = -1 # Indicates the index of the active extruder stack. -1 means no active extruder stack # TODO; I have no idea why this is a union of ID's and extruder stacks. This needs to be fixed at some point. self._selected_object_extruders = [] # type: List[Union[str, "ExtruderStack"]] Selection.selectionChanged.connect(self.resetSelectedObjectExtruders) Application.getInstance().globalContainerStackChanged.connect(self.emitGlobalStackExtrudersChanged) # When the machine is swapped we must update the active machine extruders extrudersChanged = pyqtSignal(QVariant) """Signal to notify other components when the list of extruders for a machine definition changes.""" activeExtruderChanged = pyqtSignal() """Notify when the user switches the currently active extruder.""" def emitGlobalStackExtrudersChanged(self): # HACK # The emit function can't be directly connected to another signal. This wrapper function is required. # The extrudersChanged signal is emitted early when changing machines. This triggers it a second time # after the extruder have changed properly. This is important for any QML using ExtruderManager.extruderIds # This is a hack, but other behaviour relys on the updating in this order. self.extrudersChanged.emit(self._application.getGlobalContainerStack().getId()) @pyqtProperty(int, notify = extrudersChanged) def enabledExtruderCount(self) -> int: global_container_stack = self._application.getGlobalContainerStack() if global_container_stack: return len([extruder for extruder in global_container_stack.extruderList if parseBool(extruder.getMetaDataEntry("enabled", "True"))]) return 0 @pyqtProperty(str, notify = activeExtruderChanged) def activeExtruderStackId(self) -> Optional[str]: """Gets the unique identifier of the currently active extruder stack. The currently active extruder stack is the stack that is currently being edited. :return: The unique ID of the currently active extruder stack. """ if not self._application.getGlobalContainerStack(): return None # No active machine, so no active extruder. try: return self._extruder_trains[self._application.getGlobalContainerStack().getId()][str(self.activeExtruderIndex)].getId() except KeyError: # Extruder index could be -1 if the global tab is selected, or the entry doesn't exist if the machine definition is wrong. return None @pyqtProperty("QVariantMap", notify = extrudersChanged) def extruderIds(self) -> Dict[str, str]: """Gets a dict with the extruder stack ids with the extruder number as the key.""" extruder_stack_ids = {} # type: Dict[str, str] global_container_stack = self._application.getGlobalContainerStack() if global_container_stack: extruder_stack_ids = {extruder.getMetaDataEntry("position", ""): extruder.id for extruder in global_container_stack.extruderList} return extruder_stack_ids @pyqtSlot(int) def setActiveExtruderIndex(self, index: int) -> None: """Changes the active extruder by index. :param index: The index of the new active extruder. """ if self._active_extruder_index != index: self._active_extruder_index = index self.activeExtruderChanged.emit() @pyqtProperty(int, notify = activeExtruderChanged) def activeExtruderIndex(self) -> int: return self._active_extruder_index selectedObjectExtrudersChanged = pyqtSignal() """Emitted whenever the selectedObjectExtruders property changes.""" @pyqtProperty("QVariantList", notify = selectedObjectExtrudersChanged) def selectedObjectExtruders(self) -> List[Union[str, "ExtruderStack"]]: """Provides a list of extruder IDs used by the current selected objects.""" if not self._selected_object_extruders: object_extruders = set() # First, build a list of the actual selected objects (including children of groups, excluding group nodes) selected_nodes = [] # type: List["SceneNode"] for node in Selection.getAllSelectedObjects(): if node.callDecoration("isGroup"): for grouped_node in BreadthFirstIterator(node): if grouped_node.callDecoration("isGroup"): continue selected_nodes.append(grouped_node) else: selected_nodes.append(node) # Then, figure out which nodes are used by those selected nodes. current_extruder_trains = self.getActiveExtruderStacks() for node in selected_nodes: extruder = node.callDecoration("getActiveExtruder") if extruder: object_extruders.add(extruder) elif current_extruder_trains: object_extruders.add(current_extruder_trains[0].getId()) self._selected_object_extruders = list(object_extruders) return self._selected_object_extruders def resetSelectedObjectExtruders(self) -> None: """Reset the internal list used for the selectedObjectExtruders property This will trigger a recalculation of the extruders used for the selection. """ self._selected_object_extruders = [] self.selectedObjectExtrudersChanged.emit() @pyqtSlot(result = QObject) def getActiveExtruderStack(self) -> Optional["ExtruderStack"]: return self.getExtruderStack(self.activeExtruderIndex) def getExtruderStack(self, index) -> Optional["ExtruderStack"]: """Get an extruder stack by index""" global_container_stack = self._application.getGlobalContainerStack() if global_container_stack: if global_container_stack.getId() in self._extruder_trains: if str(index) in self._extruder_trains[global_container_stack.getId()]: return self._extruder_trains[global_container_stack.getId()][str(index)] return None def getAllExtruderSettings(self, setting_key: str, prop: str) -> List[Any]: """Gets a property of a setting for all extruders. :param setting_key: :type{str} The setting to get the property of. :param prop: :type{str} The property to get. :return: :type{List} the list of results """ result = [] for extruder_stack in self.getActiveExtruderStacks(): result.append(extruder_stack.getProperty(setting_key, prop)) return result def extruderValueWithDefault(self, value: str) -> str: machine_manager = self._application.getMachineManager() if value == "-1": return machine_manager.defaultExtruderPosition else: return value def getUsedExtruderStacks(self) -> List["ExtruderStack"]: """Gets the extruder stacks that are actually being used at the moment. An extruder stack is being used if it is the extruder to print any mesh with, or if it is the support infill extruder, the support interface extruder, or the bed adhesion extruder. If there are no extruders, this returns the global stack as a singleton list. :return: A list of extruder stacks. """ global_stack = self._application.getGlobalContainerStack() container_registry = ContainerRegistry.getInstance() used_extruder_stack_ids = set() # Get the extruders of all meshes in the scene support_enabled = False support_bottom_enabled = False support_roof_enabled = False scene_root = self._application.getController().getScene().getRoot() # If no extruders are registered in the extruder manager yet, return an empty array if len(self.extruderIds) == 0: return [] number_active_extruders = len([extruder for extruder in self.getActiveExtruderStacks() if extruder.isEnabled]) # Get the extruders of all printable meshes in the scene nodes = [node for node in DepthFirstIterator(scene_root) if node.isSelectable() and not node.callDecoration("isAntiOverhangMesh") and not node.callDecoration("isSupportMesh")] #type: ignore #Ignore type error because iter() should get called automatically by Python syntax. for node in nodes: extruder_stack_id = node.callDecoration("getActiveExtruder") if not extruder_stack_id: # No per-object settings for this node extruder_stack_id = self.extruderIds["0"] used_extruder_stack_ids.add(extruder_stack_id) if len(used_extruder_stack_ids) == number_active_extruders: # We're already done. Stop looking. # Especially with a lot of models on the buildplate, this will speed up things rather dramatically. break # Get whether any of them use support. stack_to_use = node.callDecoration("getStack") # if there is a per-mesh stack, we use it if not stack_to_use: # if there is no per-mesh stack, we use the build extruder for this mesh stack_to_use = container_registry.findContainerStacks(id = extruder_stack_id)[0] if not support_enabled: support_enabled |= stack_to_use.getProperty("support_enable", "value") if not support_bottom_enabled: support_bottom_enabled |= stack_to_use.getProperty("support_bottom_enable", "value") if not support_roof_enabled: support_roof_enabled |= stack_to_use.getProperty("support_roof_enable", "value") # Check limit to extruders limit_to_extruder_feature_list = ["wall_0_extruder_nr", "wall_x_extruder_nr", "roofing_extruder_nr", "top_bottom_extruder_nr", "infill_extruder_nr", ] for extruder_nr_feature_name in limit_to_extruder_feature_list: extruder_nr = int(global_stack.getProperty(extruder_nr_feature_name, "value")) if extruder_nr == -1: continue if str(extruder_nr) not in self.extruderIds: extruder_nr = int(self._application.getMachineManager().defaultExtruderPosition) used_extruder_stack_ids.add(self.extruderIds[str(extruder_nr)]) # Check support extruders if support_enabled: used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_infill_extruder_nr", "value")))]) used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_extruder_nr_layer_0", "value")))]) if support_bottom_enabled: used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_bottom_extruder_nr", "value")))]) if support_roof_enabled: used_extruder_stack_ids.add(self.extruderIds[self.extruderValueWithDefault(str(global_stack.getProperty("support_roof_extruder_nr", "value")))]) # The platform adhesion extruders. used_adhesion_extruders = set() adhesion_type = global_stack.getProperty("adhesion_type", "value") if adhesion_type == "skirt" and (global_stack.getProperty("skirt_line_count", "value") > 0 or global_stack.getProperty("skirt_brim_minimal_length", "value") > 0): used_adhesion_extruders.add("skirt_brim_extruder_nr") # There's a skirt. if (adhesion_type == "brim" or global_stack.getProperty("prime_tower_brim_enable", "value")) and (global_stack.getProperty("brim_line_count", "value") > 0 or global_stack.getProperty("skirt_brim_minimal_length", "value") > 0): used_adhesion_extruders.add("skirt_brim_extruder_nr") # There's a brim or prime tower brim. if adhesion_type == "raft": used_adhesion_extruders.add("raft_base_extruder_nr") if global_stack.getProperty("raft_interface_layers", "value") > 0: used_adhesion_extruders.add("raft_interface_extruder_nr") if global_stack.getProperty("raft_surface_layers", "value") > 0: used_adhesion_extruders.add("raft_surface_extruder_nr") for extruder_setting in used_adhesion_extruders: extruder_str_nr = str(global_stack.getProperty(extruder_setting, "value")) if extruder_str_nr == "-1": continue # An optional extruder doesn't force any extruder to be used if it isn't used already if extruder_str_nr in self.extruderIds: used_extruder_stack_ids.add(self.extruderIds[extruder_str_nr]) try: return [container_registry.findContainerStacks(id = stack_id)[0] for stack_id in used_extruder_stack_ids] except IndexError: # One or more of the extruders was not found. Logger.log("e", "Unable to find one or more of the extruders in %s", used_extruder_stack_ids) return [] def getInitialExtruderNr(self) -> int: """Get the extruder that the print will start with. This should mirror the implementation in CuraEngine of ``FffGcodeWriter::getStartExtruder()``. """ application = cura.CuraApplication.CuraApplication.getInstance() global_stack = application.getGlobalContainerStack() # Starts with the adhesion extruder. adhesion_type = global_stack.getProperty("adhesion_type", "value") if adhesion_type in {"skirt", "brim"}: skirt_brim_extruder_nr = global_stack.getProperty("skirt_brim_extruder_nr", "value") # if the skirt_brim_extruder_nr is -1, then we use the first used extruder if skirt_brim_extruder_nr == -1: used_extruders = self.getUsedExtruderStacks() return used_extruders[0].position else: return skirt_brim_extruder_nr if adhesion_type == "raft": return global_stack.getProperty("raft_base_extruder_nr", "value") # No adhesion? Well maybe there is still support brim. if (global_stack.getProperty("support_enable", "value") or global_stack.getProperty("support_structure", "value") == "tree") and global_stack.getProperty("support_brim_enable", "value"): return global_stack.getProperty("support_infill_extruder_nr", "value") # REALLY no adhesion? Use the first used extruder. return self.getUsedExtruderStacks()[0].getProperty("extruder_nr", "value") def removeMachineExtruders(self, machine_id: str) -> None: """Removes the container stack and user profile for the extruders for a specific machine. :param machine_id: The machine to remove the extruders for. """ for extruder in self.getMachineExtruders(machine_id): ContainerRegistry.getInstance().removeContainer(extruder.userChanges.getId()) ContainerRegistry.getInstance().removeContainer(extruder.definitionChanges.getId()) ContainerRegistry.getInstance().removeContainer(extruder.getId()) if machine_id in self._extruder_trains: del self._extruder_trains[machine_id] def getMachineExtruders(self, machine_id: str) -> List["ExtruderStack"]: """Returns extruders for a specific machine. :param machine_id: The machine to get the extruders of. """ if machine_id not in self._extruder_trains: return [] return [self._extruder_trains[machine_id][name] for name in self._extruder_trains[machine_id]] def getActiveExtruderStacks(self) -> List["ExtruderStack"]: """Returns the list of active extruder stacks, taking into account the machine extruder count. :return: :type{List[ContainerStack]} a list of """ global_stack = self._application.getGlobalContainerStack() if not global_stack: return [] return global_stack.extruderList def _globalContainerStackChanged(self) -> None: # If the global container changed, the machine changed and might have extruders that were not registered yet self._addCurrentMachineExtruders() self.resetSelectedObjectExtruders() def addMachineExtruders(self, global_stack: GlobalStack) -> None: """Adds the extruders to the selected machine.""" extruders_changed = False container_registry = ContainerRegistry.getInstance() global_stack_id = global_stack.getId() # Gets the extruder trains that we just created as well as any that still existed. extruder_trains = container_registry.findContainerStacks(type = "extruder_train", machine = global_stack_id) # Make sure the extruder trains for the new machine can be placed in the set of sets if global_stack_id not in self._extruder_trains: self._extruder_trains[global_stack_id] = {} extruders_changed = True # Register the extruder trains by position for extruder_train in extruder_trains: extruder_position = extruder_train.getMetaDataEntry("position") self._extruder_trains[global_stack_id][extruder_position] = extruder_train # regardless of what the next stack is, we have to set it again, because of signal routing. ??? extruder_train.setParent(global_stack) extruder_train.setNextStack(global_stack) extruders_changed = True self.fixSingleExtrusionMachineExtruderDefinition(global_stack) if extruders_changed: self.extrudersChanged.emit(global_stack_id) # After 3.4, all single-extrusion machines have their own extruder definition files instead of reusing # "fdmextruder". We need to check a machine here so its extruder definition is correct according to this. def fixSingleExtrusionMachineExtruderDefinition(self, global_stack: "GlobalStack") -> None: container_registry = ContainerRegistry.getInstance() expected_extruder_stack = global_stack.getMetaDataEntry("machine_extruder_trains") if expected_extruder_stack is None: return expected_extruder_definition_0_id = expected_extruder_stack["0"] try: extruder_stack_0 = global_stack.extruderList[0] except IndexError: extruder_stack_0 = None # At this point, extruder stacks for this machine may not have been loaded yet. In this case, need to look in # the container registry as well. if not global_stack.extruderList: extruder_trains = container_registry.findContainerStacks(type = "extruder_train", machine = global_stack.getId()) if extruder_trains: for extruder in extruder_trains: if extruder.getMetaDataEntry("position") == "0": extruder_stack_0 = extruder break if extruder_stack_0 is None: Logger.log("i", "No extruder stack for global stack [%s], create one", global_stack.getId()) # Single extrusion machine without an ExtruderStack, create it from cura.Settings.CuraStackBuilder import CuraStackBuilder CuraStackBuilder.createExtruderStackWithDefaultSetup(global_stack, 0) elif extruder_stack_0.definition.getId() != expected_extruder_definition_0_id: Logger.log("e", "Single extruder printer [{printer}] expected extruder [{expected}], but got [{got}]. I'm making it [{expected}].".format( printer = global_stack.getId(), expected = expected_extruder_definition_0_id, got = extruder_stack_0.definition.getId())) try: extruder_definition = container_registry.findDefinitionContainers(id = expected_extruder_definition_0_id)[0] except IndexError: # It still needs to break, but we want to know what extruder ID made it break. msg = "Unable to find extruder definition with the id [%s]" % expected_extruder_definition_0_id Logger.logException("e", msg) raise IndexError(msg) extruder_stack_0.definition = extruder_definition @pyqtSlot("QVariant", result = bool) def getExtruderHasQualityForMaterial(self, extruder_stack: "ExtruderStack") -> bool: """Checks if quality nodes exist for the variant/material combination.""" application = cura.CuraApplication.CuraApplication.getInstance() global_stack = application.getGlobalContainerStack() if not global_stack or not extruder_stack: return False if not global_stack.getMetaDataEntry("has_materials"): return True machine_node = ContainerTree.getInstance().machines[global_stack.definition.getId()] active_variant_name = extruder_stack.variant.getMetaDataEntry("name") if active_variant_name not in machine_node.variants: Logger.log("w", "Could not find the variant %s", active_variant_name) return True active_variant_node = machine_node.variants[active_variant_name] try: active_material_node = active_variant_node.materials[extruder_stack.material.getMetaDataEntry("base_file")] except KeyError: # The material in this stack is not a supported material (e.g. wrong filament diameter, as loaded from a project file). return False active_material_node_qualities = active_material_node.qualities if not active_material_node_qualities: return False return list(active_material_node_qualities.keys())[0] != "empty_quality" @pyqtSlot(str, result="QVariant") def getInstanceExtruderValues(self, key: str) -> List: """Get all extruder values for a certain setting. This is exposed to qml for display purposes :param key: The key of the setting to retrieve values for. :return: String representing the extruder values """ return self._application.getCuraFormulaFunctions().getValuesInAllExtruders(key) @staticmethod def getResolveOrValue(key: str) -> Any: """Get the resolve value or value for a given key This is the effective value for a given key, it is used for values in the global stack. This is exposed to SettingFunction to use in value functions. :param key: The key of the setting to get the value of. :return: The effective value """ global_stack = cast(GlobalStack, cura.CuraApplication.CuraApplication.getInstance().getGlobalContainerStack()) resolved_value = global_stack.getProperty(key, "value") return resolved_value __instance = None # type: ExtruderManager @classmethod def getInstance(cls, *args, **kwargs) -> "ExtruderManager": return cls.__instance