Browse Source

Add documentation for ContainerGroup

Lipu Fei 7 years ago
parent
commit
025239c26e
1 changed files with 13 additions and 0 deletions
  1. 13 0
      cura/Machines/ContainerGroup.py

+ 13 - 0
cura/Machines/ContainerGroup.py

@@ -8,6 +8,19 @@ from PyQt5.Qt import QObject, pyqtSlot
 from cura.Machines.ContainerNode import ContainerNode
 from cura.Machines.ContainerNode import ContainerNode
 
 
 
 
+#
+# A ContainerGroup represents a group of containers that must be applied to each ContainerStack when it's used.
+# Some concrete examples are Quality and QualityChanges: when we select quality type "normal", this quality type
+# must be applied to all stacks in a machine, although each stack can have different containers. Use an Ultimaker 3
+# as an example, suppose we choose quality type "normal", the actual InstanceConstainers on each stack may look
+# as below:
+#                       GlobalStack         ExtruderStack 1         ExtruderStack 2
+# quality container:    um3_global_normal   um3_aa04_pla_normal     um3_aa04_abs_normal
+#
+# This ContainerGroup is mainly used in quality and quality_changes to group the containers that can be applied to
+# a machine, so when a quality/custom quality is selected, the container can be directly applied to each stack instead
+# of looking them up again.
+#
 class ContainerGroup(QObject):
 class ContainerGroup(QObject):
 
 
     def __init__(self, name: str, parent = None):
     def __init__(self, name: str, parent = None):