chiark / gitweb /
Initial fakeouts for Mangrove
[cura.git] / Cura / util / profile.py
1 """
2 The profile module contains all the settings for Cura.
3 These settings can be globally accessed and modified.
4 """
5 from __future__ import division
6 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
7
8 import os
9 import traceback
10 import math
11 import re
12 import zlib
13 import base64
14 import time
15 import sys
16 import platform
17 import glob
18 import string
19 import stat
20 import types
21 import cPickle as pickle
22 import numpy
23 if sys.version_info[0] < 3:
24         import ConfigParser
25 else:
26         import configparser as ConfigParser
27
28 from Cura.util import version
29 from Cura.util import validators
30
31 #The settings dictionary contains a key/value reference to all possible settings. With the setting name as key.
32 settingsDictionary = {}
33 #The settings list is used to keep a full list of all the settings. This is needed to keep the settings in the proper order,
34 # as the dictionary will not contain insertion order.
35 settingsList = []
36
37 #Currently selected machine (by index) Cura support multiple machines in the same preferences and can switch between them.
38 # Each machine has it's own index and unique name.
39 _selectedMachineIndex = 0
40
41 class setting(object):
42         """
43                 A setting object contains a configuration setting. These are globally accessible trough the quick access functions
44                 and trough the settingsDictionary function.
45                 Settings can be:
46                 * profile settings (settings that effect the slicing process and the print result)
47                 * preferences (settings that effect how cura works and acts)
48                 * machine settings (settings that relate to the physical configuration of your machine)
49                 * alterations (bad name copied from Skeinforge. These are the start/end code pieces)
50                 Settings have validators that check if the value is valid, but do not prevent invalid values!
51                 Settings have conditions that enable/disable this setting depending on other settings. (Ex: Dual-extrusion)
52         """
53         def __init__(self, name, default, type, category, subcategory):
54                 self._name = name
55                 self._label = name
56                 self._tooltip = ''
57                 self._default = unicode(default)
58                 self._values = []
59                 self._type = type
60                 self._category = category
61                 self._subcategory = subcategory
62                 self._expert_sub_category = None
63                 self._validators = []
64                 self._conditions = []
65
66                 if type is types.FloatType:
67                         validators.validFloat(self)
68                 elif type is types.IntType:
69                         validators.validInt(self)
70
71                 global settingsDictionary
72                 settingsDictionary[name] = self
73                 global settingsList
74                 settingsList.append(self)
75
76         def setLabel(self, label, tooltip = ''):
77                 self._label = label
78                 self._tooltip = tooltip
79                 return self
80
81         def setRange(self, minValue=None, maxValue=None):
82                 if len(self._validators) < 1:
83                         return
84                 self._validators[0].minValue = minValue
85                 self._validators[0].maxValue = maxValue
86                 return self
87
88         def getLabel(self):
89                 return _(self._label)
90
91         def getTooltip(self):
92                 return _(self._tooltip)
93
94         def getCategory(self):
95                 return self._category
96
97         def getSubCategory(self):
98                 return self._subcategory
99
100         def getExpertSubCategory(self):
101                 return self._expert_sub_category
102
103         def setExpertSubCategory(self, expert_sub_category):
104                 self._expert_sub_category = expert_sub_category
105                 return self
106
107         def isPreference(self):
108                 return self._category == 'preference'
109
110         def isMachineSetting(self):
111                 return self._category == 'machine'
112
113         def isAlteration(self):
114                 return self._category == 'alteration'
115
116         def isProfile(self):
117                 return not self.isAlteration() and not self.isPreference() and not self.isMachineSetting()
118
119         def getName(self):
120                 return self._name
121
122         def getType(self):
123                 return self._type
124
125         def getValue(self, index = None):
126                 if index is None:
127                         index = self.getValueIndex()
128                 if index >= len(self._values):
129                         return self._default
130                 return self._values[index]
131
132         def getDefault(self):
133                 return self._default
134
135         def setValue(self, value, index = None):
136                 if index is None:
137                         index = self.getValueIndex()
138                 while index >= len(self._values):
139                         self._values.append(self._default)
140                 self._values[index] = unicode(value)
141
142         def getValueIndex(self):
143                 if self.isMachineSetting() or self.isProfile() or self.isAlteration():
144                         global _selectedMachineIndex
145                         return _selectedMachineIndex
146                 return 0
147
148         def validate(self):
149                 result = validators.SUCCESS
150                 msgs = []
151                 for validator in self._validators:
152                         res, err = validator.validate()
153                         if res == validators.ERROR:
154                                 result = res
155                         elif res == validators.WARNING and result != validators.ERROR:
156                                 result = res
157                         if len(err) > 0:
158                                 msgs.append(err)
159                 return result, '\n'.join(msgs)
160
161         def addCondition(self, conditionFunction):
162                 self._conditions.append(conditionFunction)
163
164         def checkConditions(self):
165                 for condition in self._conditions:
166                         if not condition():
167                                 return False
168                 return True
169
170 #########################################################
171 ## Settings
172 #########################################################
173
174 #Define a fake _() function to fake the gettext tools in to generating strings for the profile settings.
175 def _(n):
176         return n
177
178 setting('layer_height',              0.1, float, 'basic',    _('Quality')).setRange(0.0001).setLabel(_("Layer height (mm)"), _("Layer height in millimeters.\nThis is the most important setting to determine the quality of your print. Smaller layer heights will give a finer surface but will give longer print time. Larger layer heights will provide fast prints but a rougher surface."))
179 setting('wall_thickness',            0.8, float, 'basic',    _('Quality')).setRange(0.0).setLabel(_("Shell thickness (mm)"), _("Thickness of the outside shell in the horizontal direction.\nThis is used in combination with the nozzle size to define the number\nof perimeter lines and the thickness of those perimeter lines."))
180 setting('retraction_enable',        True, bool,  'basic',    _('Quality')).setExpertSubCategory(_('Retraction')).setLabel(_("Enable retraction"), _("Retract the filament when the nozzle is moving over a none-printed area. Details about the retraction can be configured in the advanced tab."))
181 setting('solid_layer_thickness',     0.6, float, 'basic',    _('Fill')).setRange(0).setLabel(_("Bottom/Top thickness (mm)"), _("This controls the thickness of the bottom and top layers, the amount of solid layers put down is calculated by the layer thickness and this value.\nHaving this value a multiple of the layer thickness makes sense. And keep it near your wall thickness to make an evenly strong part."))
182 setting('fill_density',               20, float, 'basic',    _('Fill')).setExpertSubCategory(_('Infill')).setRange(0, 100).setLabel(_("Fill Density (%)"), _("This controls how densely filled the insides of your print will be. For a solid part use 100%, for an empty part use 0%. A value around 20% is usually enough.\nThis will not affect the outside of the print and only adjusts how strong the part becomes."))
183 setting('perimeter_before_infill',               True, bool, 'basic',    _('Fill')).setLabel(_("Perimeters before Infill"), _("This controls whether the perimeters should be printed before or after the infill. Printing the perimeter after the infill may improve the quality of prints with very low layer heights, while printing the perimeters before the infill will give better results for layer height above 0.1mm"))
184 setting('nozzle_size',               0.4, float, 'advanced', _('Machine')).setRange(0.1,10).setLabel(_("Nozzle size (mm)"), _("The nozzle size is very important, this is used to calculate the line width of the infill, and used to calculate the amount of outside wall lines and thickness for the wall thickness you entered in the print settings."))
185 setting('print_speed',                50, float, 'basic',    _('Speed and Temperature')).setRange(1).setLabel(_("Print speed (mm/s)"), _("Speed at which printing happens. A well adjusted 3D printer can reach high speeds. However, for high quality prints slower speeds are required. Printing speed depends on a lot of factors. You will be experimenting with optimal settings for this."))
186 setting('print_temperature',         210, int,   'basic',    _('Speed and Temperature')).setRange(0,340).setLabel(_("Printing temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA 205C is recommended.\nFor ABS and HIPS 240C is recommended."))
187 setting('print_temperature2',          0, int,   'basic',    _('Speed and Temperature')).setRange(0,340).setLabel(_("2nd nozzle temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA 205C is recommended.\nFor ABS and HIPS 240C is recommended."))
188 setting('print_temperature3',          0, int,   'basic',    _('Speed and Temperature')).setRange(0,340).setLabel(_("3th nozzle temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA 205C is recommended.\nFor ABS and HIPS 240C is recommended."))
189 setting('print_temperature4',          0, int,   'basic',    _('Speed and Temperature')).setRange(0,340).setLabel(_("4th nozzle temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA 205C is recommended.\nFor ABS and HIPS 240C is recommended."))
190 setting('print_temperature5',          0, int,   'basic',    _('Speed and Temperature')).setRange(0,340).setLabel(_("5th nozzle temperature (C)"), _("Temperature used for printing. Set at 0 to pre-heat yourself.\nFor PLA 205C is recommended.\nFor ABS and HIPS 240C is recommended."))
191 setting('print_bed_temperature',      70, int,   'basic',    _('Speed and Temperature')).setRange(0,340).setLabel(_("Bed temperature (C)"), _("Temperature used for the heated printer bed. Set at 0 to pre-heat yourself.\nFor PLA 60C is recommended.\nFor ABS and HIPS 110C is recommended."))
192 setting('support',                'None', [_('None'), _('Touching buildplate'), _('Everywhere')], 'basic', _('Support')).setExpertSubCategory(_('Support')).setLabel(_("Support type"), _("Type of support structure build.\n\"Support is useful when a model has severe over hangs. Using this option does require some finishing of the print, including removing the support material.\n\"Touching buildplate\" is the most commonly used support setting.\n\nNone does not do any support.\nTouching buildplate only creates support where the support structure will touch the build platform.\nEverywhere creates support even on top of parts of the model."))
193 setting('platform_adhesion',      'None', [_('None'), _('Brim'), _('Raft')], 'basic', _('Support')).setExpertSubCategory([_('Skirt'), _('Brim'), _('Raft')]).setLabel(_("Platform adhesion type"), _("Different options that help in preventing corners from lifting due to warping.\nBrim adds a single layer thick flat area around your object which is easy to cut off afterwards, and it is the recommended option.\nRaft adds a thick raster below the object and a thin interface between this and your object.\n(Note that enabling the brim or raft disables the skirt)"))
194 setting('support_dual_extrusion',  'Both', [_('Both'), _('First extruder'), _('Second extruder')], 'basic', _('Support')).setLabel(_("Support dual extrusion"), _("Which extruder to use for support material, for break-away support you can use both extruders.\nBut if one of the materials is more expensive then the other you could select an extruder to use for support material. This causes more extruder switches.\nYou can also use the 2nd extruder for soluble support materials."))
195 setting('wipe_tower',              False, bool,  'basic',    _('Dual extrusion')).setLabel(_("Wipe&prime tower"), _("The wipe-tower is a tower printed on every layer when switching between nozzles.\nThe old nozzle is wiped off on the tower before the new nozzle is used to print the 2nd color."))
196 setting('wipe_tower_volume',          15, float, 'expert',   _('Dual extrusion')).setLabel(_("Wipe&prime tower volume per layer (mm3)"), _("The amount of material put in the wipe/prime tower.\nThis is done in volume because in general you want to extrude a\ncertain amount of volume to get the extruder going, independent on the layer height.\nThis means that with thinner layers, your tower gets bigger."))
197 setting('ooze_shield',             False, bool,  'basic',    _('Dual extrusion')).setLabel(_("Ooze shield"), _("The ooze shield is a 1 line thick shell around the object which stands a few mm from the object.\nThis shield catches any oozing from the unused nozzle in dual-extrusion."))
198 setting('filament_diameter',        2.85, float, 'basic',    _('Filament')).setRange(1).setLabel(_("Diameter (mm)"), _("Diameter of your filament, as accurately as possible.\nIf you cannot measure this value you will have to calibrate it, a higher number means less extrusion, a smaller number generates more extrusion."))
199 setting('filament_diameter2',          0, float, 'basic',    _('Filament')).setRange(0).setLabel(_("Diameter2 (mm)"), _("Diameter of your filament for the 2nd nozzle. Use 0 to use the same diameter as for nozzle 1."))
200 setting('filament_diameter3',          0, float, 'basic',    _('Filament')).setRange(0).setLabel(_("Diameter3 (mm)"), _("Diameter of your filament for the 3th nozzle. Use 0 to use the same diameter as for nozzle 1."))
201 setting('filament_diameter4',          0, float, 'basic',    _('Filament')).setRange(0).setLabel(_("Diameter4 (mm)"), _("Diameter of your filament for the 4th nozzle. Use 0 to use the same diameter as for nozzle 1."))
202 setting('filament_diameter5',          0, float, 'basic',    _('Filament')).setRange(0).setLabel(_("Diameter5 (mm)"), _("Diameter of your filament for the 5th nozzle. Use 0 to use the same diameter as for nozzle 1."))
203 setting('filament_flow',            100., float, 'basic',    _('Filament')).setRange(5,300).setLabel(_("Flow (%)"), _("Flow compensation, the amount of material extruded is multiplied by this value"))
204 setting('retraction_speed',         40.0, float, 'advanced', _('Retraction')).setRange(0.1).setLabel(_("Speed (mm/s)"), _("Speed at which the filament is retracted, a higher retraction speed works better. But a very high retraction speed can lead to filament grinding."))
205 setting('retraction_amount',         4.5, float, 'advanced', _('Retraction')).setRange(0).setLabel(_("Distance (mm)"), _("Amount of retraction, set at 0 for no retraction at all. A value between 1 and 2 millimeters provides good results for most materials."))
206 setting('retraction_dual_amount',   16.5, float, 'advanced', _('Retraction')).setRange(0).setLabel(_("Dual extrusion switch amount (mm)"), _("Amount of retraction when switching nozzle with dual-extrusion, set at 0 for no retraction at all. A value of 16.0mm seems to generate good results."))
207 setting('retraction_min_travel',     1.5, float, 'expert',   _('Retraction')).setRange(0).setLabel(_("Minimum travel (mm)"), _("Minimum amount of travel needed for a retraction to happen at all. This setting is used to prevent from having too many retractions in a small area."))
208 setting('retraction_combing',      'All',  [_('Off'),_('All'),_('No Skin')], 'expert', _('Retraction')).setLabel(_("Combing type"), _("When moving between print areas, combing keeps the print head above already printed areas and skips retraction. This helps reduce stringing and reduces the chance of grinding the filament. If combing is \'Off\' the printer head moves straight from the start point to the end point and it will always retract.  If \'All\', combing is always enabled.  If \'No Skin\', combing will not occur on skin (top/bottom fill layers) surfaces."))
209 setting('retraction_minimal_extrusion',0.02, float,'expert', _('Retraction')).setRange(0).setLabel(_("Minimal extrusion before retracting (mm)"), _("The minimal amount of extrusion that needs to be done before retracting again if a retraction needs to happen before this minimal is reached the retraction is ignored.\nThis avoids retracting a lot on the same piece of filament which flattens the filament and causes grinding issues."))
210 setting('retraction_hop',            0.0, float, 'expert',   _('Retraction')).setRange(0).setLabel(_("Z hop when retracting (mm)"), _("When a retraction is done, the head is lifted by this amount to travel over the print. A value of 0.075 works well. This feature has a lot of positive effect on delta towers."))
211 setting('bottom_thickness',          0.3, float, 'advanced', _('Quality')).setRange(0).setLabel(_("Initial layer thickness (mm)"), _("Layer thickness of the bottom layer. A thicker bottom layer makes sticking to the bed easier. Set to 0.0 to have the bottom layer thickness the same as the other layers."))
212 setting('layer0_width_factor',       100, float, 'advanced', _('Quality')).setRange(50, 300).setLabel(_("Initial layer line width (%)"), _("Extra width factor for the extrusion on the first layer, on some printers it's good to have wider extrusion on the first layer to get better bed adhesion."))
213 setting('object_sink',               0.0, float, 'advanced', _('Quality')).setRange(0).setLabel(_("Cut off object bottom (mm)"), _("Sinks the object into the platform, this can be used for objects that do not have a flat bottom and thus create a too small first layer."))
214 #setting('enable_skin',             False, bool,  'advanced', _('Quality')).setLabel(_("Duplicate outlines"), _("Skin prints the outer lines of the prints twice, each time with half the thickness. This gives the illusion of a higher print quality."))
215 setting('overlap_dual',             0.15, float, 'advanced', _('Quality')).setLabel(_("Dual extrusion overlap (mm)"), _("Add a certain amount of overlapping extrusion on dual-extrusion prints. This bonds the different colors together."))
216 setting('travel_speed',            150.0, float, 'advanced', _('Speed')).setRange(0.1).setLabel(_("Travel speed (mm/s)"), _("Speed at which travel moves are done. A higher value will provide faster print times. Beware that too fast of a speed can reduce print reliability. Most high quality printers can handle 150mm/s to 200mm/s with no problems."))
217 setting('bottom_layer_speed',         20, float, 'advanced', _('Speed')).setRange(0.1).setLabel(_("Bottom layer speed (mm/s)"), _("Print speed for the bottom layer. It is generally best to print the first layer slower so it sticks better to the printer bed."))
218 setting('infill_speed',              0.0, float, 'advanced', _('Speed')).setRange(0.0).setLabel(_("Infill speed (mm/s)"), _("Speed at which infill parts are printed. If set to 0 then the print speed is used for the infill. Printing the infill faster can greatly reduce printing time, but this can negatively affect print quality if made too fast."))
219 setting('solidarea_speed',           0.0, float, 'advanced', _('Speed')).setRange(0.0).setLabel(_("Top/bottom speed (mm/s)"), _("Speed at which top/bottom parts are printed. If set to 0 then the print speed is used for the infill. Printing the top/bottom faster can greatly reduce printing time, but this can negatively affect print quality."))
220 setting('inset0_speed',              0.0, float, 'advanced', _('Speed')).setRange(0.0).setLabel(_("Outer shell speed (mm/s)"), _("Speed at which outer shell is printed. If set to 0 then the print speed is used. Printing the outer shell at a lower speed improves the final skin quality. However, having a large difference between the inner shell speed and the outer shell speed will effect quality in a negative way."))
221 setting('insetx_speed',              0.0, float, 'advanced', _('Speed')).setRange(0.0).setLabel(_("Inner shell speed (mm/s)"), _("Speed at which inner shells are printed. If set to 0 then the print speed is used. Printing the inner shell faster then the outer shell will reduce printing time. It is good to set this somewhere in between the outer shell speed and the infill/printing speed."))
222 setting('cool_min_layer_time',         5, float, 'advanced', _('Cool')).setRange(0).setLabel(_("Minimal layer time (sec)"), _("Minimum time spent in a layer, gives the layer time to cool down before the next layer is put on top. If the layer will be placed down too fast the printer will slow down to make sure it has spent at least this amount of seconds printing this layer."))
223 setting('fan_enabled',              True, bool,  'advanced', _('Cool')).setExpertSubCategory(_('Cool')).setLabel(_("Enable cooling fan"), _("Enable the cooling fan during the print. The extra cooling from the cooling fan is essential during faster prints and with PLA."))
224
225 setting('skirt_line_count',            1, int,   'expert', _('Skirt')).setRange(0).setLabel(_("Line count"), _("The skirt is a line drawn around the object at the first layer. This helps to prime your extruder, and to see if the object fits on your platform.\nSetting this to 0 will disable the skirt. Multiple skirt lines can help priming your extruder better for small objects."))
226 setting('skirt_gap',                 3.0, float, 'expert', _('Skirt')).setRange(0).setLabel(_("Start distance (mm)"), _("The distance between the skirt and the first layer.\nThis is the minimal distance, multiple skirt lines will be put outwards from this distance."))
227 setting('skirt_minimal_length',    150.0, float, 'expert', _('Skirt')).setRange(0).setLabel(_("Minimal length (mm)"), _("The minimal length of the skirt, if this minimal length is not reached it will add more skirt lines to reach this minimal lenght.\nNote: If the line count is set to 0 this is ignored."))
228 setting('fan_full_height',           0.5, float, 'expert',   _('Cool')).setRange(0).setLabel(_("Fan full on at height (mm)"), _("The height at which the fan is turned on completely. For the layers below this the fan speed is scaled linearly with the fan off at layer 0."))
229 setting('fan_speed',                 100, int,   'expert',   _('Cool')).setRange(0,100).setLabel(_("Fan speed min (%)"), _("When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Minimal fan speed is used if the layer is not slowed down due to cooling."))
230 setting('fan_speed_max',             100, int,   'expert',   _('Cool')).setRange(0,100).setLabel(_("Fan speed max (%)"), _("When the fan is turned on, it is enabled at this speed setting. If cool slows down the layer, the fan is adjusted between the min and max speed. Maximal fan speed is used if the layer is slowed down due to cooling by more than 200%."))
231 setting('cool_min_feedrate',          10, float, 'expert',   _('Cool')).setRange(0).setLabel(_("Minimum speed (mm/s)"), _("The minimal layer time can cause the print to slow down so much it starts to ooze. The minimal feedrate protects against this. Even if a print gets slowed down it will never be slower than this minimal speed."))
232 setting('cool_head_lift',          False, bool,  'expert',   _('Cool')).setLabel(_("Cool head lift"), _("Lift the head if the minimal speed is hit because of cool slowdown, and wait the extra time so the minimal layer time is always hit."))
233 setting('solid_top', True, bool, 'expert', _('Infill')).setLabel(_("Solid infill top"), _("Create a solid top surface, if set to false the top is filled with the fill percentage. Useful for cups/vases."))
234 setting('solid_bottom', True, bool, 'expert', _('Infill')).setLabel(_("Solid infill bottom"), _("Create a solid bottom surface, if set to false the bottom is filled with the fill percentage. Useful for buildings."))
235 setting('fill_overlap', 15, int, 'expert', _('Infill')).setRange(0,100).setLabel(_("Infill overlap (%)"), _("Amount of overlap between the infill and the walls. There is a slight overlap with the walls and the infill so the walls connect firmly to the infill."))
236 setting('support_type', 'Lines', ['Grid', 'Lines'], 'expert', _('Support')).setLabel(_("Structure type"), _("The type of support structure.\nGrid is very strong and can come off in 1 piece, however, sometimes it is too strong.\nLines are single walled lines that break off one at a time. Which is more work to remove, but as it is less strong it does work better on tricky prints."))
237 setting('support_angle', 60, float, 'expert', _('Support')).setRange(0,90).setLabel(_("Overhang angle for support (deg)"), _("The minimal angle that overhangs need to have to get support. Setting this to 0 degrees means every overhang will be supported. 90 degrees effectively disables support."))
238 setting('support_fill_rate', 15, int, 'expert', _('Support')).setRange(0,100).setLabel(_("Fill amount (%)"), _("Amount of infill structure in the support material, less material gives weaker support which is easier to remove. 15% seems to be a good average."))
239 setting('support_xy_distance', 0.7, float, 'expert', _('Support')).setRange(0,10).setLabel(_("Distance X/Y (mm)"), _("Distance of the support material from the print, in the X/Y directions.\n0.7mm gives a nice distance from the print so the support does not stick to the print."))
240 setting('support_z_distance', 0.15, float, 'expert', _('Support')).setRange(0,10).setLabel(_("Distance Z (mm)"), _("Distance from the top/bottom of the support to the print. A small gap here makes it easier to remove the support but makes the print a bit uglier.\n0.15mm gives a good seperation of the support material."))
241 setting('spiralize', False, bool, 'expert', _('Black Magic')).setLabel(_("Spiralize the outer contour"), _("Spiralize is smoothing out the Z move of the outer edge. This will create a steady Z increase over the whole print. This feature turns a solid object into a single walled print with a solid bottom.\nThis feature used to be called Joris in older versions."))
242 setting('simple_mode', False, bool, 'expert', _('Black Magic')).setLabel(_("Only follow mesh surface"), _("Only follow the mesh surfaces of the 3D model, do not do anything else. No infill, no top/bottom, nothing."))
243 #setting('bridge_speed', 100, int, 'expert', 'Bridge').setRange(0,100).setLabel(_("Bridge speed (%)"), _("Speed at which layers with bridges are printed, compared to normal printing speed."))
244 setting('brim_line_count', 20, int, 'expert', _('Brim')).setRange(1,100).setLabel(_("Brim line amount"), _("The amount of lines used for a brim, more lines means a larger brim which sticks better, but this also makes your effective print area smaller."))
245 setting('raft_margin', 5.0, float, 'expert', _('Raft')).setRange(0).setLabel(_("Extra margin (mm)"), _("If the raft is enabled, this is the extra raft area around the object which is also rafted. Increasing this margin will create a stronger raft while using more material and leaving less area for your print."))
246 setting('raft_line_spacing', 3.0, float, 'expert', _('Raft')).setRange(0).setLabel(_("Line spacing (mm)"), _("When you are using the raft this is the distance between the centerlines of the raft line."))
247 setting('raft_base_thickness', 0.3, float, 'expert', _('Raft')).setRange(0).setLabel(_("Base thickness (mm)"), _("When you are using the raft this is the thickness of the base layer which is put down."))
248 setting('raft_base_linewidth', 1.0, float, 'expert', _('Raft')).setRange(0).setLabel(_("Base line width (mm)"), _("When you are using the raft this is the width of the base layer lines which are put down."))
249 setting('raft_interface_thickness', 0.27, float, 'expert', _('Raft')).setRange(0).setLabel(_("Interface thickness (mm)"), _("When you are using the raft this is the thickness of the interface layer which is put down."))
250 setting('raft_interface_linewidth', 0.4, float, 'expert', _('Raft')).setRange(0).setLabel(_("Interface line width (mm)"), _("When you are using the raft this is the width of the interface layer lines which are put down."))
251 setting('raft_airgap_all', 0.0, float, 'expert', _('Raft')).setRange(0).setLabel(_("Airgap"), _("Gap between the last layer of the raft the whole print."))
252 setting('raft_airgap', 0.22, float, 'expert', _('Raft')).setRange(0).setLabel(_("First Layer Airgap"), _("Gap between the last layer of the raft and the first printing layer. A small gap of 0.2mm works wonders on PLA and makes the raft easy to remove. This value is added on top of the 'Airgap' setting."))
253 setting('raft_surface_layers', 2, int, 'expert', _('Raft')).setRange(0).setLabel(_("Surface layers"), _("Amount of surface layers put on top of the raft, these are fully filled layers on which the model is printed."))
254 setting('raft_surface_thickness', 0.27, float, 'expert', _('Raft')).setRange(0).setLabel(_("Surface layer thickness (mm)"), _("Thickness of each surface layer."))
255 setting('raft_surface_linewidth', 0.4, float, 'expert', _('Raft')).setRange(0).setLabel(_("Surface layer line width (mm)"), _("Width of the lines for each surface layer."))
256 setting('fix_horrible_union_all_type_a', True,  bool, 'expert', _('Fix horrible')).setLabel(_("Combine everything (Type-A)"), _("This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is dependent on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer."))
257 setting('fix_horrible_union_all_type_b', False, bool, 'expert', _('Fix horrible')).setLabel(_("Combine everything (Type-B)"), _("This expert option adds all parts of the model together. The result is usually that internal cavities disappear. Depending on the model this can be intended or not. Enabling this option is at your own risk. Type-A is dependent on the model normals and tries to keep some internal holes intact. Type-B ignores all internal holes and only keeps the outside shape per layer."))
258 setting('fix_horrible_use_open_bits', False, bool, 'expert', _('Fix horrible')).setLabel(_("Keep open faces"), _("This expert option keeps all the open bits of the model intact. Normally Cura tries to stitch up small holes and remove everything with big holes, but this option keeps bits that are not properly part of anything and just goes with whatever is left. This option is usually not what you want, but it might enable you to slice models otherwise failing to produce proper paths.\nAs with all \"Fix horrible\" options, results may vary and use at your own risk."))
259 setting('fix_horrible_extensive_stitching', False, bool, 'expert', _('Fix horrible')).setLabel(_("Extensive stitching"), _("Extensive stitching tries to fix up open holes in the model by closing the hole with touching polygons. This algorthm is quite expensive and could introduce a lot of processing time.\nAs with all \"Fix horrible\" options, results may vary and use at your own risk."))
260
261 setting('plugin_config', '', str, 'hidden', 'hidden')
262 setting('object_center_x', -1, float, 'hidden', 'hidden')
263 setting('object_center_y', -1, float, 'hidden', 'hidden')
264
265 setting('simpleModeSettings', '', str, 'hidden', 'hidden')
266
267 setting('start.gcode', """;Sliced at: {day} {date} {time}
268 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
269 ;Print time: {print_time}
270 ;Filament used: {filament_amount}m {filament_weight}g
271 ;Filament cost: {filament_cost}
272 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
273 ;M109 S{print_temperature} ;Uncomment to add your own temperature line
274 G21        ;metric values
275 G90        ;absolute positioning
276 M82        ;set extruder to absolute mode
277 M107       ;start with the fan off
278
279 G28 X0 Y0  ;move X/Y to min endstops
280 G28 Z0     ;move Z to min endstops
281
282 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
283
284 G92 E0                  ;zero the extruded length
285 G1 F200 E3              ;extrude 3mm of feed stock
286 G92 E0                  ;zero the extruded length again
287 G1 F{travel_speed}
288 ;Put printing message on LCD screen
289 M117 Printing...
290 """, str, 'alteration', 'alteration')
291 #######################################################################################
292 setting('end.gcode', """;End GCode
293 M104 S0                     ;extruder heater off
294 M140 S0                     ;heated bed heater off (if you have it)
295
296 G91                                    ;relative positioning
297 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
298 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
299 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
300
301 M84                         ;steppers off
302 G90                         ;absolute positioning
303 ;{profile_string}
304 """, str, 'alteration', 'alteration')
305 #######################################################################################
306 setting('start2.gcode', """;Sliced at: {day} {date} {time}
307 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
308 ;Print time: {print_time}
309 ;Filament used: {filament_amount}m {filament_weight}g
310 ;Filament cost: {filament_cost}
311 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
312 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
313 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
314 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
315 G21        ;metric values
316 G90        ;absolute positioning
317 M107       ;start with the fan off
318
319 G28 X0 Y0  ;move X/Y to min endstops
320 G28 Z0     ;move Z to min endstops
321
322 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
323
324 T1                      ;Switch to the 2nd extruder
325 G92 E0                  ;zero the extruded length
326 G1 F200 E10             ;extrude 10mm of feed stock
327 G92 E0                  ;zero the extruded length again
328 G1 F200 E-{retraction_dual_amount}
329
330 T0                      ;Switch to the first extruder
331 G92 E0                  ;zero the extruded length
332 G1 F200 E10             ;extrude 10mm of feed stock
333 G92 E0                  ;zero the extruded length again
334 G1 F{travel_speed}
335 ;Put printing message on LCD screen
336 M117 Printing...
337 """, str, 'alteration', 'alteration')
338 #######################################################################################
339 setting('end2.gcode', """;End GCode
340 M104 T0 S0                     ;extruder heater off
341 M104 T1 S0                     ;extruder heater off
342 M140 S0                     ;heated bed heater off (if you have it)
343
344 G91                                    ;relative positioning
345 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
346 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
347 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
348
349 M84                         ;steppers off
350 G90                         ;absolute positioning
351 ;{profile_string}
352 """, str, 'alteration', 'alteration')
353 #######################################################################################
354 setting('start3.gcode', """;Sliced at: {day} {date} {time}
355 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
356 ;Print time: {print_time}
357 ;Filament used: {filament_amount}m {filament_weight}g
358 ;Filament cost: {filament_cost}
359 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
360 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
361 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
362 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
363 G21        ;metric values
364 G90        ;absolute positioning
365 M107       ;start with the fan off
366
367 G28 X0 Y0  ;move X/Y to min endstops
368 G28 Z0     ;move Z to min endstops
369
370 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
371
372 T2                      ;Switch to the 2nd extruder
373 G92 E0                  ;zero the extruded length
374 G1 F200 E10             ;extrude 10mm of feed stock
375 G92 E0                  ;zero the extruded length again
376 G1 F200 E-{retraction_dual_amount}
377
378 T1                      ;Switch to the 2nd extruder
379 G92 E0                  ;zero the extruded length
380 G1 F200 E10             ;extrude 10mm of feed stock
381 G92 E0                  ;zero the extruded length again
382 G1 F200 E-{retraction_dual_amount}
383
384 T0                      ;Switch to the first extruder
385 G92 E0                  ;zero the extruded length
386 G1 F200 E10             ;extrude 10mm of feed stock
387 G92 E0                  ;zero the extruded length again
388 G1 F{travel_speed}
389 ;Put printing message on LCD screen
390 M117 Printing...
391 """, str, 'alteration', 'alteration')
392 #######################################################################################
393 setting('end3.gcode', """;End GCode
394 M104 T0 S0                     ;extruder heater off
395 M104 T1 S0                     ;extruder heater off
396 M104 T2 S0                     ;extruder heater off
397 M140 S0                     ;heated bed heater off (if you have it)
398
399 G91                                    ;relative positioning
400 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
401 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
402 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
403
404 M84                         ;steppers off
405 G90                         ;absolute positioning
406 ;{profile_string}
407 """, str, 'alteration', 'alteration')
408 setting('start4.gcode', """;Sliced at: {day} {date} {time}
409 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
410 ;Print time: {print_time}
411 ;Filament used: {filament_amount}m {filament_weight}g
412 ;Filament cost: {filament_cost}
413 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
414 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
415 ;M109 T2 S{print_temperature2} ;Uncomment to add your own temperature line
416 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
417 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
418 G21        ;metric values
419 G90        ;absolute positioning
420 M107       ;start with the fan off
421
422 G28 X0 Y0  ;move X/Y to min endstops
423 G28 Z0     ;move Z to min endstops
424
425 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
426
427 T3                      ;Switch to the 4th extruder
428 G92 E0                  ;zero the extruded length
429 G1 F200 E10             ;extrude 10mm of feed stock
430 G92 E0                  ;zero the extruded length again
431 G1 F200 E-{retraction_dual_amount}
432
433 T2                      ;Switch to the 3th extruder
434 G92 E0                  ;zero the extruded length
435 G1 F200 E10             ;extrude 10mm of feed stock
436 G92 E0                  ;zero the extruded length again
437 G1 F200 E-{retraction_dual_amount}
438
439 T1                      ;Switch to the 2nd extruder
440 G92 E0                  ;zero the extruded length
441 G1 F200 E10             ;extrude 10mm of feed stock
442 G92 E0                  ;zero the extruded length again
443 G1 F200 E-{retraction_dual_amount}
444
445 T0                      ;Switch to the first extruder
446 G92 E0                  ;zero the extruded length
447 G1 F200 E10             ;extrude 10mm of feed stock
448 G92 E0                  ;zero the extruded length again
449 G1 F{travel_speed}
450 ;Put printing message on LCD screen
451 M117 Printing...
452 """, str, 'alteration', 'alteration')
453 #######################################################################################
454 setting('end4.gcode', """;End GCode
455 M104 T0 S0                     ;extruder heater off
456 M104 T1 S0                     ;extruder heater off
457 M104 T2 S0                     ;extruder heater off
458 M104 T3 S0                     ;extruder heater off
459 M140 S0                     ;heated bed heater off (if you have it)
460
461 G91                                    ;relative positioning
462 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
463 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
464 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
465
466 M84                         ;steppers off
467 G90                         ;absolute positioning
468 ;{profile_string}
469 """, str, 'alteration', 'alteration')
470 #######################################################################################
471 setting('support_start.gcode', '', str, 'alteration', 'alteration')
472 setting('support_end.gcode', '', str, 'alteration', 'alteration')
473 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
474 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
475 setting('replace.csv', '', str, 'alteration', 'alteration')
476 #######################################################################################
477 setting('preSwitchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
478 ;This code is added before the T(n)
479 """, str, 'alteration', 'alteration')
480 setting('postSwitchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
481 ;This code is added after the T(n)
482 """, str, 'alteration', 'alteration')
483
484 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
485 setting('simpleModeProfile', 'Standard', str, 'hidden', 'hidden')
486 setting('simpleModeMaterial', 'PLA', str, 'hidden', 'hidden')
487 setting('simpleModeMaterialType', 'Beginner', str, 'hidden', 'hidden')
488 setting('oneAtATime', 'False', bool, 'preference', 'hidden')
489 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'Rocktopus.stl')), str, 'preference', 'hidden')
490 setting('save_profile', 'False', bool, 'preference', 'hidden').setLabel(_("Save profile on slice"), _("When slicing save the profile as [stl_file]_profile.ini next to the model."))
491 setting('filament_cost_kg', '0', float, 'preference', 'hidden').setLabel(_("Cost (price/kg)"), _("Cost of your filament per kg, to estimate the cost of the final print."))
492 setting('filament_cost_meter', '0', float, 'preference', 'hidden').setLabel(_("Cost (price/m)"), _("Cost of your filament per meter, to estimate the cost of the final print."))
493 setting('auto_detect_sd', 'True', bool, 'preference', 'hidden').setLabel(_("Auto detect SD card drive"), _("Auto detect the SD card. You can disable this because on some systems external hard-drives or USB sticks are detected as SD card."))
494
495 def _getMyDocumentsFolder():
496         if platform.system() == "Windows":
497                 path = os.path.expanduser('~/Documents')
498         else:
499                 path = os.path.expanduser('~/')
500         if not os.path.exists(path):
501                 path = ''
502         try:
503                 path = unicode(path)
504         except UnicodeDecodeError:
505                 path = ''
506         return path
507
508 setting('sdcard_rootfolder', _getMyDocumentsFolder(), str, 'preference', 'hidden').setLabel(_("Base folder to replicate on SD card"), _("The specified folder will be used as a base path. Any gcode generated from object coming from within that folder will be automatically saved on the SD card at the same sub-folder. Any object coming from outside of this path will save the gcode on the root folder of the card."))
509 setting('check_for_updates', 'False', bool, 'preference', 'hidden').setLabel(_("Check for updates"), _("Check for newer versions of Cura on startup"))
510 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel(_("Send usage statistics"), _("Submit anonymous usage information to improve future versions of Cura"))
511 setting('youmagine_token', '', str, 'preference', 'hidden')
512 setting('filament_physical_density', '1240', float, 'preference', 'hidden').setRange(500.0, 3000.0).setLabel(_("Density (kg/m3)"), _("Weight of the filament per m3. Around 1240 for PLA. And around 1040 for ABS. This value is used to estimate the weight if the filament used for the print."))
513 setting('language', 'Autodetect', str, 'preference', 'hidden').setLabel(_('Language'), _('Change the language in which Cura runs. Switching language requires a restart of Cura'))
514 setting('active_machine', '0', int, 'preference', 'hidden')
515
516 setting('model_colour', '#C9E240', str, 'preference', 'hidden').setLabel(_('Model colour'), _('Display color for first extruder'))
517 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel(_('Model colour (2)'), _('Display color for second extruder'))
518 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel(_('Model colour (3)'), _('Display color for third extruder'))
519 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel(_('Model colour (4)'), _('Display color for forth extruder'))
520
521 setting('window_maximized', 'True', bool, 'preference', 'hidden')
522 setting('window_pos_x', '-1', float, 'preference', 'hidden')
523 setting('window_pos_y', '-1', float, 'preference', 'hidden')
524 setting('window_width', '-1', float, 'preference', 'hidden')
525 setting('window_height', '-1', float, 'preference', 'hidden')
526 setting('window_normal_sash', '320', float, 'preference', 'hidden')
527 setting('last_run_version', '', str, 'preference', 'hidden')
528
529 setting('machine_name', '', str, 'machine', 'hidden')
530 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
531 setting('machine_width', '205', float, 'machine', 'hidden').setLabel(_("Maximum width (mm)"), _("Maximum width of the machine print area in mm"))
532 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Maximum depth of the machine print area in mm"))
533 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Maximum height of the machine print area in mm"))
534 setting('machine_center_is_zero', 'False', bool, 'machine', 'hidden').setLabel(_("Machine center 0,0"), _("Machines firmware defines the center of the bed as 0,0 instead of the front left corner."))
535 setting('machine_shape', 'Square', ['Square','Circular'], 'machine', 'hidden').setLabel(_("Build area shape"), _("The shape of machine build area."))
536 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
537 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel(_("Heated bed"), _("If you have a heated bed, this enabled heated bed settings (requires restart)"))
538 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'RepRap (Volumetric)', 'UltiGCode', 'MakerBot', 'BFB', 'Mach3/LinuxCNC'], 'machine', 'hidden').setLabel(_("GCode Flavor"), _("Flavor of generated GCode.\nRepRap is normal 5D GCode which works on Marlin/Sprinter based firmwares.\nUltiGCode is a variation of the RepRap GCode which puts more settings in the machine instead of the slicer.\nMakerBot GCode has a few changes in the way GCode is generated, but still requires MakerWare to generate to X3G.\nBFB style generates RPM based code.\nMach3 uses A,B,C instead of E for extruders."))
539 setting('extruder_amount', '1', ['1','2','3','4','5'], 'machine', 'hidden').setLabel(_("Extruder count"), _("Amount of extruders in your machine."))
540 setting('extruder_offset_x1', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your secondary extruder compared to the primary."))
541 setting('extruder_offset_y1', '21.6', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your secondary extruder compared to the primary."))
542 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your tertiary extruder compared to the primary."))
543 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your tertiary extruder compared to the primary."))
544 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
545 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
546 setting('extruder_offset_x4', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
547 setting('extruder_offset_y4', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
548 setting('extruder_z_offset', '0.0', float, 'machine', 'hidden').setLabel(_("Z-Offset (mm)"), _("This value will be added to the Z coordinate of every line in the output G-Code to compensate for a badly calibrate Z height endstop."))
549 setting('steps_per_e', '0', float, 'machine', 'hidden').setLabel(_("E-Steps per 1mm filament"), _("Amount of steps per mm filament extrusion. If set to 0 then this value is ignored and the value in your firmware is used."))
550 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
551 setting('serial_port_auto', '', str, 'machine', 'hidden')
552 setting('serial_baud', 'AUTO', str, 'machine', 'hidden').setLabel(_("Baudrate"), _("Speed of the serial port communication\nNeeds to match your firmware settings\nCommon values are 250000, 115200, 57600"))
553 setting('serial_baud_auto', '', int, 'machine', 'hidden')
554
555 setting('toolhead', 'Default', str, 'machine', 'hidden').setLabel(_("Installed Tool Head"), _("Which tool head is currently installed. This setting is only used by LulzBot machines."))
556 setting('toolhead_shortname', '', str, 'machine', 'hidden')
557 setting('extruder_head_size_min_x', '0.0', float, 'machine', 'hidden').setLabel(_("Head size towards X min (mm)"), _("The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head."))
558 setting('extruder_head_size_min_y', '0.0', float, 'machine', 'hidden').setLabel(_("Head size towards Y min (mm)"), _("The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head."))
559 setting('extruder_head_size_max_x', '0.0', float, 'machine', 'hidden').setLabel(_("Head size towards X max (mm)"), _("The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head."))
560 setting('extruder_head_size_max_y', '0.0', float, 'machine', 'hidden').setLabel(_("Head size towards Y max (mm)"), _("The head size when printing multiple objects, measured from the tip of the nozzle towards the outer part of the head."))
561 setting('extruder_head_size_height', '0.0', float, 'machine', 'hidden').setLabel(_("Printer gantry height (mm)"), _("The height of the gantry holding up the printer head. If an object is higher then this then you cannot print multiple objects one for one."))
562
563 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
564 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
565 validators.warningAbove(settingsDictionary['layer_height'], lambda : (float(getProfileSetting('nozzle_size')) * 80.0 / 100.0), _("Thicker layers then %.2fmm (80%% nozzle size) usually give bad results and are not recommended."))
566 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
567 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
568 validators.printSpeedValidator(settingsDictionary['print_speed'])
569 validators.printSpeedValidator(settingsDictionary['bottom_layer_speed'])
570 validators.printSpeedValidator(settingsDictionary['infill_speed'])
571 validators.printSpeedValidator(settingsDictionary['solidarea_speed'])
572 validators.printSpeedValidator(settingsDictionary['inset0_speed'])
573 validators.printSpeedValidator(settingsDictionary['insetx_speed'])
574 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
575 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
576 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
577 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
578 validators.warningAbove(settingsDictionary['print_temperature5'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
579 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
580 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
581 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
582 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
583 validators.warningAbove(settingsDictionary['filament_diameter5'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
584 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
585 validators.warningAbove(settingsDictionary['bottom_thickness'], lambda : (float(getProfileSetting('nozzle_size')) * 3.0 / 4.0), _("A bottom layer of more then %.2fmm (3/4 nozzle size) usually give bad results and is not recommended."))
586
587 #Conditions for multiple extruders
588 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
589 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
590 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
591 settingsDictionary['print_temperature5'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 4)
592 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
593 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
594 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
595 settingsDictionary['filament_diameter5'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 4)
596 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
597 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
598 settingsDictionary['wipe_tower'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
599 settingsDictionary['wipe_tower_volume'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
600 settingsDictionary['ooze_shield'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
601 #Heated bed
602 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
603
604 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
605 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
606 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
607 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
608 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
609 settingsDictionary['print_temperature5'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
610 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
611 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
612 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
613 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
614 settingsDictionary['filament_diameter5'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
615 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
616 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
617 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
618 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
619 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
620
621 #Remove fake defined _() because later the localization will define a global _()
622 del _
623
624 #########################################################
625 ## Profile and preferences functions
626 #########################################################
627
628 def getSubCategoriesFor(category):
629         done = {}
630         ret = []
631         for s in settingsList:
632                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
633                         done[s.getSubCategory()] = True
634                         ret.append(s.getSubCategory())
635         return ret
636
637 def getSettingsForCategory(category, subCategory = None):
638         ret = []
639         for s in settingsList:
640                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
641                         ret.append(s)
642         return ret
643
644 ## Profile functions
645 def getBasePath():
646         """
647         :return: The path in which the current configuration files are stored. This depends on the used OS.
648         """
649         if platform.system() == "Windows":
650                 basePath = os.path.normpath(os.path.expanduser('~/.cura/%s' % version.getVersion(False)))
651         elif platform.system() == "Darwin":
652                 basePath = os.path.expanduser('~/Library/Application Support/Cura/%s' % version.getVersion(False))
653         else:
654                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
655         if not os.path.isdir(basePath):
656                 try:
657                         os.makedirs(basePath)
658                 except:
659                         print "Failed to create directory: %s" % (basePath)
660         return basePath
661
662 def getAlternativeBasePaths():
663         """
664         Search for alternative installations of Cura and their preference files. Used to load configuration from older versions of Cura.
665         """
666         paths = []
667         try:
668                 basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
669                 for subPath in os.listdir(basePath):
670                         path = os.path.join(basePath, subPath)
671                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
672                                 paths.append(path)
673                         path = os.path.join(basePath, subPath, 'Cura')
674                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
675                                 paths.append(path)
676                 paths.sort()
677
678                 if sys.platform.startswith('win'):
679                         extra_list = []
680                         #Check the old base path, which was in the application directory.
681                         basePath = "C:\\program files (x86)\\"
682                         for subPath in os.listdir(basePath):
683                                 path = os.path.join(basePath, subPath)
684                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
685                                         extra_list.append(path)
686                                 path = os.path.join(basePath, subPath, 'Cura')
687                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
688                                         extra_list.append(path)
689                         basePath = "C:\\program files\\"
690                         for subPath in os.listdir(basePath):
691                                 path = os.path.join(basePath, subPath)
692                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
693                                         extra_list.append(path)
694                                 path = os.path.join(basePath, subPath, 'Cura')
695                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
696                                         extra_list.append(path)
697                         extra_list.sort()
698                         paths = extra_list + paths
699         except:
700                 import traceback
701                 print traceback.print_exc()
702
703         return paths
704
705 def getDefaultProfilePath():
706         """
707         :return: The default path where the currently used profile is stored and loaded on open and close of Cura.
708         """
709         return os.path.join(getBasePath(), 'current_profile.ini')
710
711 def loadProfile(filename, allMachines = False):
712         """
713                 Read a profile file as active profile settings.
714         :param filename:    The ini filename to save the profile in.
715         :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
716         """
717         global settingsList
718         profileParser = ConfigParser.ConfigParser()
719         try:
720                 profileParser.read(filename)
721         except ConfigParser.ParsingError:
722                 return
723         if allMachines:
724                 n = 0
725                 while profileParser.has_section('profile_%d' % (n)):
726                         for set in settingsList:
727                                 if set.isPreference():
728                                         continue
729                                 section = 'profile_%d' % (n)
730                                 if set.isAlteration():
731                                         section = 'alterations_%d' % (n)
732                                 if profileParser.has_option(section, set.getName()):
733                                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'), n)
734                         n += 1
735         else:
736                 for set in settingsList:
737                         if set.isPreference():
738                                 continue
739                         section = 'profile'
740                         if set.isAlteration():
741                                 section = 'alterations'
742                         setting_name = set.getName()
743                         if profileParser.has_option(section, setting_name):
744                                 try:
745                                         setting = profileParser.get(section, setting_name)
746                                         if setting == "Invalid Value":
747                                                 raise Exception
748                                         set.setValue(unicode(setting, 'utf-8', 'replace'))
749                                         pass
750                                 except:
751                                         set.setValue(set.getDefault())
752
753 def saveProfile(filename, allMachines = False):
754         """
755                 Save the current profile to an ini file.
756         :param filename:    The ini filename to save the profile in.
757         :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
758         """
759         global settingsList
760         profileParser = ConfigParser.ConfigParser()
761         if allMachines:
762                 for set in settingsList:
763                         if set.isPreference() or set.isMachineSetting():
764                                 continue
765                         for n in xrange(0, getMachineCount()):
766                                 if set.isAlteration():
767                                         section = 'alterations_%d' % (n)
768                                 else:
769                                         section = 'profile_%d' % (n)
770                                 if not profileParser.has_section(section):
771                                         profileParser.add_section(section)
772                                 profileParser.set(section, set.getName(), set.getValue(n).encode('utf-8'))
773         else:
774                 profileParser.add_section('profile')
775                 profileParser.add_section('alterations')
776                 for set in settingsList:
777                         if set.isPreference() or set.isMachineSetting():
778                                 continue
779                         if set.isAlteration():
780                                 profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
781                         else:
782                                 profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
783
784         try:
785                 profileParser.write(open(filename, 'w'))
786         except:
787                 print "Failed to write profile file: %s" % (filename)
788
789 def saveProfileDifferenceFromDefault(filename):
790         """
791                 Save the current profile to an ini file. Only save the profile settings that differ from the default settings.
792         :param filename:    The ini filename to save the profile in.
793         """
794         global settingsList
795         profileParser = ConfigParser.ConfigParser()
796         profileParser.add_section('profile')
797         for set in settingsList:
798                 if set.isPreference() or set.isMachineSetting() or set.isAlteration():
799                         continue
800                 if set.getDefault() == set.getValue():
801                         continue
802                 profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
803         try:
804                 profileParser.write(open(filename, 'w'))
805         except:
806                 print "Failed to write profile file: %s" % (filename)
807
808 def resetProfile():
809         """ Reset the profile for the current machine to default. """
810         global settingsList
811         for set in settingsList:
812                 if not set.isProfile():
813                         continue
814                 set.setValue(set.getDefault())
815
816         if getMachineSetting('machine_type') == 'ultimaker':
817                 putProfileSetting('nozzle_size', '0.4')
818                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
819                         putProfileSetting('retraction_enable', 'True')
820         elif getMachineSetting('machine_type') == 'ultimaker_plus':
821                 putProfileSetting('nozzle_size', '0.4')
822                 putProfileSetting('retraction_enable', 'True')
823         elif getMachineSetting('machine_type').startswith('ultimaker2'):
824                 putProfileSetting('nozzle_size', '0.4')
825                 putProfileSetting('retraction_enable', 'True')
826         else:
827                 putProfileSetting('nozzle_size', '0.5')
828                 putProfileSetting('retraction_enable', 'True')
829
830 def setProfileFromString(options):
831         """
832         Parse an encoded string which has all the profile settings stored inside of it.
833         Used in combination with getProfileString to ease sharing of profiles.
834         """
835         options = base64.b64decode(options)
836         options = zlib.decompress(options)
837         (profileOpts, alt) = options.split('\f', 1)
838         global settingsDictionary
839         for option in profileOpts.split('\b'):
840                 if len(option) > 0:
841                         (key, value) = option.split('=', 1)
842                         if key in settingsDictionary:
843                                 if settingsDictionary[key].isProfile():
844                                         settingsDictionary[key].setValue(value)
845         for option in alt.split('\b'):
846                 if len(option) > 0:
847                         (key, value) = option.split('=', 1)
848                         if key in settingsDictionary:
849                                 if settingsDictionary[key].isAlteration():
850                                         settingsDictionary[key].setValue(value)
851
852 def getProfileString():
853         """
854         Get an encoded string which contains all profile settings.
855         Used in combination with setProfileFromString to share settings in files, forums or other text based ways.
856         """
857         p = []
858         alt = []
859         global settingsList
860         for set in settingsList:
861                 if set.isProfile():
862                         if set.getName() in tempOverride:
863                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
864                         else:
865                                 p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
866                 elif set.isAlteration():
867                         if set.getName() in tempOverride:
868                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
869                         else:
870                                 alt.append(set.getName() + "=" + set.getValue().encode('utf-8'))
871         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
872         ret = base64.b64encode(zlib.compress(ret, 9))
873         return ret
874
875 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
876         lines = []
877         for i in xrange(0, len(string), every):
878                 lines.append(string[i:i+every])
879         return '\n'.join(lines)
880
881 def getPreferencesString():
882         """
883         :return: An encoded string which contains all the current preferences.
884         """
885         p = []
886         global settingsList
887         for set in settingsList:
888                 if (set.isPreference() and set.getName() != 'lastFile' and set.getName() != 'youmagine_token') or set.isMachineSetting():
889                         p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
890         ret = '\b'.join(p)
891         ret = base64.b64encode(zlib.compress(ret, 9))
892         return ret
893
894
895 def getProfileSetting(name):
896         """
897                 Get the value of an profile setting.
898         :param name: Name of the setting to retrieve.
899         :return:     Value of the current setting.
900         """
901         if name in tempOverride:
902                 return tempOverride[name]
903         global settingsDictionary
904         if name in settingsDictionary and settingsDictionary[name].isProfile():
905                 return settingsDictionary[name].getValue()
906         traceback.print_stack()
907         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
908         return ''
909
910 def getProfileSettingFloat(name):
911         try:
912                 setting = getProfileSetting(name).replace(',', '.')
913                 return float(eval(setting, {}, {}))
914         except:
915                 return 0.0
916
917 def putProfileSetting(name, value):
918         """ Store a certain value in a profile setting. """
919         global settingsDictionary
920         if name in settingsDictionary and settingsDictionary[name].isProfile():
921                 settingsDictionary[name].setValue(value)
922
923 def isProfileSetting(name):
924         """ Check if a certain key name is actually a profile value. """
925         global settingsDictionary
926         if name in settingsDictionary and settingsDictionary[name].isProfile():
927                 return True
928         return False
929
930 def isAlterationSetting(name):
931         """ Check if a certain key name is actually a profile value. """
932         global settingsDictionary
933         if name in settingsDictionary and settingsDictionary[name].isAlteration():
934                 return True
935         return False
936
937 ## Preferences functions
938 def getPreferencePath():
939         """
940         :return: The full path of the preference ini file.
941         """
942         return os.path.join(getBasePath(), 'preferences.ini')
943
944 def getPreferenceFloat(name):
945         """
946         Get the float value of a preference, returns 0.0 if the preference is not a invalid float
947         """
948         try:
949                 setting = getPreference(name).replace(',', '.')
950                 return float(eval(setting, {}, {}))
951         except:
952                 return 0.0
953
954 def getPreferenceColour(name):
955         """
956         Get a preference setting value as a color array. The color is stored as #RRGGBB hex string in the setting.
957         """
958         colorString = getPreference(name)
959         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
960
961 def loadPreferences(filename):
962         """
963         Read a configuration file as global config
964         """
965         global settingsList
966         profileParser = ConfigParser.ConfigParser()
967         try:
968                 profileParser.read(filename)
969         except ConfigParser.ParsingError:
970                 return
971
972         for set in settingsList:
973                 if set.isPreference():
974                         if profileParser.has_option('preference', set.getName()):
975                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
976
977         n = 0
978         while profileParser.has_section('machine_%d' % (n)):
979                 for set in settingsList:
980                         if set.isMachineSetting():
981                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
982                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
983                 n += 1
984
985         setActiveMachine(int(getPreferenceFloat('active_machine')))
986
987 def loadMachineSettings(filename):
988         global settingsList
989         #Read a configuration file as global config
990         profileParser = ConfigParser.ConfigParser()
991         try:
992                 profileParser.read(filename)
993         except ConfigParser.ParsingError:
994                 return
995
996         for set in settingsList:
997                 if set.isMachineSetting():
998                         if profileParser.has_option('machine', set.getName()):
999                                 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
1000         checkAndUpdateMachineName()
1001
1002 def savePreferences(filename):
1003         global settingsList
1004         #Save the current profile to an ini file
1005         parser = ConfigParser.ConfigParser()
1006         parser.add_section('preference')
1007
1008         for set in settingsList:
1009                 if set.isPreference():
1010                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
1011
1012         n = 0
1013         while getMachineSetting('machine_name', n) != '':
1014                 parser.add_section('machine_%d' % (n))
1015                 for set in settingsList:
1016                         if set.isMachineSetting():
1017                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
1018                 n += 1
1019         try:
1020                 parser.write(open(filename, 'w'))
1021         except:
1022                 print "Failed to write preferences file: %s" % (filename)
1023
1024 def getPreference(name):
1025         if name in tempOverride:
1026                 return tempOverride[name]
1027         global settingsDictionary
1028         if name in settingsDictionary and settingsDictionary[name].isPreference():
1029                 return settingsDictionary[name].getValue()
1030         traceback.print_stack()
1031         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
1032         return ''
1033
1034 def putPreference(name, value):
1035         #Check if we have a configuration file loaded, else load the default.
1036         global settingsDictionary
1037         if name in settingsDictionary and settingsDictionary[name].isPreference():
1038                 settingsDictionary[name].setValue(value)
1039                 savePreferences(getPreferencePath())
1040                 return
1041         traceback.print_stack()
1042         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
1043
1044 def isPreference(name):
1045         global settingsDictionary
1046         if name in settingsDictionary and settingsDictionary[name].isPreference():
1047                 return True
1048         return False
1049
1050 def getMachineSettingFloat(name, index = None):
1051         try:
1052                 setting = getMachineSetting(name, index).replace(',', '.')
1053                 return float(eval(setting, {}, {}))
1054         except:
1055                 return 0.0
1056
1057 def getMachineSetting(name, index = None):
1058         if name in tempOverride:
1059                 return tempOverride[name]
1060         global settingsDictionary
1061         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
1062                 return settingsDictionary[name].getValue(index)
1063         traceback.print_stack()
1064         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
1065         return ''
1066
1067 def putMachineSetting(name, value, index = None):
1068         #Check if we have a configuration file loaded, else load the default.
1069         global settingsDictionary
1070         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
1071                 settingsDictionary[name].setValue(value, index)
1072         savePreferences(getPreferencePath())
1073
1074 def isMachineSetting(name):
1075         global settingsDictionary
1076         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
1077                 return True
1078         return False
1079
1080 def checkAndUpdateMachineName():
1081         global _selectedMachineIndex
1082         name = getMachineSetting('machine_name')
1083         index = None
1084         if name == '':
1085                 name = getMachineSetting('machine_type')
1086         for n in xrange(0, getMachineCount()):
1087                 if n == _selectedMachineIndex:
1088                         continue
1089                 if index is None:
1090                         if name == getMachineSetting('machine_name', n):
1091                                 index = 1
1092                 else:
1093                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
1094                                 index += 1
1095         if index is not None:
1096                 name = '%s (%d)' % (name, index)
1097         putMachineSetting('machine_name', name)
1098         putPreference('active_machine', _selectedMachineIndex)
1099
1100 def getMachineCount():
1101         n = 0
1102         while getMachineSetting('machine_name', n) != '':
1103                 n += 1
1104         if n < 1:
1105                 return 1
1106         return n
1107
1108 def getMachineName(index = None):
1109         name = getMachineSetting('machine_name', index)
1110         type = getMachineSetting('machine_type', index)
1111         if type.startswith('lulzbot_'):
1112                 toolhead = getMachineSetting('toolhead_shortname', index)
1113                 if toolhead != '':
1114                         return "%s (%s)" % (name, toolhead)
1115         return name
1116
1117 def setActiveMachine(index):
1118         global _selectedMachineIndex
1119         _selectedMachineIndex = index
1120         putPreference('active_machine', _selectedMachineIndex)
1121
1122 def removeMachine(index):
1123         global _selectedMachineIndex
1124         global settingsList
1125         if getMachineCount() < 2:
1126                 return
1127         for n in xrange(index, getMachineCount()):
1128                 for setting in settingsList:
1129                         if setting.isMachineSetting():
1130                                 setting.setValue(setting.getValue(n+1), n)
1131
1132         if _selectedMachineIndex >= index:
1133                 setActiveMachine(getMachineCount() - 1)
1134
1135 ## Temp overrides for multi-extruder slicing and the project planner.
1136 tempOverride = {}
1137 def setTempOverride(name, value):
1138         tempOverride[name] = unicode(value).encode("utf-8")
1139 def clearTempOverride(name):
1140         del tempOverride[name]
1141 def resetTempOverride():
1142         tempOverride.clear()
1143
1144 #########################################################
1145 ## Utility functions to calculate common profile values
1146 #########################################################
1147 def calculateEdgeWidth():
1148         wallThickness = getProfileSettingFloat('wall_thickness')
1149         nozzleSize = getProfileSettingFloat('nozzle_size')
1150
1151         if getProfileSetting('spiralize') == 'True' or getProfileSetting('simple_mode') == 'True':
1152                 return wallThickness
1153
1154         if wallThickness < 0.01:
1155                 return nozzleSize
1156         if wallThickness < nozzleSize:
1157                 return wallThickness
1158
1159         lineCount = int(wallThickness / (nozzleSize - 0.0001))
1160         if lineCount == 0:
1161                 return nozzleSize
1162         lineWidth = wallThickness / lineCount
1163         lineWidthAlt = wallThickness / (lineCount + 1)
1164         if lineWidth > nozzleSize * 1.5:
1165                 return lineWidthAlt
1166         return lineWidth
1167
1168 def calculateLineCount():
1169         wallThickness = getProfileSettingFloat('wall_thickness')
1170         nozzleSize = getProfileSettingFloat('nozzle_size')
1171
1172         if wallThickness < 0.01:
1173                 return 0
1174         if wallThickness < nozzleSize:
1175                 return 1
1176         if getProfileSetting('spiralize') == 'True' or getProfileSetting('simple_mode') == 'True':
1177                 return 1
1178
1179         lineCount = int(wallThickness / (nozzleSize - 0.0001))
1180         if lineCount < 1:
1181                 lineCount = 1
1182         lineWidth = wallThickness / lineCount
1183         lineWidthAlt = wallThickness / (lineCount + 1)
1184         if lineWidth > nozzleSize * 1.5:
1185                 return lineCount + 1
1186         return lineCount
1187
1188 def calculateSolidLayerCount():
1189         layerHeight = getProfileSettingFloat('layer_height')
1190         solidThickness = getProfileSettingFloat('solid_layer_thickness')
1191         if layerHeight == 0.0:
1192                 return 1
1193         return int(math.ceil((solidThickness - 0.0001) / layerHeight))
1194
1195 def calculateObjectSizeOffsets():
1196         size = 0.0
1197
1198         if getProfileSetting('platform_adhesion') == 'Brim':
1199                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
1200         elif getProfileSetting('platform_adhesion') == 'Raft':
1201                 pass
1202         else:
1203                 if getProfileSettingFloat('skirt_line_count') > 0:
1204                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
1205
1206         #if getProfileSetting('enable_raft') != 'False':
1207         #       size += profile.getProfileSettingFloat('raft_margin') * 2
1208         #if getProfileSetting('support') != 'None':
1209         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
1210         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
1211         return [size, size]
1212
1213 def getMachineCenterCoords():
1214         if getMachineSetting('machine_center_is_zero') == 'True':
1215                 return [0, 0]
1216         elif getMachineSetting('machine_type') == 'lulzbot_mini' or \
1217                  getMachineSetting('machine_type') == 'lulzbot_TAZ_6':
1218                 return [(getMachineSettingFloat('machine_width') / 2) + 2.5,
1219                             (getMachineSettingFloat('machine_width') / 2) + 0.5]
1220         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
1221
1222 #Returns a list of convex polygons, first polygon is the allowed area of the machine,
1223 # the rest of the polygons are the dis-allowed areas of the machine.
1224 def getMachineSizePolygons():
1225         size = numpy.array([getMachineSettingFloat('machine_width'), getMachineSettingFloat('machine_depth'), getMachineSettingFloat('machine_height')], numpy.float32)
1226         ret = []
1227         if getMachineSetting('machine_shape') == 'Circular':
1228                 # Circle platform for delta printers...
1229                 circle = []
1230                 steps = 32
1231                 for n in xrange(0, steps):
1232                         circle.append([math.cos(float(n)/steps*2*math.pi) * size[0]/2, math.sin(float(n)/steps*2*math.pi) * size[1]/2])
1233                 ret.append(numpy.array(circle, numpy.float32))
1234         else:
1235                 ret.append(numpy.array([[-size[0]/2,-size[1]/2],[size[0]/2,-size[1]/2],[size[0]/2, size[1]/2], [-size[0]/2, size[1]/2]], numpy.float32))
1236
1237         if getMachineSetting('machine_type').startswith('ultimaker2'):
1238                 #UM2 no-go zones
1239                 w = 25
1240                 w2 = 5
1241                 h = 8
1242                 if getMachineSetting('machine_type') == 'ultimaker2go':
1243                         w2 = 25
1244                 ret.append(numpy.array([[-size[0]/2,-size[1]/2],[-size[0]/2+w+2,-size[1]/2], [-size[0]/2+w,-size[1]/2+h], [-size[0]/2,-size[1]/2+h]], numpy.float32))
1245                 ret.append(numpy.array([[ size[0]/2-w2-2,-size[1]/2],[ size[0]/2,-size[1]/2], [ size[0]/2,-size[1]/2+h],[ size[0]/2-w2,-size[1]/2+h]], numpy.float32))
1246                 ret.append(numpy.array([[-size[0]/2+w+2, size[1]/2],[-size[0]/2, size[1]/2], [-size[0]/2, size[1]/2-h],[-size[0]/2+w, size[1]/2-h]], numpy.float32))
1247                 ret.append(numpy.array([[ size[0]/2, size[1]/2],[ size[0]/2-w2-2, size[1]/2], [ size[0]/2-w2, size[1]/2-h],[ size[0]/2, size[1]/2-h]], numpy.float32))
1248         return ret
1249
1250 #returns the number of extruders minimal used. Normally this returns 1, but with dual-extrusion support material it returns 2
1251 def minimalExtruderCount():
1252         if int(getMachineSetting('extruder_amount')) < 2:
1253                 return 1
1254         if getProfileSetting('support') == 'None':
1255                 return 1
1256         if getProfileSetting('support_dual_extrusion') == 'Second extruder':
1257                 return 2
1258         return 1
1259
1260 def getGCodeExtension():
1261         if getMachineSetting('gcode_flavor') == 'BFB':
1262                 return '.bfb'
1263         if getMachineSetting('gcode_flavor') == 'Mach3/LinuxCNC':
1264                 return '.ngc'
1265         return '.gcode'
1266
1267 #########################################################
1268 ## Alteration file functions
1269 #########################################################
1270 def replaceTagMatch(m):
1271         pre = m.group(1)
1272         tag = m.group(2)
1273         if tag == 'time':
1274                 return pre + time.strftime('%H:%M:%S')
1275         if tag == 'date':
1276                 return pre + time.strftime('%d-%m-%Y')
1277         if tag == 'day':
1278                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
1279         if tag == 'print_time':
1280                 return pre + '#P_TIME#'
1281         if tag == 'filament_amount':
1282                 return pre + '#F_AMNT#'
1283         if tag == 'filament_weight':
1284                 return pre + '#F_WGHT#'
1285         if tag == 'filament_cost':
1286                 return pre + '#F_COST#'
1287         if tag == 'profile_string':
1288                 return pre + 'CURA_PROFILE_STRING:%s' % (getProfileString())
1289         if pre == 'F' and tag == 'max_z_speed':
1290                 f = getProfileSettingFloat('travel_speed') * 60
1291         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
1292                 f = getProfileSettingFloat(tag) * 60
1293         elif isProfileSetting(tag):
1294                 f = getProfileSettingFloat(tag)
1295         elif isPreference(tag):
1296                 f = getProfileSettingFloat(tag)
1297         else:
1298                 return '%s?%s?' % (pre, tag)
1299         if (f % 1) == 0:
1300                 return pre + str(int(f))
1301         return pre + str(f)
1302
1303 ### Get aleration raw contents. (Used internally in Cura)
1304 def getAlterationFile(filename):
1305         if filename in tempOverride:
1306                 return tempOverride[filename]
1307         global settingsDictionary
1308         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
1309                 return settingsDictionary[filename].getValue()
1310         traceback.print_stack()
1311         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
1312         return ''
1313
1314 def setAlterationFile(name, value):
1315         #Check if we have a configuration file loaded, else load the default.
1316         global settingsDictionary
1317         if name in settingsDictionary and settingsDictionary[name].isAlteration():
1318                 settingsDictionary[name].setValue(value)
1319         saveProfile(getDefaultProfilePath(), True)
1320
1321 def isTagIn(tag, contents):
1322         contents = re.sub(';[^\n]*\n', '', contents)
1323         return tag in contents
1324
1325 ### Get the alteration file for output. (Used by Skeinforge)
1326 def getAlterationFileContents(filename, extruderCount = 1):
1327         prefix = ''
1328         postfix = ''
1329         alterationContents = getAlterationFile(filename)
1330         if getMachineSetting('gcode_flavor') == 'UltiGCode':
1331                 if filename == 'end.gcode':
1332                         return 'M25 ;Stop reading from this point on.\n;CURA_PROFILE_STRING:%s\n' % (getProfileString())
1333                 return ''
1334         if filename == 'start.gcode':
1335                 gcode_parameter_key = 'S'
1336                 if getMachineSetting('gcode_flavor') == 'Mach3/LinuxCNC':
1337                         gcode_parameter_key = 'P'
1338                 if extruderCount > 1:
1339                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
1340                 #For the start code, hack the temperature and the steps per E value into it. So the temperature is reached before the start code extrusion.
1341                 #We also set our steps per E here, if configured.
1342                 eSteps = getMachineSettingFloat('steps_per_e')
1343                 if eSteps > 0:
1344                         prefix += 'M92 E%f\n' % (eSteps)
1345                 temp = getProfileSettingFloat('print_temperature')
1346                 bedTemp = 0
1347                 if getMachineSetting('has_heated_bed') == 'True':
1348                         bedTemp = getProfileSettingFloat('print_bed_temperature')
1349
1350                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1351                         prefix += 'M190 %s%f\n' % (gcode_parameter_key, bedTemp)
1352                 if temp > 0 and not isTagIn('{print_temperature}', alterationContents):
1353                         if extruderCount > 1:
1354                                 for n in xrange(1, extruderCount):
1355                                         t = temp
1356                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1357                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1358                                         prefix += 'M104 T%d %s%f\n' % (n, gcode_parameter_key, t)
1359                                 for n in xrange(0, extruderCount):
1360                                         t = temp
1361                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1362                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1363                                         prefix += 'M109 T%d %s%f\n' % (n, gcode_parameter_key, t)
1364                                 prefix += 'T0\n'
1365                         else:
1366                                 prefix += 'M109 %s%f\n' % (gcode_parameter_key, temp)
1367         elif filename == 'end.gcode':
1368                 if extruderCount > 1:
1369                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
1370                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
1371                 #postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
1372         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
1373
1374 def hasEmptyHeadSizeSettings(n):
1375         return getMachineSetting('extruder_head_size_min_x', n) == '0.0' and \
1376            getMachineSetting('extruder_head_size_max_x', n) == '0.0' and \
1377            getMachineSetting('extruder_head_size_min_y', n) == '0.0' and \
1378            getMachineSetting('extruder_head_size_max_y', n) == '0.0' and \
1379            getMachineSetting('extruder_head_size_height', n) == '0.0'
1380
1381 def performVersionUpgrade():
1382         for n in xrange(0, getMachineCount()):
1383                 # This is a hack around an issue where the machine type in the wizard
1384                 # changed and causes some people to have it set to lulzbot_TAZ and some
1385                 # people have it set to lulzbot_TAZ_4.
1386                 if getMachineSetting('machine_type', n) == 'lulzbot_TAZ':
1387                         putMachineSetting('machine_type', 'lulzbot_TAZ_4', n)
1388
1389                 machine_type = getMachineSetting('machine_type', n)
1390                 isLulzBot = machine_type.startswith('lulzbot_')
1391                 if isLulzBot and getMachineSetting('toolhead', n) == 'Default':
1392                         if machine_type == 'lulzbot_mini':
1393                                 putMachineSetting('toolhead', 'Single Extruder V2', n)
1394                                 putMachineSetting('toolhead_shortname', '', n)
1395                         elif machine_type == 'lulzbot_TAZ_4':
1396                                 putMachineSetting('toolhead', 'Single Extruder V1', n)
1397                                 putMachineSetting('toolhead_shortname', '', n)
1398                                 putMachineSetting('machine_type', 'lulzbot_TAZ_4_SingleV1', n)
1399                         elif machine_type == 'lulzbot_TAZ_5':
1400                                 putMachineSetting('toolhead', 'Single Extruder V2 (0.35mm nozzle)', n)
1401                                 putMachineSetting('toolhead_shortname', '0.35 nozzle', n)
1402                                 putMachineSetting('machine_type', 'lulzbot_TAZ_5_035nozzle', n)
1403                                 machine_name = getMachineSetting('machine_name', n)
1404                                 if machine_name.endswith(" (0.35 nozzle)"):
1405                                         putMachineSetting('machine_name', machine_name.replace(" (0.35 nozzle)", ""), n)
1406                         elif machine_type == 'lulzbot_TAZ_5_05nozzle':
1407                                 putMachineSetting('toolhead', 'Single Extruder V2 (0.5mm nozzle)', n)
1408                                 putMachineSetting('toolhead_shortname', '0.5 nozzle', n)
1409                                 putMachineSetting('machine_type', 'lulzbot_TAZ_5_05nozzle', n)
1410                                 machine_name = getMachineSetting('machine_name', n)
1411                                 if machine_name.endswith(" (0.5 nozzle)"):
1412                                         putMachineSetting('machine_name', machine_name.replace(" (0.5 nozzle)", ""), n)
1413
1414                 # Change TAZ print bed so prints are centered when scaled to the max
1415                 if machine_type.startswith('lulzbot_TAZ_') and \
1416                         getMachineSetting('machine_width', n) == '298':
1417                         putMachineSetting('machine_width', '290', n)
1418                         
1419                 #Set valid extruder head size numbers for Mini
1420                 if machine_type == 'lulzbot_mini' and hasEmptyHeadSizeSettings(n):
1421                         putMachineSetting('extruder_head_size_min_x', '40', n)
1422                         putMachineSetting('extruder_head_size_max_x', '75', n)
1423                         putMachineSetting('extruder_head_size_min_y', '25', n)
1424                         putMachineSetting('extruder_head_size_max_y', '55', n)
1425                         putMachineSetting('extruder_head_size_height', '17', n)