mirror of
https://git.mirrors.martin98.com/https://github.com/Ultimaker/Cura
synced 2025-04-19 04:09:40 +08:00
378 lines
19 KiB
Python
378 lines
19 KiB
Python
# Copyright (c) 2016 Ultimaker B.V.
|
|
# Cura is released under the terms of the AGPLv3 or higher.
|
|
|
|
from PyQt5.QtCore import pyqtSignal, pyqtProperty, pyqtSlot, QObject, QVariant #For communicating data and events to Qt.
|
|
|
|
from UM.Application import Application #To get the global container stack to find the current machine.
|
|
from UM.Logger import Logger
|
|
from UM.Settings.ContainerRegistry import ContainerRegistry #Finding containers by ID.
|
|
from UM.Settings.InstanceContainer import InstanceContainer
|
|
from UM.Settings.SettingFunction import SettingFunction
|
|
from UM.Settings.ContainerStack import ContainerStack
|
|
from UM.Settings.DefinitionContainer import DefinitionContainer
|
|
from typing import Optional
|
|
|
|
## Manages all existing extruder stacks.
|
|
#
|
|
# This keeps a list of extruder stacks for each machine.
|
|
class ExtruderManager(QObject):
|
|
## Signal to notify other components when the list of extruders changes.
|
|
extrudersChanged = pyqtSignal(QVariant)
|
|
|
|
## Notify when the user switches the currently active extruder.
|
|
activeExtruderChanged = pyqtSignal()
|
|
|
|
## Registers listeners and such to listen to changes to the extruders.
|
|
def __init__(self, parent = None):
|
|
super().__init__(parent)
|
|
|
|
# Per machine, a dictionary of extruder container stack IDs.
|
|
self._extruder_trains = {} # type: Dict[str, Dict[str, ContainerStack]]
|
|
|
|
self._active_extruder_index = 0 # type: int
|
|
Application.getInstance().globalContainerStackChanged.connect(self.__globalContainerStackChanged)
|
|
self._addCurrentMachineExtruders()
|
|
|
|
## 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.
|
|
@pyqtProperty(str, notify = activeExtruderChanged)
|
|
def activeExtruderStackId(self) -> Optional[str]:
|
|
if not Application.getInstance().getGlobalContainerStack():
|
|
return None # No active machine, so no active extruder.
|
|
try:
|
|
return self._extruder_trains[Application.getInstance().getGlobalContainerStack().getId()][str(self._active_extruder_index)].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(int, notify = extrudersChanged)
|
|
def extruderCount(self) -> int:
|
|
if not Application.getInstance().getGlobalContainerStack():
|
|
return 0 # No active machine, so no extruders.
|
|
return len(self._extruder_trains[Application.getInstance().getGlobalContainerStack().getId()])
|
|
|
|
@pyqtProperty("QVariantMap", notify=extrudersChanged)
|
|
def extruderIds(self):
|
|
map = {}
|
|
for position in self._extruder_trains[Application.getInstance().getGlobalContainerStack().getId()]:
|
|
map[position] = self._extruder_trains[Application.getInstance().getGlobalContainerStack().getId()][position].getId()
|
|
return map
|
|
|
|
@pyqtSlot(str, result = str)
|
|
def getQualityChangesIdByExtruderStackId(self, id: str) -> str:
|
|
for position in self._extruder_trains[Application.getInstance().getGlobalContainerStack().getId()]:
|
|
extruder = self._extruder_trains[Application.getInstance().getGlobalContainerStack().getId()][position]
|
|
if extruder.getId() == id:
|
|
return extruder.findContainer(type = "quality_changes").getId()
|
|
|
|
## The instance of the singleton pattern.
|
|
#
|
|
# It's None if the extruder manager hasn't been created yet.
|
|
__instance = None
|
|
|
|
## Gets an instance of the extruder manager, or creates one if no instance
|
|
# exists yet.
|
|
#
|
|
# This is an implementation of singleton. If an extruder manager already
|
|
# exists, it is re-used.
|
|
#
|
|
# \return The extruder manager.
|
|
@classmethod
|
|
def getInstance(cls) -> 'ExtruderManager':
|
|
if not cls.__instance:
|
|
cls.__instance = ExtruderManager()
|
|
return cls.__instance
|
|
|
|
## Changes the active extruder by index.
|
|
#
|
|
# \param index The index of the new active extruder.
|
|
@pyqtSlot(int)
|
|
def setActiveExtruderIndex(self, index: int) -> None:
|
|
self._active_extruder_index = index
|
|
self.activeExtruderChanged.emit()
|
|
|
|
@pyqtProperty(int, notify = activeExtruderChanged)
|
|
def activeExtruderIndex(self) -> int:
|
|
return self._active_extruder_index
|
|
|
|
def getActiveExtruderStack(self) -> ContainerStack:
|
|
global_container_stack = Application.getInstance().getGlobalContainerStack()
|
|
if global_container_stack:
|
|
if global_container_stack.getId() in self._extruder_trains:
|
|
if str(self._active_extruder_index) in self._extruder_trains[global_container_stack.getId()]:
|
|
return self._extruder_trains[global_container_stack.getId()][str(self._active_extruder_index)]
|
|
return None
|
|
|
|
## Get an extruder stack by index
|
|
def getExtruderStack(self, index):
|
|
global_container_stack = Application.getInstance().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
|
|
|
|
## Adds all extruders of a specific machine definition to the extruder
|
|
# manager.
|
|
#
|
|
# \param machine_definition The machine definition to add the extruders for.
|
|
# \param machine_id The machine_id to add the extruders for.
|
|
def addMachineExtruders(self, machine_definition: DefinitionContainer, machine_id: str) -> None:
|
|
changed = False
|
|
machine_definition_id = machine_definition.getId()
|
|
if machine_id not in self._extruder_trains:
|
|
self._extruder_trains[machine_id] = { }
|
|
changed = True
|
|
container_registry = ContainerRegistry.getInstance()
|
|
if container_registry:
|
|
# Add the extruder trains that don't exist yet.
|
|
for extruder_definition in container_registry.findDefinitionContainers(machine = machine_definition_id):
|
|
position = extruder_definition.getMetaDataEntry("position", None)
|
|
if not position:
|
|
Logger.log("w", "Extruder definition %s specifies no position metadata entry.", extruder_definition.getId())
|
|
if not container_registry.findContainerStacks(machine = machine_id, position = position): # Doesn't exist yet.
|
|
self.createExtruderTrain(extruder_definition, machine_definition, position, machine_id)
|
|
changed = True
|
|
|
|
# Gets the extruder trains that we just created as well as any that still existed.
|
|
extruder_trains = container_registry.findContainerStacks(type = "extruder_train", machine = machine_id)
|
|
for extruder_train in extruder_trains:
|
|
self._extruder_trains[machine_id][extruder_train.getMetaDataEntry("position")] = extruder_train
|
|
|
|
# Make sure the next stack is a stack that contains only the machine definition
|
|
if not extruder_train.getNextStack():
|
|
shallow_stack = ContainerStack(machine_id + "_shallow")
|
|
shallow_stack.addContainer(machine_definition)
|
|
extruder_train.setNextStack(shallow_stack)
|
|
changed = True
|
|
if changed:
|
|
self.extrudersChanged.emit(machine_id)
|
|
|
|
## Creates a container stack for an extruder train.
|
|
#
|
|
# The container stack has an extruder definition at the bottom, which is
|
|
# linked to a machine definition. Then it has a variant profile, a material
|
|
# profile, a quality profile and a user profile, in that order.
|
|
#
|
|
# The resulting container stack is added to the registry.
|
|
#
|
|
# \param extruder_definition The extruder to create the extruder train for.
|
|
# \param machine_definition The machine that the extruder train belongs to.
|
|
# \param position The position of this extruder train in the extruder slots of the machine.
|
|
# \param machine_id The id of the "global" stack this extruder is linked to.
|
|
def createExtruderTrain(self, extruder_definition: DefinitionContainer, machine_definition: DefinitionContainer,
|
|
position, machine_id: str) -> None:
|
|
# Cache some things.
|
|
container_registry = ContainerRegistry.getInstance()
|
|
machine_definition_id = machine_definition.getId()
|
|
|
|
# Create a container stack for this extruder.
|
|
extruder_stack_id = container_registry.uniqueName(extruder_definition.getId())
|
|
container_stack = ContainerStack(extruder_stack_id)
|
|
container_stack.setName(extruder_definition.getName()) # Take over the display name to display the stack with.
|
|
container_stack.addMetaDataEntry("type", "extruder_train")
|
|
container_stack.addMetaDataEntry("machine", machine_id)
|
|
container_stack.addMetaDataEntry("position", position)
|
|
container_stack.addContainer(extruder_definition)
|
|
|
|
# Find the variant to use for this extruder.
|
|
variant = container_registry.findInstanceContainers(id = "empty_variant")[0]
|
|
if machine_definition.getMetaDataEntry("has_variants"):
|
|
# First add any variant. Later, overwrite with preference if the preference is valid.
|
|
variants = container_registry.findInstanceContainers(definition = machine_definition_id, type = "variant")
|
|
if len(variants) >= 1:
|
|
variant = variants[0]
|
|
preferred_variant_id = machine_definition.getMetaDataEntry("preferred_variant")
|
|
if preferred_variant_id:
|
|
preferred_variants = container_registry.findInstanceContainers(id = preferred_variant_id, type = "variant")
|
|
if len(preferred_variants) >= 1:
|
|
variant = preferred_variants[0]
|
|
else:
|
|
Logger.log("w", "The preferred variant \"%s\" of machine %s doesn't exist or is not a variant profile.", preferred_variant_id, machine_id)
|
|
# And leave it at the default variant.
|
|
container_stack.addContainer(variant)
|
|
|
|
# Find a material to use for this variant.
|
|
material = container_registry.findInstanceContainers(id = "empty_material")[0]
|
|
if machine_definition.getMetaDataEntry("has_materials"):
|
|
# First add any material. Later, overwrite with preference if the preference is valid.
|
|
if machine_definition.getMetaDataEntry("has_variant_materials", default = "False") == "True":
|
|
materials = container_registry.findInstanceContainers(type = "material", definition = machine_definition_id, variant = variant.getId())
|
|
else:
|
|
materials = container_registry.findInstanceContainers(type = "material", definition = machine_definition_id)
|
|
if len(materials) >= 1:
|
|
material = materials[0]
|
|
preferred_material_id = machine_definition.getMetaDataEntry("preferred_material")
|
|
if preferred_material_id:
|
|
search_criteria = { "type": "material", "id": preferred_material_id}
|
|
if machine_definition.getMetaDataEntry("has_machine_materials"):
|
|
search_criteria["definition"] = machine_definition.id
|
|
|
|
if machine_definition.getMetaDataEntry("has_variants") and variant:
|
|
search_criteria["variant"] = variant.id
|
|
else:
|
|
search_criteria["definition"] = "fdmprinter"
|
|
|
|
preferred_materials = container_registry.findInstanceContainers(**search_criteria)
|
|
if len(preferred_materials) >= 1:
|
|
material = preferred_materials[0]
|
|
else:
|
|
Logger.log("w", "The preferred material \"%s\" of machine %s doesn't exist or is not a material profile.", preferred_material_id, machine_id)
|
|
# And leave it at the default material.
|
|
container_stack.addContainer(material)
|
|
|
|
# Find a quality to use for this extruder.
|
|
quality = container_registry.getEmptyInstanceContainer()
|
|
|
|
search_criteria = { "type": "quality" }
|
|
if machine_definition.getMetaDataEntry("has_machine_quality"):
|
|
search_criteria["definition"] = machine_definition.id
|
|
if machine_definition.getMetaDataEntry("has_materials") and material:
|
|
search_criteria["material"] = material.id
|
|
else:
|
|
search_criteria["definition"] = "fdmprinter"
|
|
|
|
preferred_quality = machine_definition.getMetaDataEntry("preferred_quality")
|
|
if preferred_quality:
|
|
search_criteria["id"] = preferred_quality
|
|
|
|
containers = ContainerRegistry.getInstance().findInstanceContainers(**search_criteria)
|
|
if not containers and preferred_quality:
|
|
Logger.log("w", "The preferred quality \"%s\" of machine %s doesn't exist or is not a quality profile.", preferred_quality, machine_id)
|
|
search_criteria.pop("id", None)
|
|
containers = ContainerRegistry.getInstance().findInstanceContainers(**search_criteria)
|
|
if containers:
|
|
quality = containers[0]
|
|
|
|
container_stack.addContainer(quality)
|
|
|
|
empty_quality_changes = container_registry.findInstanceContainers(id = "empty_quality_changes")[0]
|
|
container_stack.addContainer(empty_quality_changes)
|
|
|
|
user_profile = container_registry.findInstanceContainers(type = "user", extruder = extruder_stack_id)
|
|
if user_profile: # There was already a user profile, loaded from settings.
|
|
user_profile = user_profile[0]
|
|
else:
|
|
user_profile = InstanceContainer(extruder_stack_id + "_current_settings") # Add an empty user profile.
|
|
user_profile.addMetaDataEntry("type", "user")
|
|
user_profile.addMetaDataEntry("extruder", extruder_stack_id)
|
|
user_profile.setDefinition(machine_definition)
|
|
container_registry.addContainer(user_profile)
|
|
container_stack.addContainer(user_profile)
|
|
|
|
# Make sure the next stack is a stack that contains only the machine definition
|
|
if not container_stack.getNextStack():
|
|
shallow_stack = ContainerStack(machine_id + "_shallow")
|
|
shallow_stack.addContainer(machine_definition)
|
|
container_stack.setNextStack(shallow_stack)
|
|
|
|
container_registry.addContainer(container_stack)
|
|
|
|
## Removes the container stack and user profile for the extruders for a specific machine.
|
|
#
|
|
# \param machine_id The machine to remove the extruders for.
|
|
def removeMachineExtruders(self, machine_id):
|
|
for extruder in self.getMachineExtruders(machine_id):
|
|
containers = ContainerRegistry.getInstance().findInstanceContainers(type = "user", extruder = extruder.getId())
|
|
for container in containers:
|
|
ContainerRegistry.getInstance().removeContainer(container.getId())
|
|
ContainerRegistry.getInstance().removeContainer(extruder.getId())
|
|
|
|
## Returns extruders for a specific machine.
|
|
#
|
|
# \param machine_id The machine to get the extruders of.
|
|
def getMachineExtruders(self, machine_id):
|
|
if machine_id not in self._extruder_trains:
|
|
Logger.log("w", "Tried to get the extruder trains for machine %s, which doesn't exist.", machine_id)
|
|
return []
|
|
return [self._extruder_trains[machine_id][name] for name in self._extruder_trains[machine_id]]
|
|
|
|
## Returns a generator that will iterate over the global stack and per-extruder stacks.
|
|
#
|
|
# The first generated element is the global container stack. After that any extruder stacks are generated.
|
|
def getActiveGlobalAndExtruderStacks(self):
|
|
global_stack = Application.getInstance().getGlobalContainerStack()
|
|
if not global_stack:
|
|
return
|
|
|
|
yield global_stack
|
|
|
|
global_id = global_stack.getId()
|
|
for name in self._extruder_trains[global_id]:
|
|
yield self._extruder_trains[global_id][name]
|
|
|
|
def __globalContainerStackChanged(self) -> None:
|
|
self._addCurrentMachineExtruders()
|
|
self.activeExtruderChanged.emit()
|
|
|
|
## Adds the extruders of the currently active machine.
|
|
def _addCurrentMachineExtruders(self) -> None:
|
|
global_stack = Application.getInstance().getGlobalContainerStack()
|
|
if global_stack and global_stack.getBottom():
|
|
self.addMachineExtruders(global_stack.getBottom(), global_stack.getId())
|
|
|
|
## Get all extruder values for a certain setting.
|
|
#
|
|
# This is exposed to SettingFunction so it can be used in value functions.
|
|
#
|
|
# \param key The key of the setting to retieve values for.
|
|
#
|
|
# \return A list of values for all extruders. If an extruder does not have a value, it will not be in the list.
|
|
# If no extruder has the value, the list will contain the global value.
|
|
@staticmethod
|
|
def getExtruderValues(key):
|
|
global_stack = Application.getInstance().getGlobalContainerStack()
|
|
|
|
result = []
|
|
for extruder in ExtruderManager.getInstance().getMachineExtruders(global_stack.getId()):
|
|
value = extruder.getRawProperty(key, "value")
|
|
|
|
if not value:
|
|
continue
|
|
|
|
if isinstance(value, SettingFunction):
|
|
value = value(extruder)
|
|
|
|
result.append(value)
|
|
|
|
if not result:
|
|
result.append(global_stack.getProperty(key, "value"))
|
|
|
|
return result
|
|
|
|
## Get all extruder values for a certain setting.
|
|
#
|
|
# This is exposed to qml for display purposes
|
|
#
|
|
# \param key The key of the setting to retieve values for.
|
|
#
|
|
# \return String representing the extruder values
|
|
@pyqtSlot(str, result="QList<int>")
|
|
def getInstanceExtruderValues(self, key):
|
|
return ExtruderManager.getExtruderValues(key)
|
|
|
|
## Get the value for a setting from a specific extruder.
|
|
#
|
|
# This is exposed to SettingFunction to use in value functions.
|
|
#
|
|
# \param extruder_index The index of the extruder to get the value from.
|
|
# \param key The key of the setting to get the value of.
|
|
#
|
|
# \return The value of the setting for the specified extruder or for the
|
|
# global stack if not found.
|
|
@staticmethod
|
|
def getExtruderValue(extruder_index, key):
|
|
extruder = ExtruderManager.getInstance().getExtruderStack(extruder_index)
|
|
|
|
if extruder:
|
|
value = extruder.getRawProperty(key, "value")
|
|
if isinstance(value, SettingFunction):
|
|
value = value(extruder)
|
|
else: #Just a value from global.
|
|
value = Application.getInstance().getGlobalContainerStack().getProperty(key, "value")
|
|
|
|
return value
|