123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723 |
- # Copyright (c) 2018 Ultimaker B.V.
- # Cura is released under the terms of the LGPLv3 or higher.
- from collections import defaultdict, OrderedDict
- import copy
- import uuid
- from typing import Dict, Optional, TYPE_CHECKING, Any, Set, List, cast, Tuple
- from PyQt5.Qt import QTimer, QObject, pyqtSignal, pyqtSlot
- from UM.Application import Application
- from UM.ConfigurationErrorMessage import ConfigurationErrorMessage
- from UM.Logger import Logger
- from UM.Settings.ContainerRegistry import ContainerRegistry
- from UM.Settings.SettingFunction import SettingFunction
- from UM.Util import parseBool
- from .MaterialNode import MaterialNode
- from .MaterialGroup import MaterialGroup
- from .VariantType import VariantType
- if TYPE_CHECKING:
- from UM.Settings.DefinitionContainer import DefinitionContainer
- from UM.Settings.InstanceContainer import InstanceContainer
- from cura.Settings.GlobalStack import GlobalStack
- from cura.Settings.ExtruderStack import ExtruderStack
- #
- # MaterialManager maintains a number of maps and trees for material lookup.
- # The models GUI and QML use are now only dependent on the MaterialManager. That means as long as the data in
- # MaterialManager gets updated correctly, the GUI models should be updated correctly too, and the same goes for GUI.
- #
- # For now, updating the lookup maps and trees here is very simple: we discard the old data completely and recreate them
- # again. This means the update is exactly the same as initialization. There are performance concerns about this approach
- # but so far the creation of the tables and maps is very fast and there is no noticeable slowness, we keep it like this
- # because it's simple.
- #
- class MaterialManager(QObject):
- materialsUpdated = pyqtSignal() # Emitted whenever the material lookup tables are updated.
- favoritesUpdated = pyqtSignal() # Emitted whenever the favorites are changed
- def __init__(self, container_registry, parent = None):
- super().__init__(parent)
- self._application = Application.getInstance()
- self._container_registry = container_registry # type: ContainerRegistry
- # Material_type -> generic material metadata
- self._fallback_materials_map = dict() # type: Dict[str, Dict[str, Any]]
- # Root_material_id -> MaterialGroup
- self._material_group_map = dict() # type: Dict[str, MaterialGroup]
- # Approximate diameter str
- self._diameter_machine_nozzle_buildplate_material_map = dict() # type: Dict[str, Dict[str, MaterialNode]]
- # We're using these two maps to convert between the specific diameter material id and the generic material id
- # because the generic material ids are used in qualities and definitions, while the specific diameter material is meant
- # i.e. generic_pla -> generic_pla_175
- # root_material_id -> approximate diameter str -> root_material_id for that diameter
- self._material_diameter_map = defaultdict(dict) # type: Dict[str, Dict[str, str]]
- # Material id including diameter (generic_pla_175) -> material root id (generic_pla)
- self._diameter_material_map = dict() # type: Dict[str, str]
- # This is used in Legacy UM3 send material function and the material management page.
- # GUID -> a list of material_groups
- self._guid_material_groups_map = defaultdict(list) # type: Dict[str, List[MaterialGroup]]
- # The machine definition ID for the non-machine-specific materials.
- # This is used as the last fallback option if the given machine-specific material(s) cannot be found.
- self._default_machine_definition_id = "fdmprinter"
- self._default_approximate_diameter_for_quality_search = "3"
- # When a material gets added/imported, there can be more than one InstanceContainers. In those cases, we don't
- # want to react on every container/metadata changed signal. The timer here is to buffer it a bit so we don't
- # react too many time.
- self._update_timer = QTimer(self)
- self._update_timer.setInterval(300)
- self._update_timer.setSingleShot(True)
- self._update_timer.timeout.connect(self._updateMaps)
- self._container_registry.containerMetaDataChanged.connect(self._onContainerMetadataChanged)
- self._container_registry.containerAdded.connect(self._onContainerMetadataChanged)
- self._container_registry.containerRemoved.connect(self._onContainerMetadataChanged)
- self._favorites = set() # type: Set[str]
- def initialize(self) -> None:
- # Find all materials and put them in a matrix for quick search.
- material_metadatas = {metadata["id"]: metadata for metadata in
- self._container_registry.findContainersMetadata(type = "material") if
- metadata.get("GUID")} # type: Dict[str, Dict[str, Any]]
- self._material_group_map = dict() # type: Dict[str, MaterialGroup]
-
- # Map #1
- # root_material_id -> MaterialGroup
- for material_id, material_metadata in material_metadatas.items():
- # We don't store empty material in the lookup tables
- if material_id == "empty_material":
- continue
- root_material_id = material_metadata.get("base_file", "")
- if root_material_id not in material_metadatas: #Not a registered material profile. Don't store this in the look-up tables.
- continue
- if root_material_id not in self._material_group_map:
- self._material_group_map[root_material_id] = MaterialGroup(root_material_id, MaterialNode(material_metadatas[root_material_id]))
- self._material_group_map[root_material_id].is_read_only = self._container_registry.isReadOnly(root_material_id)
- group = self._material_group_map[root_material_id]
- # Store this material in the group of the appropriate root material.
- if material_id != root_material_id:
- new_node = MaterialNode(material_metadata)
- group.derived_material_node_list.append(new_node)
- # Order this map alphabetically so it's easier to navigate in a debugger
- self._material_group_map = OrderedDict(sorted(self._material_group_map.items(), key = lambda x: x[0]))
- # Map #1.5
- # GUID -> material group list
- self._guid_material_groups_map = defaultdict(list) # type: Dict[str, List[MaterialGroup]]
- for root_material_id, material_group in self._material_group_map.items():
- guid = material_group.root_material_node.getMetaDataEntry("GUID", "")
- self._guid_material_groups_map[guid].append(material_group)
- # Map #2
- # Lookup table for material type -> fallback material metadata, only for read-only materials
- grouped_by_type_dict = dict() # type: Dict[str, Any]
- material_types_without_fallback = set()
- for root_material_id, material_node in self._material_group_map.items():
- material_type = material_node.root_material_node.getMetaDataEntry("material", "")
- if material_type not in grouped_by_type_dict:
- grouped_by_type_dict[material_type] = {"generic": None,
- "others": []}
- material_types_without_fallback.add(material_type)
- brand = material_node.root_material_node.getMetaDataEntry("brand", "")
- if brand.lower() == "generic":
- to_add = True
- if material_type in grouped_by_type_dict:
- diameter = material_node.root_material_node.getMetaDataEntry("approximate_diameter", "")
- if diameter != self._default_approximate_diameter_for_quality_search:
- to_add = False # don't add if it's not the default diameter
- if to_add:
- # Checking this first allow us to differentiate between not read only materials:
- # - if it's in the list, it means that is a new material without fallback
- # - if it is not, then it is a custom material with a fallback material (parent)
- if material_type in material_types_without_fallback:
- grouped_by_type_dict[material_type] = material_node.root_material_node._metadata
- material_types_without_fallback.remove(material_type)
- # Remove the materials that have no fallback materials
- for material_type in material_types_without_fallback:
- del grouped_by_type_dict[material_type]
- self._fallback_materials_map = grouped_by_type_dict
- # Map #3
- # There can be multiple material profiles for the same material with different diameters, such as "generic_pla"
- # and "generic_pla_175". This is inconvenient when we do material-specific quality lookup because a quality can
- # be for either "generic_pla" or "generic_pla_175", but not both. This map helps to get the correct material ID
- # for quality search.
- self._material_diameter_map = defaultdict(dict)
- self._diameter_material_map = dict()
- # Group the material IDs by the same name, material, brand, and color but with different diameters.
- material_group_dict = dict() # type: Dict[Tuple[Any], Dict[str, str]]
- keys_to_fetch = ("name", "material", "brand", "color")
- for root_material_id, machine_node in self._material_group_map.items():
- root_material_metadata = machine_node.root_material_node._metadata
- key_data_list = [] # type: List[Any]
- for key in keys_to_fetch:
- key_data_list.append(machine_node.root_material_node.getMetaDataEntry(key))
- key_data = cast(Tuple[Any], tuple(key_data_list)) # type: Tuple[Any]
- # If the key_data doesn't exist, it doesn't matter if the material is read only...
- if key_data not in material_group_dict:
- material_group_dict[key_data] = dict()
- else:
- # ...but if key_data exists, we just overwrite it if the material is read only, otherwise we skip it
- if not machine_node.is_read_only:
- continue
- approximate_diameter = machine_node.root_material_node.getMetaDataEntry("approximate_diameter", "")
- material_group_dict[key_data][approximate_diameter] = machine_node.root_material_node.getMetaDataEntry("id", "")
- # Map [root_material_id][diameter] -> root_material_id for this diameter
- for data_dict in material_group_dict.values():
- for root_material_id1 in data_dict.values():
- if root_material_id1 in self._material_diameter_map:
- continue
- diameter_map = data_dict
- for root_material_id2 in data_dict.values():
- self._material_diameter_map[root_material_id2] = diameter_map
- default_root_material_id = data_dict.get(self._default_approximate_diameter_for_quality_search)
- if default_root_material_id is None:
- default_root_material_id = list(data_dict.values())[0] # no default diameter present, just take "the" only one
- for root_material_id in data_dict.values():
- self._diameter_material_map[root_material_id] = default_root_material_id
- # Map #4
- # "machine" -> "nozzle name" -> "buildplate name" -> "root material ID" -> specific material InstanceContainer
- self._diameter_machine_nozzle_buildplate_material_map = dict() # type: Dict[str, Dict[str, MaterialNode]]
- for material_metadata in material_metadatas.values():
- self.__addMaterialMetadataIntoLookupTree(material_metadata)
- favorites = self._application.getPreferences().getValue("cura/favorite_materials")
- for item in favorites.split(";"):
- self._favorites.add(item)
- self.materialsUpdated.emit()
- def __addMaterialMetadataIntoLookupTree(self, material_metadata: Dict[str, Any]) -> None:
- material_id = material_metadata["id"]
- # We don't store empty material in the lookup tables
- if material_id == "empty_material":
- return
- root_material_id = material_metadata["base_file"]
- definition = material_metadata["definition"]
- approximate_diameter = str(material_metadata["approximate_diameter"])
- if approximate_diameter not in self._diameter_machine_nozzle_buildplate_material_map:
- self._diameter_machine_nozzle_buildplate_material_map[approximate_diameter] = {}
- machine_nozzle_buildplate_material_map = self._diameter_machine_nozzle_buildplate_material_map[
- approximate_diameter]
- if definition not in machine_nozzle_buildplate_material_map:
- machine_nozzle_buildplate_material_map[definition] = MaterialNode()
- # This is a list of information regarding the intermediate nodes:
- # nozzle -> buildplate
- nozzle_name = material_metadata.get("variant_name")
- buildplate_name = material_metadata.get("buildplate_name")
- intermediate_node_info_list = [(nozzle_name, VariantType.NOZZLE),
- (buildplate_name, VariantType.BUILD_PLATE),
- ]
- variant_manager = self._application.getVariantManager()
- machine_node = machine_nozzle_buildplate_material_map[definition]
- current_node = machine_node
- current_intermediate_node_info_idx = 0
- error_message = None # type: Optional[str]
- while current_intermediate_node_info_idx < len(intermediate_node_info_list):
- variant_name, variant_type = intermediate_node_info_list[current_intermediate_node_info_idx]
- if variant_name is not None:
- # The new material has a specific variant, so it needs to be added to that specific branch in the tree.
- variant = variant_manager.getVariantNode(definition, variant_name, variant_type)
- if variant is None:
- error_message = "Material {id} contains a variant {name} that does not exist.".format(
- id = material_metadata["id"], name = variant_name)
- break
- # Update the current node to advance to a more specific branch
- if variant_name not in current_node.children_map:
- current_node.children_map[variant_name] = MaterialNode()
- current_node = current_node.children_map[variant_name]
- current_intermediate_node_info_idx += 1
- if error_message is not None:
- Logger.log("e", "%s It will not be added into the material lookup tree.", error_message)
- self._container_registry.addWrongContainerId(material_metadata["id"])
- return
- # Add the material to the current tree node, which is the deepest (the most specific) branch we can find.
- # Sanity check: Make sure that there is no duplicated materials.
- if root_material_id in current_node.material_map:
- Logger.log("e", "Duplicated material [%s] with root ID [%s]. It has already been added.",
- material_id, root_material_id)
- ConfigurationErrorMessage.getInstance().addFaultyContainers(root_material_id)
- return
- current_node.material_map[root_material_id] = MaterialNode(material_metadata)
- def _updateMaps(self):
- Logger.log("i", "Updating material lookup data ...")
- self.initialize()
- def _onContainerMetadataChanged(self, container):
- self._onContainerChanged(container)
- def _onContainerChanged(self, container):
- container_type = container.getMetaDataEntry("type")
- if container_type != "material":
- return
- # update the maps
- self._update_timer.start()
- def getMaterialGroup(self, root_material_id: str) -> Optional[MaterialGroup]:
- return self._material_group_map.get(root_material_id)
- def getRootMaterialIDForDiameter(self, root_material_id: str, approximate_diameter: str) -> str:
- return self._material_diameter_map.get(root_material_id, {}).get(approximate_diameter, root_material_id)
- def getRootMaterialIDWithoutDiameter(self, root_material_id: str) -> str:
- return self._diameter_material_map.get(root_material_id, "")
- def getMaterialGroupListByGUID(self, guid: str) -> Optional[List[MaterialGroup]]:
- return self._guid_material_groups_map.get(guid)
- # Returns a dict of all material groups organized by root_material_id.
- def getAllMaterialGroups(self) -> Dict[str, "MaterialGroup"]:
- return self._material_group_map
- #
- # Return a dict with all root material IDs (k) and ContainerNodes (v) that's suitable for the given setup.
- #
- def getAvailableMaterials(self, machine_definition: "DefinitionContainer", nozzle_name: Optional[str],
- buildplate_name: Optional[str], diameter: float) -> Dict[str, MaterialNode]:
- # round the diameter to get the approximate diameter
- rounded_diameter = str(round(diameter))
- if rounded_diameter not in self._diameter_machine_nozzle_buildplate_material_map:
- Logger.log("i", "Cannot find materials with diameter [%s] (rounded to [%s])", diameter, rounded_diameter)
- return dict()
- machine_definition_id = machine_definition.getId()
- # If there are nozzle-and-or-buildplate materials, get the nozzle-and-or-buildplate material
- machine_nozzle_buildplate_material_map = self._diameter_machine_nozzle_buildplate_material_map[rounded_diameter]
- machine_node = machine_nozzle_buildplate_material_map.get(machine_definition_id)
- default_machine_node = machine_nozzle_buildplate_material_map.get(self._default_machine_definition_id)
- nozzle_node = None
- buildplate_node = None
- if nozzle_name is not None and machine_node is not None:
- nozzle_node = machine_node.getChildNode(nozzle_name)
- # Get buildplate node if possible
- if nozzle_node is not None and buildplate_name is not None:
- buildplate_node = nozzle_node.getChildNode(buildplate_name)
- nodes_to_check = [buildplate_node, nozzle_node, machine_node, default_machine_node]
- # Fallback mechanism of finding materials:
- # 1. buildplate-specific material
- # 2. nozzle-specific material
- # 3. machine-specific material
- # 4. generic material (for fdmprinter)
- machine_exclude_materials = machine_definition.getMetaDataEntry("exclude_materials", [])
- material_id_metadata_dict = dict() # type: Dict[str, MaterialNode]
- excluded_materials = set()
- for current_node in nodes_to_check:
- if current_node is None:
- continue
- # Only exclude the materials that are explicitly specified in the "exclude_materials" field.
- # Do not exclude other materials that are of the same type.
- for material_id, node in current_node.material_map.items():
- if material_id in machine_exclude_materials:
- excluded_materials.add(material_id)
- continue
- if material_id not in material_id_metadata_dict:
- material_id_metadata_dict[material_id] = node
- if excluded_materials:
- Logger.log("d", "Exclude materials {excluded_materials} for machine {machine_definition_id}".format(excluded_materials = ", ".join(excluded_materials), machine_definition_id = machine_definition_id))
- return material_id_metadata_dict
- #
- # A convenience function to get available materials for the given machine with the extruder position.
- #
- def getAvailableMaterialsForMachineExtruder(self, machine: "GlobalStack",
- extruder_stack: "ExtruderStack") -> Optional[Dict[str, MaterialNode]]:
- buildplate_name = machine.getBuildplateName()
- nozzle_name = None
- if extruder_stack.variant.getId() != "empty_variant":
- nozzle_name = extruder_stack.variant.getName()
- diameter = extruder_stack.getApproximateMaterialDiameter()
- # Fetch the available materials (ContainerNode) for the current active machine and extruder setup.
- return self.getAvailableMaterials(machine.definition, nozzle_name, buildplate_name, diameter)
- #
- # Gets MaterialNode for the given extruder and machine with the given material name.
- # Returns None if:
- # 1. the given machine doesn't have materials;
- # 2. cannot find any material InstanceContainers with the given settings.
- #
- def getMaterialNode(self, machine_definition_id: str, nozzle_name: Optional[str],
- buildplate_name: Optional[str], diameter: float, root_material_id: str) -> Optional["MaterialNode"]:
- # round the diameter to get the approximate diameter
- rounded_diameter = str(round(diameter))
- if rounded_diameter not in self._diameter_machine_nozzle_buildplate_material_map:
- Logger.log("i", "Cannot find materials with diameter [%s] (rounded to [%s]) for root material id [%s]",
- diameter, rounded_diameter, root_material_id)
- return None
- # If there are nozzle materials, get the nozzle-specific material
- machine_nozzle_buildplate_material_map = self._diameter_machine_nozzle_buildplate_material_map[rounded_diameter] # type: Dict[str, MaterialNode]
- machine_node = machine_nozzle_buildplate_material_map.get(machine_definition_id)
- nozzle_node = None
- buildplate_node = None
- # Fallback for "fdmprinter" if the machine-specific materials cannot be found
- if machine_node is None:
- machine_node = machine_nozzle_buildplate_material_map.get(self._default_machine_definition_id)
- if machine_node is not None and nozzle_name is not None:
- nozzle_node = machine_node.getChildNode(nozzle_name)
- if nozzle_node is not None and buildplate_name is not None:
- buildplate_node = nozzle_node.getChildNode(buildplate_name)
- # Fallback mechanism of finding materials:
- # 1. buildplate-specific material
- # 2. nozzle-specific material
- # 3. machine-specific material
- # 4. generic material (for fdmprinter)
- nodes_to_check = [buildplate_node, nozzle_node, machine_node,
- machine_nozzle_buildplate_material_map.get(self._default_machine_definition_id)]
- material_node = None
- for node in nodes_to_check:
- if node is not None:
- material_node = node.material_map.get(root_material_id)
- if material_node:
- break
- return material_node
- #
- # Gets MaterialNode for the given extruder and machine with the given material type.
- # Returns None if:
- # 1. the given machine doesn't have materials;
- # 2. cannot find any material InstanceContainers with the given settings.
- #
- def getMaterialNodeByType(self, global_stack: "GlobalStack", position: str, nozzle_name: str,
- buildplate_name: Optional[str], material_guid: str) -> Optional["MaterialNode"]:
- node = None
- machine_definition = global_stack.definition
- extruder_definition = global_stack.extruders[position].definition
- if parseBool(machine_definition.getMetaDataEntry("has_materials", False)):
- material_diameter = extruder_definition.getProperty("material_diameter", "value")
- if isinstance(material_diameter, SettingFunction):
- material_diameter = material_diameter(global_stack)
- # Look at the guid to material dictionary
- root_material_id = None
- for material_group in self._guid_material_groups_map[material_guid]:
- root_material_id = cast(str, material_group.root_material_node.getMetaDataEntry("id", ""))
- break
- if not root_material_id:
- Logger.log("i", "Cannot find materials with guid [%s] ", material_guid)
- return None
- node = self.getMaterialNode(machine_definition.getId(), nozzle_name, buildplate_name,
- material_diameter, root_material_id)
- return node
- # There are 2 ways to get fallback materials;
- # - A fallback by type (@sa getFallbackMaterialIdByMaterialType), which adds the generic version of this material
- # - A fallback by GUID; If a material has been duplicated, it should also check if the original materials do have
- # a GUID. This should only be done if the material itself does not have a quality just yet.
- def getFallBackMaterialIdsByMaterial(self, material: "InstanceContainer") -> List[str]:
- results = [] # type: List[str]
- material_groups = self.getMaterialGroupListByGUID(material.getMetaDataEntry("GUID"))
- for material_group in material_groups: # type: ignore
- if material_group.name != material.getId():
- # If the material in the group is read only, put it at the front of the list (since that is the most
- # likely one to get a result)
- if material_group.is_read_only:
- results.insert(0, material_group.name)
- else:
- results.append(material_group.name)
- fallback = self.getFallbackMaterialIdByMaterialType(material.getMetaDataEntry("material"))
- if fallback is not None:
- results.append(fallback)
- return results
- #
- # Used by QualityManager. Built-in quality profiles may be based on generic material IDs such as "generic_pla".
- # For materials such as ultimaker_pla_orange, no quality profiles may be found, so we should fall back to use
- # the generic material IDs to search for qualities.
- #
- # An example would be, suppose we have machine with preferred material set to "filo3d_pla" (1.75mm), but its
- # extruders only use 2.85mm materials, then we won't be able to find the preferred material for this machine.
- # A fallback would be to fetch a generic material of the same type "PLA" as "filo3d_pla", and in this case it will
- # be "generic_pla". This function is intended to get a generic fallback material for the given material type.
- #
- # This function returns the generic root material ID for the given material type, where material types are "PLA",
- # "ABS", etc.
- #
- def getFallbackMaterialIdByMaterialType(self, material_type: str) -> Optional[str]:
- # For safety
- if material_type not in self._fallback_materials_map:
- Logger.log("w", "The material type [%s] does not have a fallback material" % material_type)
- return None
- fallback_material = self._fallback_materials_map[material_type]
- if fallback_material:
- return self.getRootMaterialIDWithoutDiameter(fallback_material["id"])
- else:
- return None
- ## Get default material for given global stack, extruder position and extruder nozzle name
- # you can provide the extruder_definition and then the position is ignored (useful when building up global stack in CuraStackBuilder)
- def getDefaultMaterial(self, global_stack: "GlobalStack", position: str, nozzle_name: Optional[str],
- extruder_definition: Optional["DefinitionContainer"] = None) -> Optional["MaterialNode"]:
- node = None
- buildplate_name = global_stack.getBuildplateName()
- machine_definition = global_stack.definition
- # The extruder-compatible material diameter in the extruder definition may not be the correct value because
- # the user can change it in the definition_changes container.
- if extruder_definition is None:
- extruder_stack_or_definition = global_stack.extruders[position]
- is_extruder_stack = True
- else:
- extruder_stack_or_definition = extruder_definition
- is_extruder_stack = False
- if extruder_stack_or_definition and parseBool(global_stack.getMetaDataEntry("has_materials", False)):
- if is_extruder_stack:
- material_diameter = extruder_stack_or_definition.getCompatibleMaterialDiameter()
- else:
- material_diameter = extruder_stack_or_definition.getProperty("material_diameter", "value")
- if isinstance(material_diameter, SettingFunction):
- material_diameter = material_diameter(global_stack)
- approximate_material_diameter = str(round(material_diameter))
- root_material_id = machine_definition.getMetaDataEntry("preferred_material")
- root_material_id = self.getRootMaterialIDForDiameter(root_material_id, approximate_material_diameter)
- node = self.getMaterialNode(machine_definition.getId(), nozzle_name, buildplate_name,
- material_diameter, root_material_id)
- return node
- def removeMaterialByRootId(self, root_material_id: str):
- material_group = self.getMaterialGroup(root_material_id)
- if not material_group:
- Logger.log("i", "Unable to remove the material with id %s, because it doesn't exist.", root_material_id)
- return
- nodes_to_remove = [material_group.root_material_node] + material_group.derived_material_node_list
- # Sort all nodes with respect to the container ID lengths in the ascending order so the base material container
- # will be the first one to be removed. We need to do this to ensure that all containers get loaded & deleted.
- nodes_to_remove = sorted(nodes_to_remove, key = lambda x: len(x.getMetaDataEntry("id", "")))
- # Try to load all containers first. If there is any faulty ones, they will be put into the faulty container
- # list, so removeContainer() can ignore those ones.
- for node in nodes_to_remove:
- container_id = node.getMetaDataEntry("id", "")
- results = self._container_registry.findContainers(id = container_id)
- if not results:
- self._container_registry.addWrongContainerId(container_id)
- for node in nodes_to_remove:
- self._container_registry.removeContainer(node.getMetaDataEntry("id", ""))
- #
- # Methods for GUI
- #
- @pyqtSlot("QVariant", result=bool)
- def canMaterialBeRemoved(self, material_node: "MaterialNode"):
- # Check if the material is active in any extruder train. In that case, the material shouldn't be removed!
- # In the future we might enable this again, but right now, it's causing a ton of issues if we do (since it
- # corrupts the configuration)
- root_material_id = material_node.getMetaDataEntry("base_file")
- material_group = self.getMaterialGroup(root_material_id)
- if not material_group:
- return False
- nodes_to_remove = [material_group.root_material_node] + material_group.derived_material_node_list
- ids_to_remove = [node.getMetaDataEntry("id", "") for node in nodes_to_remove]
- for extruder_stack in self._container_registry.findContainerStacks(type="extruder_train"):
- if extruder_stack.material.getId() in ids_to_remove:
- return False
- return True
- @pyqtSlot("QVariant", str)
- def setMaterialName(self, material_node: "MaterialNode", name: str) -> None:
- root_material_id = material_node.getMetaDataEntry("base_file")
- if root_material_id is None:
- return
- if self._container_registry.isReadOnly(root_material_id):
- Logger.log("w", "Cannot set name of read-only container %s.", root_material_id)
- return
- material_group = self.getMaterialGroup(root_material_id)
- if material_group:
- container = material_group.root_material_node.getContainer()
- if container:
- container.setName(name)
- #
- # Removes the given material.
- #
- @pyqtSlot("QVariant")
- def removeMaterial(self, material_node: "MaterialNode") -> None:
- root_material_id = material_node.getMetaDataEntry("base_file")
- if root_material_id is not None:
- self.removeMaterialByRootId(root_material_id)
- #
- # Creates a duplicate of a material, which has the same GUID and base_file metadata.
- # Returns the root material ID of the duplicated material if successful.
- #
- @pyqtSlot("QVariant", result = str)
- def duplicateMaterial(self, material_node: MaterialNode, new_base_id: Optional[str] = None, new_metadata: Dict[str, Any] = None) -> Optional[str]:
- root_material_id = cast(str, material_node.getMetaDataEntry("base_file", ""))
- material_group = self.getMaterialGroup(root_material_id)
- if not material_group:
- Logger.log("i", "Unable to duplicate the material with id %s, because it doesn't exist.", root_material_id)
- return None
- base_container = material_group.root_material_node.getContainer()
- if not base_container:
- return None
- # Ensure all settings are saved.
- self._application.saveSettings()
- # Create a new ID & container to hold the data.
- new_containers = []
- if new_base_id is None:
- new_base_id = self._container_registry.uniqueName(base_container.getId())
- new_base_container = copy.deepcopy(base_container)
- new_base_container.getMetaData()["id"] = new_base_id
- new_base_container.getMetaData()["base_file"] = new_base_id
- if new_metadata is not None:
- for key, value in new_metadata.items():
- new_base_container.getMetaData()[key] = value
- new_containers.append(new_base_container)
- # Clone all of them.
- for node in material_group.derived_material_node_list:
- container_to_copy = node.getContainer()
- if not container_to_copy:
- continue
- # Create unique IDs for every clone.
- new_id = new_base_id
- if container_to_copy.getMetaDataEntry("definition") != "fdmprinter":
- new_id += "_" + container_to_copy.getMetaDataEntry("definition")
- if container_to_copy.getMetaDataEntry("variant_name"):
- nozzle_name = container_to_copy.getMetaDataEntry("variant_name")
- new_id += "_" + nozzle_name.replace(" ", "_")
- new_container = copy.deepcopy(container_to_copy)
- new_container.getMetaData()["id"] = new_id
- new_container.getMetaData()["base_file"] = new_base_id
- if new_metadata is not None:
- for key, value in new_metadata.items():
- new_container.getMetaData()[key] = value
- new_containers.append(new_container)
- for container_to_add in new_containers:
- container_to_add.setDirty(True)
- self._container_registry.addContainer(container_to_add)
- # if the duplicated material was favorite then the new material should also be added to favorite.
- if root_material_id in self.getFavorites():
- self.addFavorite(new_base_id)
- return new_base_id
- #
- # Create a new material by cloning Generic PLA for the current material diameter and generate a new GUID.
- # Returns the ID of the newly created material.
- @pyqtSlot(result = str)
- def createMaterial(self) -> str:
- from UM.i18n import i18nCatalog
- catalog = i18nCatalog("cura")
- # Ensure all settings are saved.
- self._application.saveSettings()
- machine_manager = self._application.getMachineManager()
- extruder_stack = machine_manager.activeStack
- machine_definition = self._application.getGlobalContainerStack().definition
- root_material_id = machine_definition.getMetaDataEntry("preferred_material", default = "generic_pla")
- approximate_diameter = str(extruder_stack.approximateMaterialDiameter)
- root_material_id = self.getRootMaterialIDForDiameter(root_material_id, approximate_diameter)
- material_group = self.getMaterialGroup(root_material_id)
- if not material_group: # This should never happen
- Logger.log("w", "Cannot get the material group of %s.", root_material_id)
- return ""
- # Create a new ID & container to hold the data.
- new_id = self._container_registry.uniqueName("custom_material")
- new_metadata = {"name": catalog.i18nc("@label", "Custom Material"),
- "brand": catalog.i18nc("@label", "Custom"),
- "GUID": str(uuid.uuid4()),
- }
- self.duplicateMaterial(material_group.root_material_node,
- new_base_id = new_id,
- new_metadata = new_metadata)
- return new_id
- @pyqtSlot(str)
- def addFavorite(self, root_material_id: str) -> None:
- self._favorites.add(root_material_id)
- self.materialsUpdated.emit()
- # Ensure all settings are saved.
- self._application.getPreferences().setValue("cura/favorite_materials", ";".join(list(self._favorites)))
- self._application.saveSettings()
- @pyqtSlot(str)
- def removeFavorite(self, root_material_id: str) -> None:
- try:
- self._favorites.remove(root_material_id)
- except KeyError:
- Logger.log("w", "Could not delete material %s from favorites as it was already deleted", root_material_id)
- return
- self.materialsUpdated.emit()
- # Ensure all settings are saved.
- self._application.getPreferences().setValue("cura/favorite_materials", ";".join(list(self._favorites)))
- self._application.saveSettings()
- @pyqtSlot()
- def getFavorites(self):
- return self._favorites
|