chiark / gitweb /
Merge tag '15.02.1' into upstream
[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('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."))
184 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."))
185 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."))
186 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."))
187 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."))
188 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."))
189 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."))
190 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."))
191 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."))
192 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)"))
193 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."))
194 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."))
195 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."))
196 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."))
197 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."))
198 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."))
199 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."))
200 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."))
201 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."))
202 setting('filament_flow',            100., float, 'basic',    _('Filament')).setRange(5,300).setLabel(_("Flow (%)"), _("Flow compensation, the amount of material extruded is multiplied by this value"))
203 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."))
204 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."))
205 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."))
206 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."))
207 setting('retraction_combing',      'All',  [_('Off'),_('All'),_('No Skin')], 'expert', _('Retraction')).setLabel(_("Enable combing"), _("Combing is the act of avoiding holes in the print for the head to travel over. If combing is \'Off\' the printer head moves straight from the start point to the end point and it will always retract.  If \'All\', enable combing on all surfaces.  If \'No Skin\', enable combing on all except skin surfaces."))
208 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."))
209 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."))
210 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."))
211 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."))
212 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."))
213 #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."))
214 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."))
215 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."))
216 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."))
217 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."))
218 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."))
219 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."))
220 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."))
221 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."))
222 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."))
223
224 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."))
225 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."))
226 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."))
227 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."))
228 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."))
229 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%."))
230 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."))
231 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."))
232 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."))
233 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."))
234 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."))
235 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."))
236 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. With 90 degree being horizontal and 0 degree being vertical."))
237 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."))
238 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."))
239 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."))
240 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."))
241 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."))
242 #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."))
243 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."))
244 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."))
245 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."))
246 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."))
247 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."))
248 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."))
249 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."))
250 setting('raft_airgap_all', 0.0, float, 'expert', _('Raft')).setRange(0).setLabel(_("Airgap"), _("Gap between the last layer of the raft the whole print."))
251 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."))
252 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."))
253 setting('raft_surface_thickness', 0.27, float, 'expert', _('Raft')).setRange(0).setLabel(_("Surface layer thickness (mm)"), _("Thickness of each surface layer."))
254 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."))
255 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."))
256 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."))
257 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."))
258 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."))
259
260 setting('plugin_config', '', str, 'hidden', 'hidden')
261 setting('object_center_x', -1, float, 'hidden', 'hidden')
262 setting('object_center_y', -1, float, 'hidden', 'hidden')
263
264 setting('simpleModeSettings', '', str, 'hidden', 'hidden')
265
266 setting('start.gcode', """;Sliced at: {day} {date} {time}
267 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
268 ;Print time: {print_time}
269 ;Filament used: {filament_amount}m {filament_weight}g
270 ;Filament cost: {filament_cost}
271 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
272 ;M109 S{print_temperature} ;Uncomment to add your own temperature line
273 G21        ;metric values
274 G90        ;absolute positioning
275 M82        ;set extruder to absolute mode
276 M107       ;start with the fan off
277
278 G28 X0 Y0  ;move X/Y to min endstops
279 G28 Z0     ;move Z to min endstops
280
281 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
282
283 G92 E0                  ;zero the extruded length
284 G1 F200 E3              ;extrude 3mm of feed stock
285 G92 E0                  ;zero the extruded length again
286 G1 F{travel_speed}
287 ;Put printing message on LCD screen
288 M117 Printing...
289 """, str, 'alteration', 'alteration')
290 #######################################################################################
291 setting('end.gcode', """;End GCode
292 M104 S0                     ;extruder heater off
293 M140 S0                     ;heated bed heater off (if you have it)
294
295 G91                                    ;relative positioning
296 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
297 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
298 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
299
300 M84                         ;steppers off
301 G90                         ;absolute positioning
302 ;{profile_string}
303 """, str, 'alteration', 'alteration')
304 #######################################################################################
305 setting('start2.gcode', """;Sliced at: {day} {date} {time}
306 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
307 ;Print time: {print_time}
308 ;Filament used: {filament_amount}m {filament_weight}g
309 ;Filament cost: {filament_cost}
310 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
311 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
312 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
313 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
314 G21        ;metric values
315 G90        ;absolute positioning
316 M107       ;start with the fan off
317
318 G28 X0 Y0  ;move X/Y to min endstops
319 G28 Z0     ;move Z to min endstops
320
321 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
322
323 T1                      ;Switch to the 2nd extruder
324 G92 E0                  ;zero the extruded length
325 G1 F200 E10             ;extrude 10mm of feed stock
326 G92 E0                  ;zero the extruded length again
327 G1 F200 E-{retraction_dual_amount}
328
329 T0                      ;Switch to the first extruder
330 G92 E0                  ;zero the extruded length
331 G1 F200 E10             ;extrude 10mm of feed stock
332 G92 E0                  ;zero the extruded length again
333 G1 F{travel_speed}
334 ;Put printing message on LCD screen
335 M117 Printing...
336 """, str, 'alteration', 'alteration')
337 #######################################################################################
338 setting('end2.gcode', """;End GCode
339 M104 T0 S0                     ;extruder heater off
340 M104 T1 S0                     ;extruder heater off
341 M140 S0                     ;heated bed heater off (if you have it)
342
343 G91                                    ;relative positioning
344 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
345 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
346 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
347
348 M84                         ;steppers off
349 G90                         ;absolute positioning
350 ;{profile_string}
351 """, str, 'alteration', 'alteration')
352 #######################################################################################
353 setting('start3.gcode', """;Sliced at: {day} {date} {time}
354 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
355 ;Print time: {print_time}
356 ;Filament used: {filament_amount}m {filament_weight}g
357 ;Filament cost: {filament_cost}
358 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
359 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
360 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
361 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
362 G21        ;metric values
363 G90        ;absolute positioning
364 M107       ;start with the fan off
365
366 G28 X0 Y0  ;move X/Y to min endstops
367 G28 Z0     ;move Z to min endstops
368
369 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
370
371 T2                      ;Switch to the 2nd extruder
372 G92 E0                  ;zero the extruded length
373 G1 F200 E10             ;extrude 10mm of feed stock
374 G92 E0                  ;zero the extruded length again
375 G1 F200 E-{retraction_dual_amount}
376
377 T1                      ;Switch to the 2nd extruder
378 G92 E0                  ;zero the extruded length
379 G1 F200 E10             ;extrude 10mm of feed stock
380 G92 E0                  ;zero the extruded length again
381 G1 F200 E-{retraction_dual_amount}
382
383 T0                      ;Switch to the first extruder
384 G92 E0                  ;zero the extruded length
385 G1 F200 E10             ;extrude 10mm of feed stock
386 G92 E0                  ;zero the extruded length again
387 G1 F{travel_speed}
388 ;Put printing message on LCD screen
389 M117 Printing...
390 """, str, 'alteration', 'alteration')
391 #######################################################################################
392 setting('end3.gcode', """;End GCode
393 M104 T0 S0                     ;extruder heater off
394 M104 T1 S0                     ;extruder heater off
395 M104 T2 S0                     ;extruder heater off
396 M140 S0                     ;heated bed heater off (if you have it)
397
398 G91                                    ;relative positioning
399 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
400 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
401 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
402
403 M84                         ;steppers off
404 G90                         ;absolute positioning
405 ;{profile_string}
406 """, str, 'alteration', 'alteration')
407 setting('start4.gcode', """;Sliced at: {day} {date} {time}
408 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
409 ;Print time: {print_time}
410 ;Filament used: {filament_amount}m {filament_weight}g
411 ;Filament cost: {filament_cost}
412 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
413 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
414 ;M109 T2 S{print_temperature2} ;Uncomment to add your own temperature line
415 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
416 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
417 G21        ;metric values
418 G90        ;absolute positioning
419 M107       ;start with the fan off
420
421 G28 X0 Y0  ;move X/Y to min endstops
422 G28 Z0     ;move Z to min endstops
423
424 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
425
426 T3                      ;Switch to the 4th extruder
427 G92 E0                  ;zero the extruded length
428 G1 F200 E10             ;extrude 10mm of feed stock
429 G92 E0                  ;zero the extruded length again
430 G1 F200 E-{retraction_dual_amount}
431
432 T2                      ;Switch to the 3th extruder
433 G92 E0                  ;zero the extruded length
434 G1 F200 E10             ;extrude 10mm of feed stock
435 G92 E0                  ;zero the extruded length again
436 G1 F200 E-{retraction_dual_amount}
437
438 T1                      ;Switch to the 2nd extruder
439 G92 E0                  ;zero the extruded length
440 G1 F200 E10             ;extrude 10mm of feed stock
441 G92 E0                  ;zero the extruded length again
442 G1 F200 E-{retraction_dual_amount}
443
444 T0                      ;Switch to the first extruder
445 G92 E0                  ;zero the extruded length
446 G1 F200 E10             ;extrude 10mm of feed stock
447 G92 E0                  ;zero the extruded length again
448 G1 F{travel_speed}
449 ;Put printing message on LCD screen
450 M117 Printing...
451 """, str, 'alteration', 'alteration')
452 #######################################################################################
453 setting('end4.gcode', """;End GCode
454 M104 T0 S0                     ;extruder heater off
455 M104 T1 S0                     ;extruder heater off
456 M104 T2 S0                     ;extruder heater off
457 M104 T3 S0                     ;extruder heater off
458 M140 S0                     ;heated bed heater off (if you have it)
459
460 G91                                    ;relative positioning
461 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
462 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
463 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
464
465 M84                         ;steppers off
466 G90                         ;absolute positioning
467 ;{profile_string}
468 """, str, 'alteration', 'alteration')
469 #######################################################################################
470 setting('support_start.gcode', '', str, 'alteration', 'alteration')
471 setting('support_end.gcode', '', str, 'alteration', 'alteration')
472 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
473 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
474 setting('replace.csv', '', str, 'alteration', 'alteration')
475 #######################################################################################
476 setting('preSwitchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
477 ;This code is added before the T(n)
478 """, str, 'alteration', 'alteration')
479 setting('postSwitchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
480 ;This code is added after the T(n)
481 """, str, 'alteration', 'alteration')
482
483 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
484 setting('simpleModeProfile', '2_normal', str, 'preference', 'hidden')
485 setting('simpleModeMaterial', '1_pla', str, 'preference', 'hidden')
486 setting('oneAtATime', 'True', bool, 'preference', 'hidden')
487 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'Rocktopus.stl')), str, 'preference', 'hidden')
488 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."))
489 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."))
490 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."))
491 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."))
492
493 def _getMyDocumentsFolder():
494         if platform.system() == "Windows":
495                 path = os.path.expanduser('~/Documents')
496         else:
497                 path = os.path.expanduser('~/')
498         if not os.path.exists(path):
499                 path = ''
500         try:
501                 path = unicode(path)
502         except UnicodeDecodeError:
503                 path = ''
504         return path
505
506 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."))
507 setting('check_for_updates', 'False', bool, 'preference', 'hidden').setLabel(_("Check for updates"), _("Check for newer versions of Cura on startup"))
508 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel(_("Send usage statistics"), _("Submit anonymous usage information to improve future versions of Cura"))
509 setting('youmagine_token', '', str, 'preference', 'hidden')
510 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."))
511 setting('language', 'Autodetect', str, 'preference', 'hidden').setLabel(_('Language'), _('Change the language in which Cura runs. Switching language requires a restart of Cura'))
512 setting('active_machine', '0', int, 'preference', 'hidden')
513
514 setting('model_colour', '#C9E240', str, 'preference', 'hidden').setLabel(_('Model colour'), _('Display color for first extruder'))
515 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel(_('Model colour (2)'), _('Display color for second extruder'))
516 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel(_('Model colour (3)'), _('Display color for third extruder'))
517 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel(_('Model colour (4)'), _('Display color for forth extruder'))
518 setting('printing_window', 'Pronterface UI', ['Basic'], 'preference', 'hidden').setLabel(_('Printing window type'), _('Select the interface used for USB printing.'))
519
520 setting('window_maximized', 'True', bool, 'preference', 'hidden')
521 setting('window_pos_x', '-1', float, 'preference', 'hidden')
522 setting('window_pos_y', '-1', float, 'preference', 'hidden')
523 setting('window_width', '-1', float, 'preference', 'hidden')
524 setting('window_height', '-1', float, 'preference', 'hidden')
525 setting('window_normal_sash', '320', float, 'preference', 'hidden')
526 setting('last_run_version', '', str, 'preference', 'hidden')
527
528 setting('machine_name', '', str, 'machine', 'hidden')
529 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
530 setting('machine_width', '205', float, 'machine', 'hidden').setLabel(_("Maximum width (mm)"), _("Maximum width of the machine print area in mm"))
531 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Maximum depth of the machine print area in mm"))
532 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Maximum height of the machine print area in mm"))
533 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."))
534 setting('machine_shape', 'Square', ['Square','Circular'], 'machine', 'hidden').setLabel(_("Build area shape"), _("The shape of machine build area."))
535 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
536 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel(_("Heated bed"), _("If you have a heated bed, this enabled heated bed settings (requires restart)"))
537 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."))
538 setting('extruder_amount', '1', ['1','2','3','4','5'], 'machine', 'hidden').setLabel(_("Extruder count"), _("Amount of extruders in your machine."))
539 setting('extruder_offset_x1', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your secondary extruder compared to the primary."))
540 setting('extruder_offset_y1', '21.6', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your secondary extruder compared to the primary."))
541 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your tertiary extruder compared to the primary."))
542 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your tertiary extruder compared to the primary."))
543 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
544 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
545 setting('extruder_offset_x4', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
546 setting('extruder_offset_y4', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
547 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."))
548 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."))
549 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
550 setting('serial_port_auto', '', str, 'machine', 'hidden')
551 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"))
552 setting('serial_baud_auto', '', int, 'machine', 'hidden')
553
554 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."))
555 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."))
556 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."))
557 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."))
558 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."))
559
560 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
561 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
562 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."))
563 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
564 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
565 validators.printSpeedValidator(settingsDictionary['print_speed'])
566 validators.printSpeedValidator(settingsDictionary['bottom_layer_speed'])
567 validators.printSpeedValidator(settingsDictionary['infill_speed'])
568 validators.printSpeedValidator(settingsDictionary['solidarea_speed'])
569 validators.printSpeedValidator(settingsDictionary['inset0_speed'])
570 validators.printSpeedValidator(settingsDictionary['insetx_speed'])
571 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
572 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
573 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
574 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
575 validators.warningAbove(settingsDictionary['print_temperature5'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
576 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
577 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
578 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
579 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
580 validators.warningAbove(settingsDictionary['filament_diameter5'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
581 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
582 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."))
583
584 #Conditions for multiple extruders
585 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
586 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
587 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
588 settingsDictionary['print_temperature5'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 4)
589 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
590 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
591 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
592 settingsDictionary['filament_diameter5'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 4)
593 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
594 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
595 settingsDictionary['wipe_tower'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
596 settingsDictionary['wipe_tower_volume'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
597 settingsDictionary['ooze_shield'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
598 #Heated bed
599 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
600
601 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
602 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
603 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
604 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
605 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
606 settingsDictionary['print_temperature5'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
607 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
608 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
609 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
610 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
611 settingsDictionary['filament_diameter5'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
612 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
613 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
614 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
615 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
616 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
617
618 #Remove fake defined _() because later the localization will define a global _()
619 del _
620
621 #########################################################
622 ## Profile and preferences functions
623 #########################################################
624
625 def getSubCategoriesFor(category):
626         done = {}
627         ret = []
628         for s in settingsList:
629                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
630                         done[s.getSubCategory()] = True
631                         ret.append(s.getSubCategory())
632         return ret
633
634 def getSettingsForCategory(category, subCategory = None):
635         ret = []
636         for s in settingsList:
637                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
638                         ret.append(s)
639         return ret
640
641 ## Profile functions
642 def getBasePath():
643         """
644         :return: The path in which the current configuration files are stored. This depends on the used OS.
645         """
646         if platform.system() == "Windows":
647                 basePath = os.path.normpath(os.path.expanduser('~/.cura/%s' % version.getVersion(False)))
648         elif platform.system() == "Darwin":
649                 basePath = os.path.expanduser('~/Library/Application Support/Cura/%s' % version.getVersion(False))
650         else:
651                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
652         if not os.path.isdir(basePath):
653                 try:
654                         os.makedirs(basePath)
655                 except:
656                         print "Failed to create directory: %s" % (basePath)
657         return basePath
658
659 def getAlternativeBasePaths():
660         """
661         Search for alternative installations of Cura and their preference files. Used to load configuration from older versions of Cura.
662         """
663         paths = []
664         try:
665                 basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
666                 for subPath in os.listdir(basePath):
667                         path = os.path.join(basePath, subPath)
668                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
669                                 paths.append(path)
670                         path = os.path.join(basePath, subPath, 'Cura')
671                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
672                                 paths.append(path)
673                 paths.sort()
674
675                 if sys.platform.startswith('win'):
676                         extra_list = []
677                         #Check the old base path, which was in the application directory.
678                         basePath = "C:\\program files (x86)\\"
679                         for subPath in os.listdir(basePath):
680                                 path = os.path.join(basePath, subPath)
681                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
682                                         extra_list.append(path)
683                                 path = os.path.join(basePath, subPath, 'Cura')
684                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
685                                         extra_list.append(path)
686                         basePath = "C:\\program files\\"
687                         for subPath in os.listdir(basePath):
688                                 path = os.path.join(basePath, subPath)
689                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
690                                         extra_list.append(path)
691                                 path = os.path.join(basePath, subPath, 'Cura')
692                                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')):
693                                         extra_list.append(path)
694                         extra_list.sort()
695                         paths = extra_list + paths
696         except:
697                 import traceback
698                 print traceback.print_exc()
699
700         return paths
701
702 def getDefaultProfilePath():
703         """
704         :return: The default path where the currently used profile is stored and loaded on open and close of Cura.
705         """
706         return os.path.join(getBasePath(), 'current_profile.ini')
707
708 def loadProfile(filename, allMachines = False):
709         """
710                 Read a profile file as active profile settings.
711         :param filename:    The ini filename to save the profile in.
712         :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
713         """
714         global settingsList
715         profileParser = ConfigParser.ConfigParser()
716         try:
717                 profileParser.read(filename)
718         except ConfigParser.ParsingError:
719                 return
720         if allMachines:
721                 n = 0
722                 while profileParser.has_section('profile_%d' % (n)):
723                         for set in settingsList:
724                                 if set.isPreference():
725                                         continue
726                                 section = 'profile_%d' % (n)
727                                 if set.isAlteration():
728                                         section = 'alterations_%d' % (n)
729                                 if profileParser.has_option(section, set.getName()):
730                                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'), n)
731                         n += 1
732         else:
733                 for set in settingsList:
734                         if set.isPreference():
735                                 continue
736                         section = 'profile'
737                         if set.isAlteration():
738                                 section = 'alterations'
739                         if profileParser.has_option(section, set.getName()):
740                                 set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
741         #Upgrade setting from older ini file
742         if getProfileSetting('retraction_combing') == '1':
743                 putProfileSetting('retraction_combing', 'All')
744
745 def saveProfile(filename, allMachines = False):
746         """
747                 Save the current profile to an ini file.
748         :param filename:    The ini filename to save the profile in.
749         :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
750         """
751         global settingsList
752         profileParser = ConfigParser.ConfigParser()
753         if allMachines:
754                 for set in settingsList:
755                         if set.isPreference() or set.isMachineSetting():
756                                 continue
757                         for n in xrange(0, getMachineCount()):
758                                 if set.isAlteration():
759                                         section = 'alterations_%d' % (n)
760                                 else:
761                                         section = 'profile_%d' % (n)
762                                 if not profileParser.has_section(section):
763                                         profileParser.add_section(section)
764                                 profileParser.set(section, set.getName(), set.getValue(n).encode('utf-8'))
765         else:
766                 profileParser.add_section('profile')
767                 profileParser.add_section('alterations')
768                 for set in settingsList:
769                         if set.isPreference() or set.isMachineSetting():
770                                 continue
771                         if set.isAlteration():
772                                 profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
773                         else:
774                                 profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
775
776         try:
777                 profileParser.write(open(filename, 'w'))
778         except:
779                 print "Failed to write profile file: %s" % (filename)
780
781 def saveProfileDifferenceFromDefault(filename):
782         """
783                 Save the current profile to an ini file. Only save the profile settings that differ from the default settings.
784         :param filename:    The ini filename to save the profile in.
785         """
786         global settingsList
787         profileParser = ConfigParser.ConfigParser()
788         profileParser.add_section('profile')
789         for set in settingsList:
790                 if set.isPreference() or set.isMachineSetting() or set.isAlteration():
791                         continue
792                 if set.getDefault() == set.getValue():
793                         continue
794                 profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
795         try:
796                 profileParser.write(open(filename, 'w'))
797         except:
798                 print "Failed to write profile file: %s" % (filename)
799
800 def resetProfile():
801         """ Reset the profile for the current machine to default. """
802         global settingsList
803         for set in settingsList:
804                 if not set.isProfile():
805                         continue
806                 set.setValue(set.getDefault())
807
808         if getMachineSetting('machine_type') == 'ultimaker':
809                 putProfileSetting('nozzle_size', '0.4')
810                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
811                         putProfileSetting('retraction_enable', 'True')
812         elif getMachineSetting('machine_type') == 'ultimaker_plus':
813                 putProfileSetting('nozzle_size', '0.4')
814                 putProfileSetting('retraction_enable', 'True')
815         elif getMachineSetting('machine_type').startswith('ultimaker2'):
816                 putProfileSetting('nozzle_size', '0.4')
817                 putProfileSetting('retraction_enable', 'True')
818         else:
819                 putProfileSetting('nozzle_size', '0.5')
820                 putProfileSetting('retraction_enable', 'True')
821
822 def setProfileFromString(options):
823         """
824         Parse an encoded string which has all the profile settings stored inside of it.
825         Used in combination with getProfileString to ease sharing of profiles.
826         """
827         options = base64.b64decode(options)
828         options = zlib.decompress(options)
829         (profileOpts, alt) = options.split('\f', 1)
830         global settingsDictionary
831         for option in profileOpts.split('\b'):
832                 if len(option) > 0:
833                         (key, value) = option.split('=', 1)
834                         if key in settingsDictionary:
835                                 if settingsDictionary[key].isProfile():
836                                         settingsDictionary[key].setValue(value)
837         for option in alt.split('\b'):
838                 if len(option) > 0:
839                         (key, value) = option.split('=', 1)
840                         if key in settingsDictionary:
841                                 if settingsDictionary[key].isAlteration():
842                                         settingsDictionary[key].setValue(value)
843
844 def getProfileString():
845         """
846         Get an encoded string which contains all profile settings.
847         Used in combination with setProfileFromString to share settings in files, forums or other text based ways.
848         """
849         p = []
850         alt = []
851         global settingsList
852         for set in settingsList:
853                 if set.isProfile():
854                         if set.getName() in tempOverride:
855                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
856                         else:
857                                 p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
858                 elif set.isAlteration():
859                         if set.getName() in tempOverride:
860                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
861                         else:
862                                 alt.append(set.getName() + "=" + set.getValue().encode('utf-8'))
863         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
864         ret = base64.b64encode(zlib.compress(ret, 9))
865         return ret
866
867 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
868         lines = []
869         for i in xrange(0, len(string), every):
870                 lines.append(string[i:i+every])
871         return '\n'.join(lines)
872
873 def getPreferencesString():
874         """
875         :return: An encoded string which contains all the current preferences.
876         """
877         p = []
878         global settingsList
879         for set in settingsList:
880                 if (set.isPreference() and set.getName() != 'lastFile' and set.getName() != 'youmagine_token') or set.isMachineSetting():
881                         p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
882         ret = '\b'.join(p)
883         ret = base64.b64encode(zlib.compress(ret, 9))
884         return ret
885
886
887 def getProfileSetting(name):
888         """
889                 Get the value of an profile setting.
890         :param name: Name of the setting to retrieve.
891         :return:     Value of the current setting.
892         """
893         if name in tempOverride:
894                 return tempOverride[name]
895         global settingsDictionary
896         if name in settingsDictionary and settingsDictionary[name].isProfile():
897                 return settingsDictionary[name].getValue()
898         traceback.print_stack()
899         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
900         return ''
901
902 def getProfileSettingFloat(name):
903         try:
904                 setting = getProfileSetting(name).replace(',', '.')
905                 return float(eval(setting, {}, {}))
906         except:
907                 return 0.0
908
909 def putProfileSetting(name, value):
910         """ Store a certain value in a profile setting. """
911         global settingsDictionary
912         if name in settingsDictionary and settingsDictionary[name].isProfile():
913                 settingsDictionary[name].setValue(value)
914
915 def isProfileSetting(name):
916         """ Check if a certain key name is actually a profile value. """
917         global settingsDictionary
918         if name in settingsDictionary and settingsDictionary[name].isProfile():
919                 return True
920         return False
921
922 ## Preferences functions
923 def getPreferencePath():
924         """
925         :return: The full path of the preference ini file.
926         """
927         return os.path.join(getBasePath(), 'preferences.ini')
928
929 def getPreferenceFloat(name):
930         """
931         Get the float value of a preference, returns 0.0 if the preference is not a invalid float
932         """
933         try:
934                 setting = getPreference(name).replace(',', '.')
935                 return float(eval(setting, {}, {}))
936         except:
937                 return 0.0
938
939 def getPreferenceColour(name):
940         """
941         Get a preference setting value as a color array. The color is stored as #RRGGBB hex string in the setting.
942         """
943         colorString = getPreference(name)
944         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
945
946 def loadPreferences(filename):
947         """
948         Read a configuration file as global config
949         """
950         global settingsList
951         profileParser = ConfigParser.ConfigParser()
952         try:
953                 profileParser.read(filename)
954         except ConfigParser.ParsingError:
955                 return
956
957         for set in settingsList:
958                 if set.isPreference():
959                         if profileParser.has_option('preference', set.getName()):
960                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
961
962         n = 0
963         while profileParser.has_section('machine_%d' % (n)):
964                 for set in settingsList:
965                         if set.isMachineSetting():
966                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
967                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
968                 n += 1
969
970         setActiveMachine(int(getPreferenceFloat('active_machine')))
971
972 def loadMachineSettings(filename):
973         global settingsList
974         #Read a configuration file as global config
975         profileParser = ConfigParser.ConfigParser()
976         try:
977                 profileParser.read(filename)
978         except ConfigParser.ParsingError:
979                 return
980
981         for set in settingsList:
982                 if set.isMachineSetting():
983                         if profileParser.has_option('machine', set.getName()):
984                                 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
985         checkAndUpdateMachineName()
986
987 def savePreferences(filename):
988         global settingsList
989         #Save the current profile to an ini file
990         parser = ConfigParser.ConfigParser()
991         parser.add_section('preference')
992
993         for set in settingsList:
994                 if set.isPreference():
995                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
996
997         n = 0
998         while getMachineSetting('machine_name', n) != '':
999                 parser.add_section('machine_%d' % (n))
1000                 for set in settingsList:
1001                         if set.isMachineSetting():
1002                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
1003                 n += 1
1004         try:
1005                 parser.write(open(filename, 'w'))
1006         except:
1007                 print "Failed to write preferences file: %s" % (filename)
1008
1009 def getPreference(name):
1010         if name in tempOverride:
1011                 return tempOverride[name]
1012         global settingsDictionary
1013         if name in settingsDictionary and settingsDictionary[name].isPreference():
1014                 return settingsDictionary[name].getValue()
1015         traceback.print_stack()
1016         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
1017         return ''
1018
1019 def putPreference(name, value):
1020         #Check if we have a configuration file loaded, else load the default.
1021         global settingsDictionary
1022         if name in settingsDictionary and settingsDictionary[name].isPreference():
1023                 settingsDictionary[name].setValue(value)
1024                 savePreferences(getPreferencePath())
1025                 return
1026         traceback.print_stack()
1027         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
1028
1029 def isPreference(name):
1030         global settingsDictionary
1031         if name in settingsDictionary and settingsDictionary[name].isPreference():
1032                 return True
1033         return False
1034
1035 def getMachineSettingFloat(name, index = None):
1036         try:
1037                 setting = getMachineSetting(name, index).replace(',', '.')
1038                 return float(eval(setting, {}, {}))
1039         except:
1040                 return 0.0
1041
1042 def getMachineSetting(name, index = None):
1043         if name in tempOverride:
1044                 return tempOverride[name]
1045         global settingsDictionary
1046         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
1047                 return settingsDictionary[name].getValue(index)
1048         traceback.print_stack()
1049         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
1050         return ''
1051
1052 def putMachineSetting(name, value, index = None):
1053         #Check if we have a configuration file loaded, else load the default.
1054         global settingsDictionary
1055         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
1056                 settingsDictionary[name].setValue(value, index)
1057         savePreferences(getPreferencePath())
1058
1059 def isMachineSetting(name):
1060         global settingsDictionary
1061         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
1062                 return True
1063         return False
1064
1065 def checkAndUpdateMachineName():
1066         global _selectedMachineIndex
1067         name = getMachineSetting('machine_name')
1068         index = None
1069         if name == '':
1070                 name = getMachineSetting('machine_type')
1071         for n in xrange(0, getMachineCount()):
1072                 if n == _selectedMachineIndex:
1073                         continue
1074                 if index is None:
1075                         if name == getMachineSetting('machine_name', n):
1076                                 index = 1
1077                 else:
1078                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
1079                                 index += 1
1080         if index is not None:
1081                 name = '%s (%d)' % (name, index)
1082         putMachineSetting('machine_name', name)
1083         putPreference('active_machine', _selectedMachineIndex)
1084
1085 def getMachineCount():
1086         n = 0
1087         while getMachineSetting('machine_name', n) != '':
1088                 n += 1
1089         if n < 1:
1090                 return 1
1091         return n
1092
1093 def setActiveMachine(index):
1094         global _selectedMachineIndex
1095         _selectedMachineIndex = index
1096         putPreference('active_machine', _selectedMachineIndex)
1097
1098 def removeMachine(index):
1099         global _selectedMachineIndex
1100         global settingsList
1101         if getMachineCount() < 2:
1102                 return
1103         for n in xrange(index, getMachineCount()):
1104                 for setting in settingsList:
1105                         if setting.isMachineSetting():
1106                                 setting.setValue(setting.getValue(n+1), n)
1107
1108         if _selectedMachineIndex >= index:
1109                 setActiveMachine(getMachineCount() - 1)
1110
1111 ## Temp overrides for multi-extruder slicing and the project planner.
1112 tempOverride = {}
1113 def setTempOverride(name, value):
1114         tempOverride[name] = unicode(value).encode("utf-8")
1115 def clearTempOverride(name):
1116         del tempOverride[name]
1117 def resetTempOverride():
1118         tempOverride.clear()
1119
1120 #########################################################
1121 ## Utility functions to calculate common profile values
1122 #########################################################
1123 def calculateEdgeWidth():
1124         wallThickness = getProfileSettingFloat('wall_thickness')
1125         nozzleSize = getProfileSettingFloat('nozzle_size')
1126
1127         if getProfileSetting('spiralize') == 'True' or getProfileSetting('simple_mode') == 'True':
1128                 return wallThickness
1129
1130         if wallThickness < 0.01:
1131                 return nozzleSize
1132         if wallThickness < nozzleSize:
1133                 return wallThickness
1134
1135         lineCount = int(wallThickness / (nozzleSize - 0.0001))
1136         if lineCount == 0:
1137                 return nozzleSize
1138         lineWidth = wallThickness / lineCount
1139         lineWidthAlt = wallThickness / (lineCount + 1)
1140         if lineWidth > nozzleSize * 1.5:
1141                 return lineWidthAlt
1142         return lineWidth
1143
1144 def calculateLineCount():
1145         wallThickness = getProfileSettingFloat('wall_thickness')
1146         nozzleSize = getProfileSettingFloat('nozzle_size')
1147
1148         if wallThickness < 0.01:
1149                 return 0
1150         if wallThickness < nozzleSize:
1151                 return 1
1152         if getProfileSetting('spiralize') == 'True' or getProfileSetting('simple_mode') == 'True':
1153                 return 1
1154
1155         lineCount = int(wallThickness / (nozzleSize - 0.0001))
1156         if lineCount < 1:
1157                 lineCount = 1
1158         lineWidth = wallThickness / lineCount
1159         lineWidthAlt = wallThickness / (lineCount + 1)
1160         if lineWidth > nozzleSize * 1.5:
1161                 return lineCount + 1
1162         return lineCount
1163
1164 def calculateSolidLayerCount():
1165         layerHeight = getProfileSettingFloat('layer_height')
1166         solidThickness = getProfileSettingFloat('solid_layer_thickness')
1167         if layerHeight == 0.0:
1168                 return 1
1169         return int(math.ceil((solidThickness - 0.0001) / layerHeight))
1170
1171 def calculateObjectSizeOffsets():
1172         size = 0.0
1173
1174         if getProfileSetting('platform_adhesion') == 'Brim':
1175                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
1176         elif getProfileSetting('platform_adhesion') == 'Raft':
1177                 pass
1178         else:
1179                 if getProfileSettingFloat('skirt_line_count') > 0:
1180                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
1181
1182         #if getProfileSetting('enable_raft') != 'False':
1183         #       size += profile.getProfileSettingFloat('raft_margin') * 2
1184         #if getProfileSetting('support') != 'None':
1185         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
1186         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
1187         return [size, size]
1188
1189 def getMachineCenterCoords():
1190         if getMachineSetting('machine_center_is_zero') == 'True':
1191                 return [0, 0]
1192         elif getMachineSetting('machine_type') == 'lulzbot_mini':
1193                 return [(getMachineSettingFloat('machine_width') / 2) + 2.5, (getMachineSettingFloat('machine_width') / 2) + 0.5]
1194         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
1195
1196 #Returns a list of convex polygons, first polygon is the allowed area of the machine,
1197 # the rest of the polygons are the dis-allowed areas of the machine.
1198 def getMachineSizePolygons():
1199         size = numpy.array([getMachineSettingFloat('machine_width'), getMachineSettingFloat('machine_depth'), getMachineSettingFloat('machine_height')], numpy.float32)
1200         ret = []
1201         if getMachineSetting('machine_shape') == 'Circular':
1202                 # Circle platform for delta printers...
1203                 circle = []
1204                 steps = 32
1205                 for n in xrange(0, steps):
1206                         circle.append([math.cos(float(n)/steps*2*math.pi) * size[0]/2, math.sin(float(n)/steps*2*math.pi) * size[1]/2])
1207                 ret.append(numpy.array(circle, numpy.float32))
1208         else:
1209                 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))
1210
1211         if getMachineSetting('machine_type').startswith('ultimaker2'):
1212                 #UM2 no-go zones
1213                 w = 25
1214                 w2 = 5
1215                 h = 8
1216                 if getMachineSetting('machine_type') == 'ultimaker2go':
1217                         w2 = 25
1218                 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))
1219                 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))
1220                 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))
1221                 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))
1222         return ret
1223
1224 #returns the number of extruders minimal used. Normally this returns 1, but with dual-extrusion support material it returns 2
1225 def minimalExtruderCount():
1226         if int(getMachineSetting('extruder_amount')) < 2:
1227                 return 1
1228         if getProfileSetting('support') == 'None':
1229                 return 1
1230         if getProfileSetting('support_dual_extrusion') == 'Second extruder':
1231                 return 2
1232         return 1
1233
1234 def getGCodeExtension():
1235         if getMachineSetting('gcode_flavor') == 'BFB':
1236                 return '.bfb'
1237         if getMachineSetting('gcode_flavor') == 'Mach3/LinuxCNC':
1238                 return '.ngc'
1239         return '.gcode'
1240
1241 #########################################################
1242 ## Alteration file functions
1243 #########################################################
1244 def replaceTagMatch(m):
1245         pre = m.group(1)
1246         tag = m.group(2)
1247         if tag == 'time':
1248                 return pre + time.strftime('%H:%M:%S')
1249         if tag == 'date':
1250                 return pre + time.strftime('%d-%m-%Y')
1251         if tag == 'day':
1252                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
1253         if tag == 'print_time':
1254                 return pre + '#P_TIME#'
1255         if tag == 'filament_amount':
1256                 return pre + '#F_AMNT#'
1257         if tag == 'filament_weight':
1258                 return pre + '#F_WGHT#'
1259         if tag == 'filament_cost':
1260                 return pre + '#F_COST#'
1261         if tag == 'profile_string':
1262                 return pre + 'CURA_PROFILE_STRING:%s' % (getProfileString())
1263         if pre == 'F' and tag == 'max_z_speed':
1264                 f = getProfileSettingFloat('travel_speed') * 60
1265         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
1266                 f = getProfileSettingFloat(tag) * 60
1267         elif isProfileSetting(tag):
1268                 f = getProfileSettingFloat(tag)
1269         elif isPreference(tag):
1270                 f = getProfileSettingFloat(tag)
1271         else:
1272                 return '%s?%s?' % (pre, tag)
1273         if (f % 1) == 0:
1274                 return pre + str(int(f))
1275         return pre + str(f)
1276
1277 ### Get aleration raw contents. (Used internally in Cura)
1278 def getAlterationFile(filename):
1279         if filename in tempOverride:
1280                 return tempOverride[filename]
1281         global settingsDictionary
1282         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
1283                 return settingsDictionary[filename].getValue()
1284         traceback.print_stack()
1285         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
1286         return ''
1287
1288 def setAlterationFile(name, value):
1289         #Check if we have a configuration file loaded, else load the default.
1290         global settingsDictionary
1291         if name in settingsDictionary and settingsDictionary[name].isAlteration():
1292                 settingsDictionary[name].setValue(value)
1293         saveProfile(getDefaultProfilePath(), True)
1294
1295 def isTagIn(tag, contents):
1296         contents = re.sub(';[^\n]*\n', '', contents)
1297         return tag in contents
1298
1299 ### Get the alteration file for output. (Used by Skeinforge)
1300 def getAlterationFileContents(filename, extruderCount = 1):
1301         prefix = ''
1302         postfix = ''
1303         alterationContents = getAlterationFile(filename)
1304         if getMachineSetting('gcode_flavor') == 'UltiGCode':
1305                 if filename == 'end.gcode':
1306                         return 'M25 ;Stop reading from this point on.\n;CURA_PROFILE_STRING:%s\n' % (getProfileString())
1307                 return ''
1308         if filename == 'start.gcode':
1309                 gcode_parameter_key = 'S'
1310                 if getMachineSetting('gcode_flavor') == 'Mach3/LinuxCNC':
1311                         gcode_parameter_key = 'P'
1312                 if extruderCount > 1:
1313                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
1314                 #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.
1315                 #We also set our steps per E here, if configured.
1316                 eSteps = getMachineSettingFloat('steps_per_e')
1317                 if eSteps > 0:
1318                         prefix += 'M92 E%f\n' % (eSteps)
1319                 temp = getProfileSettingFloat('print_temperature')
1320                 bedTemp = 0
1321                 if getMachineSetting('has_heated_bed') == 'True':
1322                         bedTemp = getProfileSettingFloat('print_bed_temperature')
1323
1324                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1325                         prefix += 'M190 %s%f\n' % (gcode_parameter_key, bedTemp)
1326                 if temp > 0 and not isTagIn('{print_temperature}', alterationContents):
1327                         if extruderCount > 1:
1328                                 for n in xrange(1, extruderCount):
1329                                         t = temp
1330                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1331                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1332                                         prefix += 'M104 T%d %s%f\n' % (n, gcode_parameter_key, t)
1333                                 for n in xrange(0, extruderCount):
1334                                         t = temp
1335                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1336                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1337                                         prefix += 'M109 T%d %s%f\n' % (n, gcode_parameter_key, t)
1338                                 prefix += 'T0\n'
1339                         else:
1340                                 prefix += 'M109 %s%f\n' % (gcode_parameter_key, temp)
1341         elif filename == 'end.gcode':
1342                 if extruderCount > 1:
1343                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
1344                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
1345                 #postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
1346         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'