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