chiark / gitweb /
Added some comments to explain settings a bit more.
authordaid <daid303@gmail.com>
Fri, 20 Sep 2013 06:31:15 +0000 (08:31 +0200)
committerdaid <daid303@gmail.com>
Fri, 20 Sep 2013 06:31:15 +0000 (08:31 +0200)
Cura/util/profile.py

index 4178fa662bf3cec6277b450952ada3a79dfaca40..3f039aa0d82a8026cb89769cba312ac20b63c8fd 100644 (file)
@@ -13,9 +13,19 @@ from Cura.util import resources
 from Cura.util import version
 from Cura.util import validators
 
+#The setting dictionary contains a key/value reference to all possible settings. With the setting name as key.
 settingsDictionary = {}
-settingsList = []
+
 class setting(object):
+       #A setting object contains a configuration setting. These are globally accessable trough the quick access functions
+       # and trough the settingsDictionary function.
+       # Settings can be:
+       # * profile settings (settings that effect the slicing process and the print result)
+       # * preferences (settings that effect how cura works and acts)
+       # * machine settings (settings that relate to the physical configuration of your machine)
+       # * alterations (bad name copied from Skeinforge. These are the start/end code pieces)
+       # Settings have validators that check if the value is valid, but do not prevent invalid values!
+       # Settings have conditions that enable/disable this setting depending on other settings. (Ex: Dual-extrusion)
        def __init__(self, name, default, type, category, subcategory):
                self._name = name
                self._label = name
@@ -43,7 +53,7 @@ class setting(object):
                self._tooltip = tooltip
                return self
 
-       def setRange(self, minValue = None, maxValue = None):
+       def setRange(self, minValue=None, maxValue=None):
                if len(self._validators) < 1:
                        return
                self._validators[0].minValue = minValue