CuraFormulaFunctions.py 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. # Copyright (c) 2018 Ultimaker B.V.
  2. # Cura is released under the terms of the LGPLv3 or higher.
  3. from typing import Any, List, Optional, TYPE_CHECKING
  4. from UM.Settings.PropertyEvaluationContext import PropertyEvaluationContext
  5. from UM.Settings.SettingFunction import SettingFunction
  6. from UM.Logger import Logger
  7. if TYPE_CHECKING:
  8. from cura.CuraApplication import CuraApplication
  9. from cura.Settings.CuraContainerStack import CuraContainerStack
  10. #
  11. # This class contains all Cura-related custom functions that can be used in formulas. Some functions requires
  12. # information such as the currently active machine, so this is made into a class instead of standalone functions.
  13. #
  14. class CuraFormulaFunctions:
  15. def __init__(self, application: "CuraApplication") -> None:
  16. self._application = application
  17. # ================
  18. # Custom Functions
  19. # ================
  20. # Gets the default extruder position of the currently active machine.
  21. def getDefaultExtruderPosition(self) -> str:
  22. machine_manager = self._application.getMachineManager()
  23. return machine_manager.defaultExtruderPosition
  24. # Gets the given setting key from the given extruder position.
  25. def getValueInExtruder(self, extruder_position: int, property_key: str,
  26. context: Optional["PropertyEvaluationContext"] = None) -> Any:
  27. machine_manager = self._application.getMachineManager()
  28. if extruder_position == -1:
  29. extruder_position = int(machine_manager.defaultExtruderPosition)
  30. global_stack = machine_manager.activeMachine
  31. try:
  32. extruder_stack = global_stack.extruderList[int(extruder_position)]
  33. except IndexError:
  34. if extruder_position != 0:
  35. Logger.log("w", "Value for %s of extruder %s was requested, but that extruder is not available. Returning the result from extruder 0 instead" % (property_key, extruder_position))
  36. # This fixes a very specific fringe case; If a profile was created for a custom printer and one of the
  37. # extruder settings has been set to non zero and the profile is loaded for a machine that has only a single extruder
  38. # it would cause all kinds of issues (and eventually a crash).
  39. # See https://github.com/Ultimaker/Cura/issues/5535
  40. return self.getValueInExtruder(0, property_key, context)
  41. Logger.log("w", "Value for %s of extruder %s was requested, but that extruder is not available. " % (property_key, extruder_position))
  42. return None
  43. value = extruder_stack.getRawProperty(property_key, "value", context = context)
  44. if isinstance(value, SettingFunction):
  45. value = value(extruder_stack, context = context)
  46. return value
  47. def _getActiveExtruders(self, context: Optional["PropertyEvaluationContext"] = None) -> List[str]:
  48. machine_manager = self._application.getMachineManager()
  49. extruder_manager = self._application.getExtruderManager()
  50. global_stack = machine_manager.activeMachine
  51. result = []
  52. for extruder in extruder_manager.getActiveExtruderStacks():
  53. if not extruder.isEnabled:
  54. continue
  55. # only include values from extruders that are "active" for the current machine instance
  56. if int(extruder.getMetaDataEntry("position")) >= global_stack.getProperty("machine_extruder_count", "value", context = context):
  57. continue
  58. result.append(extruder)
  59. return result
  60. # Gets all extruder values as a list for the given property.
  61. def getValuesInAllExtruders(self, property_key: str,
  62. context: Optional["PropertyEvaluationContext"] = None) -> List[Any]:
  63. global_stack = self._application.getMachineManager().activeMachine
  64. result = []
  65. for extruder in self._getActiveExtruders(context):
  66. value = extruder.getRawProperty(property_key, "value", context = context)
  67. if value is None:
  68. continue
  69. if isinstance(value, SettingFunction):
  70. value = value(extruder, context = context)
  71. result.append(value)
  72. if not result:
  73. result.append(global_stack.getProperty(property_key, "value", context = context))
  74. return result
  75. # Get the first extruder that adheres to a specific (boolean) property, like 'material_is_support_material'.
  76. def getAnyExtruderPositionWithOrDefault(self, filter_key: str,
  77. context: Optional["PropertyEvaluationContext"] = None) -> str:
  78. for extruder in self._getActiveExtruders(context):
  79. value = extruder.getRawProperty(filter_key, "value", context=context)
  80. if value is None or not value:
  81. continue
  82. return str(extruder.position)
  83. return self.getDefaultExtruderPosition()
  84. # Get the resolve value or value for a given key.
  85. def getResolveOrValue(self, property_key: str, context: Optional["PropertyEvaluationContext"] = None) -> Any:
  86. machine_manager = self._application.getMachineManager()
  87. global_stack = machine_manager.activeMachine
  88. resolved_value = global_stack.getProperty(property_key, "value", context = context)
  89. return resolved_value
  90. # Gets the default setting value from given extruder position. The default value is what excludes the values in
  91. # the user_changes container.
  92. def getDefaultValueInExtruder(self, extruder_position: int, property_key: str) -> Any:
  93. machine_manager = self._application.getMachineManager()
  94. global_stack = machine_manager.activeMachine
  95. try:
  96. extruder_stack = global_stack.extruderList[extruder_position]
  97. except IndexError:
  98. Logger.log("w", "Unable to find extruder on in index %s", extruder_position)
  99. else:
  100. context = self.createContextForDefaultValueEvaluation(extruder_stack)
  101. return self.getValueInExtruder(extruder_position, property_key, context = context)
  102. # Gets all default setting values as a list from all extruders of the currently active machine.
  103. # The default values are those excluding the values in the user_changes container.
  104. def getDefaultValuesInAllExtruders(self, property_key: str) -> List[Any]:
  105. machine_manager = self._application.getMachineManager()
  106. global_stack = machine_manager.activeMachine
  107. context = self.createContextForDefaultValueEvaluation(global_stack)
  108. return self.getValuesInAllExtruders(property_key, context = context)
  109. # Gets the resolve value or value for a given key without looking the first container (user container).
  110. def getDefaultResolveOrValue(self, property_key: str) -> Any:
  111. machine_manager = self._application.getMachineManager()
  112. global_stack = machine_manager.activeMachine
  113. context = self.createContextForDefaultValueEvaluation(global_stack)
  114. return self.getResolveOrValue(property_key, context = context)
  115. # Gets the value for the given setting key starting from the given container index.
  116. def getValueFromContainerAtIndex(self, property_key: str, container_index: int,
  117. context: Optional["PropertyEvaluationContext"] = None) -> Any:
  118. machine_manager = self._application.getMachineManager()
  119. global_stack = machine_manager.activeMachine
  120. context = self.createContextForDefaultValueEvaluation(global_stack)
  121. context.context["evaluate_from_container_index"] = container_index
  122. return global_stack.getProperty(property_key, "value", context = context)
  123. # Gets the extruder value for the given setting key starting from the given container index.
  124. def getValueFromContainerAtIndexInExtruder(self, extruder_position: int, property_key: str, container_index: int,
  125. context: Optional["PropertyEvaluationContext"] = None) -> Any:
  126. machine_manager = self._application.getMachineManager()
  127. global_stack = machine_manager.activeMachine
  128. if extruder_position == -1:
  129. extruder_position = int(machine_manager.defaultExtruderPosition)
  130. global_stack = machine_manager.activeMachine
  131. try:
  132. extruder_stack = global_stack.extruderList[int(extruder_position)]
  133. except IndexError:
  134. Logger.log("w", "Value for %s of extruder %s was requested, but that extruder is not available. " % (property_key, extruder_position))
  135. return None
  136. context = self.createContextForDefaultValueEvaluation(extruder_stack)
  137. context.context["evaluate_from_container_index"] = container_index
  138. return self.getValueInExtruder(extruder_position, property_key, context)
  139. # Creates a context for evaluating default values (skip the user_changes container).
  140. def createContextForDefaultValueEvaluation(self, source_stack: "CuraContainerStack") -> "PropertyEvaluationContext":
  141. context = PropertyEvaluationContext(source_stack)
  142. context.context["evaluate_from_container_index"] = 1 # skip the user settings container
  143. context.context["override_operators"] = {
  144. "extruderValue": self.getDefaultValueInExtruder,
  145. "extruderValues": self.getDefaultValuesInAllExtruders,
  146. "resolveOrValue": self.getDefaultResolveOrValue,
  147. }
  148. return context