Cura/cura/Machines/Models/FavoriteMaterialsModel.py

# Copyright (c) 2021 Ultimaker B.V.
# Cura is released under the terms of the LGPLv3 or higher.
from typing import Optional

from cura.Machines.Models.BaseMaterialsModel import BaseMaterialsModel
import cura.CuraApplication  # To listen to changes to the preferences.

class FavoriteMaterialsModel(BaseMaterialsModel):
    """Model that shows the list of favorite materials."""

    def __init__(self, parent: Optional["QObject"] = None) -> None:
        super(FavoriteMaterialsModel, self).__init__(parent = parent)
        cura.CuraApplication.CuraApplication.getInstance().getPreferences().preferenceChanged.connect(self._onFavoritesChanged)
        self._onChanged()

    def _onFavoritesChanged(self, preference_key: str) -> None:
        """Triggered when any preference changes, but only handles it when the list of favourites is changed. """

        if preference_key != "cura/favorite_materials":
            return
        self._onChanged()

    def _update(self):
        if not self._canUpdate():
            return
        super()._update()

        item_list = []

        for root_material_id, container_node in self._available_materials.items():
            # Do not include the materials from a to-be-removed package
            if bool(container_node.getMetaDataEntry("removed", False)):
                continue

            # Only add results for favorite materials
            if root_material_id not in self._favorite_ids:
                continue

            item = self._createMaterialItem(root_material_id, container_node)
            if item:
                item_list.append(item)

        # Sort the item list alphabetically by name
        item_list = sorted(item_list, key = lambda d: d["brand"].upper())

        self.setItems(item_list)