chiark / gitweb /
Set the new minimal-extrusion-before-retraction default.
[cura.git] / Cura / util / profile.py
1 from __future__ import absolute_import
2 from __future__ import division
3 __copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
4
5 import os, traceback, math, re, zlib, base64, time, sys, platform, glob, string, stat, types
6 import cPickle as pickle
7 import numpy
8 if sys.version_info[0] < 3:
9         import ConfigParser
10 else:
11         import configparser as ConfigParser
12
13 from Cura.util import resources
14 from Cura.util import version
15 from Cura.util import validators
16
17 #The settings dictionary contains a key/value reference to all possible settings. With the setting name as key.
18 settingsDictionary = {}
19 #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,
20 # as the dictionary will not contain insertion order.
21 settingsList = []
22
23 #Currently selected machine (by index) Cura support multiple machines in the same preferences and can switch between them.
24 # Each machine has it's own index and unique name.
25 _selectedMachineIndex = 0
26
27 class setting(object):
28         #A setting object contains a configuration setting. These are globally accessible trough the quick access functions
29         # and trough the settingsDictionary function.
30         # Settings can be:
31         # * profile settings (settings that effect the slicing process and the print result)
32         # * preferences (settings that effect how cura works and acts)
33         # * machine settings (settings that relate to the physical configuration of your machine)
34         # * alterations (bad name copied from Skeinforge. These are the start/end code pieces)
35         # Settings have validators that check if the value is valid, but do not prevent invalid values!
36         # Settings have conditions that enable/disable this setting depending on other settings. (Ex: Dual-extrusion)
37         def __init__(self, name, default, type, category, subcategory):
38                 self._name = name
39                 self._label = name
40                 self._tooltip = ''
41                 self._default = unicode(default)
42                 self._values = []
43                 self._type = type
44                 self._category = category
45                 self._subcategory = subcategory
46                 self._validators = []
47                 self._conditions = []
48
49                 if type is types.FloatType:
50                         validators.validFloat(self)
51                 elif type is types.IntType:
52                         validators.validInt(self)
53
54                 global settingsDictionary
55                 settingsDictionary[name] = self
56                 global settingsList
57                 settingsList.append(self)
58
59         def setLabel(self, label, tooltip = ''):
60                 self._label = label
61                 self._tooltip = tooltip
62                 return self
63
64         def setRange(self, minValue=None, maxValue=None):
65                 if len(self._validators) < 1:
66                         return
67                 self._validators[0].minValue = minValue
68                 self._validators[0].maxValue = maxValue
69                 return self
70
71         def getLabel(self):
72                 return _(self._label)
73
74         def getTooltip(self):
75                 return _(self._tooltip)
76
77         def getCategory(self):
78                 return self._category
79
80         def getSubCategory(self):
81                 return self._subcategory
82
83         def isPreference(self):
84                 return self._category == 'preference'
85
86         def isMachineSetting(self):
87                 return self._category == 'machine'
88
89         def isAlteration(self):
90                 return self._category == 'alteration'
91
92         def isProfile(self):
93                 return not self.isAlteration() and not self.isPreference() and not self.isMachineSetting()
94
95         def getName(self):
96                 return self._name
97
98         def getType(self):
99                 return self._type
100
101         def getValue(self, index = None):
102                 if index is None:
103                         index = self.getValueIndex()
104                 if index >= len(self._values):
105                         return self._default
106                 return self._values[index]
107
108         def getDefault(self):
109                 return self._default
110
111         def setValue(self, value, index = None):
112                 if index is None:
113                         index = self.getValueIndex()
114                 while index >= len(self._values):
115                         self._values.append(self._default)
116                 self._values[index] = unicode(value)
117
118         def getValueIndex(self):
119                 if self.isMachineSetting():
120                         global _selectedMachineIndex
121                         return _selectedMachineIndex
122                 return 0
123
124         def validate(self):
125                 result = validators.SUCCESS
126                 msgs = []
127                 for validator in self._validators:
128                         res, err = validator.validate()
129                         if res == validators.ERROR:
130                                 result = res
131                         elif res == validators.WARNING and result != validators.ERROR:
132                                 result = res
133                         if res != validators.SUCCESS:
134                                 msgs.append(err)
135                 return result, '\n'.join(msgs)
136
137         def addCondition(self, conditionFunction):
138                 self._conditions.append(conditionFunction)
139
140         def checkConditions(self):
141                 for condition in self._conditions:
142                         if not condition():
143                                 return False
144                 return True
145
146 #########################################################
147 ## Settings
148 #########################################################
149
150 #Define a fake _() function to fake the gettext tools in to generating strings for the profile settings.
151 def _(n):
152         return n
153
154 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."))
155 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."))
156 setting('retraction_enable',       False, bool,  'basic',    _('Quality')).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."))
157 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."))
158 setting('fill_density',               20, float, 'basic',    _('Fill')).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."))
159 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."))
160 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."))
161 setting('print_temperature',         220, 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."))
162 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."))
163 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."))
164 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."))
165 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."))
166 setting('support',                'None', [_('None'), _('Touching buildplate'), _('Everywhere')], 'basic', _('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."))
167 setting('platform_adhesion',      'None', [_('None'), _('Brim'), _('Raft')], 'basic', _('Support')).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 the recommended option.\nRaft adds a thick raster at below the object and a thin interface between this and your object.\n(Note that enabling the brim or raft disables the skirt)"))
168 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."))
169 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."))
170 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."))
171 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."))
172 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."))
173 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."))
174 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."))
175 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."))
176 setting('filament_flow',            100., float, 'basic',    _('Filament')).setRange(5,300).setLabel(_("Flow (%)"), _("Flow compensation, the amount of material extruded is multiplied by this value"))
177 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."))
178 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."))
179 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."))
180 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."))
181 setting('retraction_combing',       True, bool,  'expert',   _('Retraction')).setLabel(_("Enable combing"), _("Combing is the act of avoiding holes in the print for the head to travel over. If combing is disabled the printer head moves straight from the start point to the end point and it will always retract."))
182 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 retraction a lot on the same piece of filament which flattens the filament and causes grinding issues."))
183 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."))
184 setting('object_sink',               0.0, float, 'advanced', _('Quality')).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."))
185 #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."))
186 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 better together."))
187 setting('travel_speed',            150.0, float, 'advanced', _('Speed')).setRange(0.1).setLabel(_("Travel speed (mm/s)"), _("Speed at which travel moves are done, a high quality build Ultimaker can reach speeds of 250mm/s. But some machines might miss steps then."))
188 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."))
189 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, but this can negatively effect print quality.."))
190 setting('cool_min_layer_time',         5, float, 'advanced', _('Cool')).setRange(0).setLabel(_("Minimal layer time (sec)"), _("Minimum time spend 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 spend at least this amount of seconds printing this layer."))
191 setting('fan_enabled',              True, bool,  'advanced', _('Cool')).setLabel(_("Enable cooling fan"), _("Enable the cooling fan during the print. The extra cooling from the cooling fan is essential during faster prints."))
192
193 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."))
194 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."))
195 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."))
196 #setting('max_z_speed',               3.0, float, 'expert',   _('Speed')).setRange(0.1).setLabel(_("Max Z speed (mm/s)"), _("Speed at which Z moves are done. When you Z axis is properly lubricated you can increase this for less Z blob."))
197 #setting('retract_on_jumps_only',    True, bool,  'expert',   _('Retraction')).setLabel(_('Retract on jumps only'), _('Only retract when we are making a move that is over a hole in the model, else retract on every move. This effects print quality in different ways.'))
198 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 linear with the fan off at layer 0."))
199 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."))
200 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%."))
201 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 slown down it will never be slower than this minimal speed."))
202 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."))
203 #setting('extra_base_wall_thickness', 0.0, float, 'expert',   'Accuracy').setRange(0).setLabel(_("Extra Wall thickness for bottom/top (mm)"), _("Additional wall thickness of the bottom and top layers."))
204 #setting('sequence', 'Loops > Perimeter > Infill', ['Loops > Perimeter > Infill', 'Loops > Infill > Perimeter', 'Infill > Loops > Perimeter', 'Infill > Perimeter > Loops', 'Perimeter > Infill > Loops', 'Perimeter > Loops > Infill'], 'expert', 'Sequence')
205 #setting('force_first_layer_sequence', True, bool, 'expert', 'Sequence').setLabel(_('Force first layer sequence'), _('This setting forces the order of the first layer to be \'Perimeter > Loops > Infill\''))
206 #setting('infill_type', 'Line', ['Line', 'Grid Circular', 'Grid Hexagonal', 'Grid Rectangular'], 'expert', _('Infill')).setLabel(_("Infill pattern"), _("Pattern of the none-solid infill. Line is default, but grids can provide a strong print."))
207 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."))
208 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."))
209 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."))
210 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."))
211 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."))
212 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."))
213 setting('spiralize', False, bool, 'expert', 'Spiralize').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."))
214 #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."))
215 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."))
216 setting('raft_margin', 5, 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 are for your print."))
217 setting('raft_line_spacing', 1.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."))
218 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."))
219 setting('raft_base_linewidth', 0.7, 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."))
220 setting('raft_interface_thickness', 0.2, 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."))
221 setting('raft_interface_linewidth', 0.2, 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."))
222 #setting('hop_on_move', False, bool, 'expert', 'Hop').setLabel(_("Enable hop on move"), _("When moving from print position to print position, raise the printer head 0.2mm so it does not knock off the print (experimental)."))
223 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 depended 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."))
224 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 depended 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."))
225 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 it 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."))
226 setting('fix_horrible_extensive_stitching', False, bool, 'expert', _('Fix horrible')).setLabel(_("Extensive stitching"), _("Extrensive 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."))
227
228 setting('plugin_config', '', str, 'hidden', 'hidden')
229 setting('object_center_x', -1, float, 'hidden', 'hidden')
230 setting('object_center_y', -1, float, 'hidden', 'hidden')
231
232 setting('start.gcode', """;Sliced at: {day} {date} {time}
233 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
234 ;Print time: {print_time}
235 ;Filament used: {filament_amount}m {filament_weight}g
236 ;Filament cost: {filament_cost}
237 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
238 ;M109 S{print_temperature} ;Uncomment to add your own temperature line
239 G21        ;metric values
240 G90        ;absolute positioning
241 M107       ;start with the fan off
242
243 G28 X0 Y0  ;move X/Y to min endstops
244 G28 Z0     ;move Z to min endstops
245
246 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
247
248 G92 E0                  ;zero the extruded length
249 G1 F200 E3              ;extrude 3mm of feed stock
250 G92 E0                  ;zero the extruded length again
251 G1 F{travel_speed}
252 ;Put printing message on LCD screen
253 M117 Printing...
254 """, str, 'alteration', 'alteration')
255 #######################################################################################
256 setting('end.gcode', """;End GCode
257 M104 S0                     ;extruder heater off
258 M140 S0                     ;heated bed heater off (if you have it)
259
260 G91                                    ;relative positioning
261 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
262 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
263 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
264
265 M84                         ;steppers off
266 G90                         ;absolute positioning
267 """, str, 'alteration', 'alteration')
268 #######################################################################################
269 setting('start2.gcode', """;Sliced at: {day} {date} {time}
270 ;Basic settings: Layer height: {layer_height} Walls: {wall_thickness} Fill: {fill_density}
271 ;Print time: {print_time}
272 ;Filament used: {filament_amount}m {filament_weight}g
273 ;Filament cost: {filament_cost}
274 ;M190 S{print_bed_temperature} ;Uncomment to add your own bed temperature line
275 ;M104 S{print_temperature} ;Uncomment to add your own temperature line
276 ;M109 T1 S{print_temperature2} ;Uncomment to add your own temperature line
277 ;M109 T0 S{print_temperature} ;Uncomment to add your own temperature line
278 G21        ;metric values
279 G90        ;absolute positioning
280 M107       ;start with the fan off
281
282 G28 X0 Y0  ;move X/Y to min endstops
283 G28 Z0     ;move Z to min endstops
284
285 G1 Z15.0 F{travel_speed} ;move the platform down 15mm
286
287 T1                      ;Switch to the 2nd extruder
288 G92 E0                  ;zero the extruded length
289 G1 F200 E10             ;extrude 10mm of feed stock
290 G92 E0                  ;zero the extruded length again
291 G1 F200 E-{retraction_dual_amount}
292
293 T0                      ;Switch to the first extruder
294 G92 E0                  ;zero the extruded length
295 G1 F200 E10             ;extrude 10mm of feed stock
296 G92 E0                  ;zero the extruded length again
297 G1 F{travel_speed}
298 ;Put printing message on LCD screen
299 M117 Printing...
300 """, str, 'alteration', 'alteration')
301 #######################################################################################
302 setting('end2.gcode', """;End GCode
303 M104 T0 S0                     ;extruder heater off
304 M104 T1 S0                     ;extruder heater off
305 M140 S0                     ;heated bed heater off (if you have it)
306
307 G91                                    ;relative positioning
308 G1 E-1 F300                            ;retract the filament a bit before lifting the nozzle, to release some of the pressure
309 G1 Z+0.5 E-5 X-20 Y-20 F{travel_speed} ;move Z up a bit and retract filament even more
310 G28 X0 Y0                              ;move X/Y to min endstops, so the head is out of the way
311
312 M84                         ;steppers off
313 G90                         ;absolute positioning
314 """, str, 'alteration', 'alteration')
315 #######################################################################################
316 setting('support_start.gcode', '', str, 'alteration', 'alteration')
317 setting('support_end.gcode', '', str, 'alteration', 'alteration')
318 setting('cool_start.gcode', '', str, 'alteration', 'alteration')
319 setting('cool_end.gcode', '', str, 'alteration', 'alteration')
320 setting('replace.csv', '', str, 'alteration', 'alteration')
321 #######################################################################################
322 setting('switchExtruder.gcode', """;Switch between the current extruder and the next extruder, when printing with multiple extruders.
323 G92 E0
324 G1 E-36 F5000
325 G92 E0
326 T{extruder}
327 G1 X{new_x} Y{new_y} Z{new_z} F{travel_speed}
328 G1 E36 F5000
329 G92 E0
330 """, str, 'alteration', 'alteration')
331
332 setting('startMode', 'Simple', ['Simple', 'Normal'], 'preference', 'hidden')
333 setting('lastFile', os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'resources', 'example', 'UltimakerRobot_support.stl')), str, 'preference', 'hidden')
334 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."))
335 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."))
336 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."))
337 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."))
338 setting('check_for_updates', 'True', bool, 'preference', 'hidden').setLabel(_("Check for updates"), _("Check for newer versions of Cura on startup"))
339 setting('submit_slice_information', 'False', bool, 'preference', 'hidden').setLabel(_("Send usage statistics"), _("Submit anonymous usage information to improve next versions of Cura"))
340 setting('youmagine_token', '', str, 'preference', 'hidden')
341 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."))
342 setting('language', 'English', str, 'preference', 'hidden').setLabel(_('Language'), _('Change the language in which Cura runs. Switching language requires a restart of Cura'))
343 setting('active_machine', '0', int, 'preference', 'hidden')
344
345 setting('model_colour', '#FFC924', str, 'preference', 'hidden').setLabel(_('Model colour'))
346 setting('model_colour2', '#CB3030', str, 'preference', 'hidden').setLabel(_('Model colour (2)'))
347 setting('model_colour3', '#DDD93C', str, 'preference', 'hidden').setLabel(_('Model colour (3)'))
348 setting('model_colour4', '#4550D3', str, 'preference', 'hidden').setLabel(_('Model colour (4)'))
349
350 setting('window_maximized', 'True', bool, 'preference', 'hidden')
351 setting('window_pos_x', '-1', float, 'preference', 'hidden')
352 setting('window_pos_y', '-1', float, 'preference', 'hidden')
353 setting('window_width', '-1', float, 'preference', 'hidden')
354 setting('window_height', '-1', float, 'preference', 'hidden')
355 setting('window_normal_sash', '320', float, 'preference', 'hidden')
356 setting('last_run_version', '', str, 'preference', 'hidden')
357
358 setting('machine_name', '', str, 'machine', 'hidden')
359 setting('machine_type', 'unknown', str, 'machine', 'hidden') #Ultimaker, Ultimaker2, RepRap
360 setting('machine_width', '205', float, 'machine', 'hidden').setLabel(_("Maximum width (mm)"), _("Size of the machine in mm"))
361 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Size of the machine in mm"))
362 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Size of the machine in mm"))
363 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."))
364 setting('ultimaker_extruder_upgrade', 'False', bool, 'machine', 'hidden')
365 setting('has_heated_bed', 'False', bool, 'machine', 'hidden').setLabel(_("Heated bed"), _("If you have an heated bed, this enabled heated bed settings (requires restart)"))
366 setting('gcode_flavor', 'RepRap (Marlin/Sprinter)', ['RepRap (Marlin/Sprinter)', 'UltiGCode', 'MakerBot'], '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."))
367 setting('extruder_amount', '1', ['1','2','3','4'], 'machine', 'hidden').setLabel(_("Extruder count"), _("Amount of extruders in your machine."))
368 setting('extruder_offset_x1', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your secondary extruder compared to the primary."))
369 setting('extruder_offset_y1', '-21.6', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your secondary extruder compared to the primary."))
370 setting('extruder_offset_x2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your tertiary extruder compared to the primary."))
371 setting('extruder_offset_y2', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your tertiary extruder compared to the primary."))
372 setting('extruder_offset_x3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset X"), _("The offset of your forth extruder compared to the primary."))
373 setting('extruder_offset_y3', '0.0', float, 'machine', 'hidden').setLabel(_("Offset Y"), _("The offset of your forth extruder compared to the primary."))
374 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."))
375 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
376 setting('serial_port_auto', '', str, 'machine', 'hidden')
377 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"))
378 setting('serial_baud_auto', '', int, 'machine', 'hidden')
379
380 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."))
381 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."))
382 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."))
383 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."))
384 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."))
385
386 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
387 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
388 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."))
389 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
390 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
391 validators.printSpeedValidator(settingsDictionary['print_speed'])
392 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
393 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
394 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
395 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
396 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
397 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
398 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
399 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
400 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
401 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."))
402
403 #Conditions for multiple extruders
404 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
405 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
406 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
407 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
408 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
409 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
410 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
411 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
412 settingsDictionary['wipe_tower'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
413 settingsDictionary['wipe_tower_volume'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
414 settingsDictionary['ooze_shield'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
415 #Heated bed
416 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
417
418 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
419 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
420 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
421 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
422 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
423 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
424 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
425 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
426 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
427 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
428 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
429 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
430 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
431 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
432
433 #Remove fake defined _() because later the localization will define a global _()
434 del _
435
436 #########################################################
437 ## Profile and preferences functions
438 #########################################################
439
440 def getSubCategoriesFor(category):
441         done = {}
442         ret = []
443         for s in settingsList:
444                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
445                         done[s.getSubCategory()] = True
446                         ret.append(s.getSubCategory())
447         return ret
448
449 def getSettingsForCategory(category, subCategory = None):
450         ret = []
451         for s in settingsList:
452                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
453                         ret.append(s)
454         return ret
455
456 ## Profile functions
457 def getBasePath():
458         if platform.system() == "Windows":
459                 basePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
460                 #If we have a frozen python install, we need to step out of the library.zip
461                 if hasattr(sys, 'frozen'):
462                         basePath = os.path.normpath(os.path.join(basePath, ".."))
463         else:
464                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
465         if not os.path.isdir(basePath):
466                 os.makedirs(basePath)
467         return basePath
468
469 def getAlternativeBasePaths():
470         paths = []
471         basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
472         for subPath in os.listdir(basePath):
473                 path = os.path.join(basePath, subPath)
474                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
475                         paths.append(path)
476                 path = os.path.join(basePath, subPath, 'Cura')
477                 if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
478                         paths.append(path)
479         return paths
480
481 def getDefaultProfilePath():
482         return os.path.join(getBasePath(), 'current_profile.ini')
483
484 def loadProfile(filename):
485         #Read a configuration file as global config
486         profileParser = ConfigParser.ConfigParser()
487         try:
488                 profileParser.read(filename)
489         except ConfigParser.ParsingError:
490                 return
491         global settingsList
492         for set in settingsList:
493                 if set.isPreference():
494                         continue
495                 section = 'profile'
496                 if set.isAlteration():
497                         section = 'alterations'
498                 if profileParser.has_option(section, set.getName()):
499                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
500
501 def saveProfile(filename):
502         #Save the current profile to an ini file
503         profileParser = ConfigParser.ConfigParser()
504         profileParser.add_section('profile')
505         profileParser.add_section('alterations')
506         global settingsList
507         for set in settingsList:
508                 if set.isPreference() or set.isMachineSetting():
509                         continue
510                 if set.isAlteration():
511                         profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
512                 else:
513                         profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
514
515         profileParser.write(open(filename, 'w'))
516
517 def resetProfile():
518         #Read a configuration file as global config
519         global settingsList
520         for set in settingsList:
521                 if not set.isProfile():
522                         continue
523                 set.setValue(set.getDefault())
524
525         if getMachineSetting('machine_type') == 'ultimaker':
526                 putProfileSetting('nozzle_size', '0.4')
527                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
528                         putProfileSetting('retraction_enable', 'True')
529         elif getMachineSetting('machine_type') == 'ultimaker2':
530                 putProfileSetting('nozzle_size', '0.4')
531                 putProfileSetting('retraction_enable', 'True')
532         else:
533                 putProfileSetting('nozzle_size', '0.5')
534                 putProfileSetting('retraction_enable', 'True')
535
536 def setProfileFromString(options):
537         options = base64.b64decode(options)
538         options = zlib.decompress(options)
539         (profileOpts, alt) = options.split('\f', 1)
540         global settingsDictionary
541         for option in profileOpts.split('\b'):
542                 if len(option) > 0:
543                         (key, value) = option.split('=', 1)
544                         if key in settingsDictionary:
545                                 if settingsDictionary[key].isProfile():
546                                         settingsDictionary[key].setValue(value)
547         for option in alt.split('\b'):
548                 if len(option) > 0:
549                         (key, value) = option.split('=', 1)
550                         if key in settingsDictionary:
551                                 if settingsDictionary[key].isAlteration():
552                                         settingsDictionary[key].setValue(value)
553
554 def getProfileString():
555         p = []
556         alt = []
557         global settingsList
558         for set in settingsList:
559                 if set.isProfile():
560                         if set.getName() in tempOverride:
561                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
562                         else:
563                                 p.append(set.getName() + "=" + set.getValue())
564                 elif set.isAlteration():
565                         if set.getName() in tempOverride:
566                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
567                         else:
568                                 alt.append(set.getName() + "=" + set.getValue())
569         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
570         ret = base64.b64encode(zlib.compress(ret, 9))
571         return ret
572
573 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
574         lines = []
575         for i in xrange(0, len(string), every):
576                 lines.append(string[i:i+every])
577         return '\n'.join(lines)
578
579 def getPreferencesString():
580         p = []
581         global settingsList
582         for set in settingsList:
583                 if set.isPreference():
584                         p.append(set.getName() + "=" + set.getValue())
585         ret = '\b'.join(p)
586         ret = base64.b64encode(zlib.compress(ret, 9))
587         return ret
588
589
590 def getProfileSetting(name):
591         if name in tempOverride:
592                 return tempOverride[name]
593         global settingsDictionary
594         if name in settingsDictionary and settingsDictionary[name].isProfile():
595                 return settingsDictionary[name].getValue()
596         traceback.print_stack()
597         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
598         return ''
599
600 def getProfileSettingFloat(name):
601         try:
602                 setting = getProfileSetting(name).replace(',', '.')
603                 return float(eval(setting, {}, {}))
604         except:
605                 return 0.0
606
607 def putProfileSetting(name, value):
608         #Check if we have a configuration file loaded, else load the default.
609         global settingsDictionary
610         if name in settingsDictionary and settingsDictionary[name].isProfile():
611                 settingsDictionary[name].setValue(value)
612
613 def isProfileSetting(name):
614         global settingsDictionary
615         if name in settingsDictionary and settingsDictionary[name].isProfile():
616                 return True
617         return False
618
619 ## Preferences functions
620 def getPreferencePath():
621         return os.path.join(getBasePath(), 'preferences.ini')
622
623 def getPreferenceFloat(name):
624         try:
625                 setting = getPreference(name).replace(',', '.')
626                 return float(eval(setting, {}, {}))
627         except:
628                 return 0.0
629
630 def getPreferenceColour(name):
631         colorString = getPreference(name)
632         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
633
634 def loadPreferences(filename):
635         global settingsList
636         #Read a configuration file as global config
637         profileParser = ConfigParser.ConfigParser()
638         try:
639                 profileParser.read(filename)
640         except ConfigParser.ParsingError:
641                 return
642
643         for set in settingsList:
644                 if set.isPreference():
645                         if profileParser.has_option('preference', set.getName()):
646                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
647
648         n = 0
649         while profileParser.has_section('machine_%d' % (n)):
650                 for set in settingsList:
651                         if set.isMachineSetting():
652                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
653                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
654                 n += 1
655
656         setActiveMachine(int(getPreferenceFloat('active_machine')))
657
658 def loadMachineSettings(filename):
659         global settingsList
660         #Read a configuration file as global config
661         profileParser = ConfigParser.ConfigParser()
662         try:
663                 profileParser.read(filename)
664         except ConfigParser.ParsingError:
665                 return
666
667         for set in settingsList:
668                 if set.isMachineSetting():
669                         if profileParser.has_option('machine', set.getName()):
670                                 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
671         checkAndUpdateMachineName()
672
673 def savePreferences(filename):
674         global settingsList
675         #Save the current profile to an ini file
676         parser = ConfigParser.ConfigParser()
677         parser.add_section('preference')
678
679         for set in settingsList:
680                 if set.isPreference():
681                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
682
683         n = 0
684         while getMachineSetting('machine_name', n) != '':
685                 parser.add_section('machine_%d' % (n))
686                 for set in settingsList:
687                         if set.isMachineSetting():
688                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
689                 n += 1
690         parser.write(open(filename, 'w'))
691
692 def getPreference(name):
693         if name in tempOverride:
694                 return tempOverride[name]
695         global settingsDictionary
696         if name in settingsDictionary and settingsDictionary[name].isPreference():
697                 return settingsDictionary[name].getValue()
698         traceback.print_stack()
699         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
700         return ''
701
702 def putPreference(name, value):
703         #Check if we have a configuration file loaded, else load the default.
704         global settingsDictionary
705         if name in settingsDictionary and settingsDictionary[name].isPreference():
706                 settingsDictionary[name].setValue(value)
707                 savePreferences(getPreferencePath())
708                 return
709         traceback.print_stack()
710         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
711
712 def isPreference(name):
713         global settingsDictionary
714         if name in settingsDictionary and settingsDictionary[name].isPreference():
715                 return True
716         return False
717
718 def getMachineSettingFloat(name, index = None):
719         try:
720                 setting = getMachineSetting(name, index).replace(',', '.')
721                 return float(eval(setting, {}, {}))
722         except:
723                 return 0.0
724
725 def getMachineSetting(name, index = None):
726         if name in tempOverride:
727                 return tempOverride[name]
728         global settingsDictionary
729         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
730                 return settingsDictionary[name].getValue(index)
731         traceback.print_stack()
732         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
733         return ''
734
735 def putMachineSetting(name, value):
736         #Check if we have a configuration file loaded, else load the default.
737         global settingsDictionary
738         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
739                 settingsDictionary[name].setValue(value)
740         savePreferences(getPreferencePath())
741
742 def isMachineSetting(name):
743         global settingsDictionary
744         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
745                 return True
746         return False
747
748 def checkAndUpdateMachineName():
749         global _selectedMachineIndex
750         name = getMachineSetting('machine_name')
751         index = None
752         if name == '':
753                 name = getMachineSetting('machine_type')
754         for n in xrange(0, getMachineCount()):
755                 if n == _selectedMachineIndex:
756                         continue
757                 if index is None:
758                         if name == getMachineSetting('machine_name', n):
759                                 index = 1
760                 else:
761                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
762                                 index += 1
763         if index is not None:
764                 name = '%s (%d)' % (name, index)
765         putMachineSetting('machine_name', name)
766         putPreference('active_machine', _selectedMachineIndex)
767
768 def getMachineCount():
769         n = 0
770         while getMachineSetting('machine_name', n) != '':
771                 n += 1
772         if n < 1:
773                 return 1
774         return n
775
776 def setActiveMachine(index):
777         global _selectedMachineIndex
778         _selectedMachineIndex = index
779         putPreference('active_machine', _selectedMachineIndex)
780
781 def removeMachine(index):
782         global _selectedMachineIndex
783         global settingsList
784         if getMachineCount() < 2:
785                 return
786         for n in xrange(index, getMachineCount()):
787                 for setting in settingsList:
788                         if setting.isMachineSetting():
789                                 setting.setValue(setting.getValue(n+1), n)
790
791         if _selectedMachineIndex >= index:
792                 setActiveMachine(getMachineCount() - 1)
793
794 ## Temp overrides for multi-extruder slicing and the project planner.
795 tempOverride = {}
796 def setTempOverride(name, value):
797         tempOverride[name] = unicode(value).encode("utf-8")
798 def clearTempOverride(name):
799         del tempOverride[name]
800 def resetTempOverride():
801         tempOverride.clear()
802
803 #########################################################
804 ## Utility functions to calculate common profile values
805 #########################################################
806 def calculateEdgeWidth():
807         wallThickness = getProfileSettingFloat('wall_thickness')
808         nozzleSize = getProfileSettingFloat('nozzle_size')
809
810         if getProfileSetting('spiralize') == 'True':
811                 return wallThickness
812
813         if wallThickness < 0.01:
814                 return nozzleSize
815         if wallThickness < nozzleSize:
816                 return wallThickness
817
818         lineCount = int(wallThickness / (nozzleSize - 0.0001))
819         if lineCount == 0:
820                 return nozzleSize
821         lineWidth = wallThickness / lineCount
822         lineWidthAlt = wallThickness / (lineCount + 1)
823         if lineWidth > nozzleSize * 1.5:
824                 return lineWidthAlt
825         return lineWidth
826
827 def calculateLineCount():
828         wallThickness = getProfileSettingFloat('wall_thickness')
829         nozzleSize = getProfileSettingFloat('nozzle_size')
830
831         if wallThickness < 0.01:
832                 return 0
833         if wallThickness < nozzleSize:
834                 return 1
835         if getProfileSetting('spiralize') == 'True':
836                 return 1
837
838         lineCount = int(wallThickness / (nozzleSize - 0.0001))
839         if lineCount < 1:
840                 lineCount = 1
841         lineWidth = wallThickness / lineCount
842         lineWidthAlt = wallThickness / (lineCount + 1)
843         if lineWidth > nozzleSize * 1.5:
844                 return lineCount + 1
845         return lineCount
846
847 def calculateSolidLayerCount():
848         layerHeight = getProfileSettingFloat('layer_height')
849         solidThickness = getProfileSettingFloat('solid_layer_thickness')
850         if layerHeight == 0.0:
851                 return 1
852         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
853
854 def calculateObjectSizeOffsets():
855         size = 0.0
856
857         if getProfileSetting('platform_adhesion') == 'Brim':
858                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
859         elif getProfileSetting('platform_adhesion') == 'Raft':
860                 pass
861         else:
862                 if getProfileSettingFloat('skirt_line_count') > 0:
863                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
864
865         #if getProfileSetting('enable_raft') != 'False':
866         #       size += profile.getProfileSettingFloat('raft_margin') * 2
867         #if getProfileSetting('support') != 'None':
868         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
869         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
870         return [size, size]
871
872 def getMachineCenterCoords():
873         if getMachineSetting('machine_center_is_zero') == 'True':
874                 return [0, 0]
875         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
876
877 #Returns a list of convex polygons, first polygon is the allowed area of the machine,
878 # the rest of the polygons are the dis-allowed areas of the machine.
879 def getMachineSizePolygons():
880         size = numpy.array([getMachineSettingFloat('machine_width'), getMachineSettingFloat('machine_depth'), getMachineSettingFloat('machine_height')], numpy.float32)
881         ret = []
882         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))
883
884         # Circle platform for delta printers...
885         # circle = []
886         # steps = 16
887         # for n in xrange(0, steps):
888         #       circle.append([math.cos(float(n)/steps*2*math.pi) * size[0]/2, math.sin(float(n)/steps*2*math.pi) * size[0]/2])
889         # ret.append(numpy.array(circle, numpy.float32))
890
891         if getMachineSetting('machine_type') == 'ultimaker2':
892                 #UM2 no-go zones
893                 w = 25
894                 h = 10
895                 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))
896                 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))
897                 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))
898                 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))
899         return ret
900
901 #returns the number of extruders minimal used. Normally this returns 1, but with dual-extrusion support material it returns 2
902 def minimalExtruderCount():
903         if int(getMachineSetting('extruder_amount')) < 2:
904                 return 1
905         if getProfileSetting('support') == 'None':
906                 return 1
907         if getProfileSetting('support_dual_extrusion') == 'Second extruder':
908                 return 2
909         return 1
910
911 #########################################################
912 ## Alteration file functions
913 #########################################################
914 def replaceTagMatch(m):
915         pre = m.group(1)
916         tag = m.group(2)
917         if tag == 'time':
918                 return pre + time.strftime('%H:%M:%S')
919         if tag == 'date':
920                 return pre + time.strftime('%d-%m-%Y')
921         if tag == 'day':
922                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
923         if tag == 'print_time':
924                 return pre + '#P_TIME#'
925         if tag == 'filament_amount':
926                 return pre + '#F_AMNT#'
927         if tag == 'filament_weight':
928                 return pre + '#F_WGHT#'
929         if tag == 'filament_cost':
930                 return pre + '#F_COST#'
931         if pre == 'F' and tag == 'max_z_speed':
932                 f = getProfileSettingFloat('travel_speed') * 60
933         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
934                 f = getProfileSettingFloat(tag) * 60
935         elif isProfileSetting(tag):
936                 f = getProfileSettingFloat(tag)
937         elif isPreference(tag):
938                 f = getProfileSettingFloat(tag)
939         else:
940                 return '%s?%s?' % (pre, tag)
941         if (f % 1) == 0:
942                 return pre + str(int(f))
943         return pre + str(f)
944
945 def replaceGCodeTags(filename, gcodeInt):
946         f = open(filename, 'r+')
947         data = f.read(2048)
948         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
949         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
950         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
951         cost = gcodeInt.calculateCost()
952         if cost is None:
953                 cost = 'Unknown'
954         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
955         f.seek(0)
956         f.write(data)
957         f.close()
958
959 def replaceGCodeTagsFromSlicer(filename, slicerInt):
960         f = open(filename, 'r+')
961         data = f.read(2048)
962         data = data.replace('#P_TIME#', slicerInt.getPrintTime())
963         data = data.replace('#F_AMNT#', slicerInt.getFilamentAmount())
964         data = data.replace('#F_WGHT#', ('%8.2f' % (float(slicerInt.getFilamentWeight()) * 1000))[-8:])
965         cost = slicerInt.getFilamentCost()
966         if cost is None:
967                 cost = 'Unknown'
968         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
969         f.seek(0)
970         f.write(data)
971         f.close()
972
973 ### Get aleration raw contents. (Used internally in Cura)
974 def getAlterationFile(filename):
975         if filename in tempOverride:
976                 return tempOverride[filename]
977         global settingsDictionary
978         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
979                 return settingsDictionary[filename].getValue()
980         traceback.print_stack()
981         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
982         return ''
983
984 def setAlterationFile(name, value):
985         #Check if we have a configuration file loaded, else load the default.
986         global settingsDictionary
987         if name in settingsDictionary and settingsDictionary[name].isAlteration():
988                 settingsDictionary[name].setValue(value)
989         saveProfile(getDefaultProfilePath())
990
991 def isTagIn(tag, contents):
992         contents = re.sub(';[^\n]*\n', '', contents)
993         return tag in contents
994
995 ### Get the alteration file for output. (Used by Skeinforge)
996 def getAlterationFileContents(filename, extruderCount = 1):
997         prefix = ''
998         postfix = ''
999         alterationContents = getAlterationFile(filename)
1000         if getMachineSetting('gcode_flavor') == 'UltiGCode':
1001                 if filename == 'end.gcode':
1002                         return 'M25 ;Stop reading from this point on.\n;CURA_PROFILE_STRING:%s\n' % (getProfileString())
1003                 return ''
1004         if filename == 'start.gcode':
1005                 if extruderCount > 1:
1006                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
1007                 #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.
1008                 #We also set our steps per E here, if configured.
1009                 eSteps = getMachineSettingFloat('steps_per_e')
1010                 if eSteps > 0:
1011                         prefix += 'M92 E%f\n' % (eSteps)
1012                 temp = getProfileSettingFloat('print_temperature')
1013                 bedTemp = 0
1014                 if getMachineSetting('has_heated_bed') == 'True':
1015                         bedTemp = getProfileSettingFloat('print_bed_temperature')
1016
1017                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1018                         prefix += 'M140 S%f\n' % (bedTemp)
1019                 if temp > 0 and not isTagIn('{print_temperature}', alterationContents):
1020                         if extruderCount > 0:
1021                                 for n in xrange(1, extruderCount):
1022                                         t = temp
1023                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1024                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1025                                         prefix += 'M104 T%d S%f\n' % (n, t)
1026                                 for n in xrange(0, extruderCount):
1027                                         t = temp
1028                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1029                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1030                                         prefix += 'M109 T%d S%f\n' % (n, t)
1031                                 prefix += 'T0\n'
1032                         else:
1033                                 prefix += 'M109 S%f\n' % (temp)
1034                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1035                         prefix += 'M190 S%f\n' % (bedTemp)
1036         elif filename == 'end.gcode':
1037                 if extruderCount > 1:
1038                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
1039                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
1040                 postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
1041         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'
1042
1043 ###### PLUGIN #####
1044
1045 def getPluginConfig():
1046         try:
1047                 return pickle.loads(str(getProfileSetting('plugin_config')))
1048         except:
1049                 return []
1050
1051 def setPluginConfig(config):
1052         putProfileSetting('plugin_config', pickle.dumps(config))
1053
1054 def getPluginBasePaths():
1055         ret = []
1056         if platform.system() != "Windows":
1057                 ret.append(os.path.expanduser('~/.cura/plugins/'))
1058         if platform.system() == "Darwin" and hasattr(sys, 'frozen'):
1059                 ret.append(os.path.normpath(os.path.join(resources.resourceBasePath, "Cura/plugins")))
1060         else:
1061                 ret.append(os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), '..', 'plugins')))
1062         return ret
1063
1064 def getPluginList():
1065         ret = []
1066         for basePath in getPluginBasePaths():
1067                 for filename in glob.glob(os.path.join(basePath, '*.py')):
1068                         filename = os.path.basename(filename)
1069                         if filename.startswith('_'):
1070                                 continue
1071                         with open(os.path.join(basePath, filename), "r") as f:
1072                                 item = {'filename': filename, 'name': None, 'info': None, 'type': None, 'params': []}
1073                                 for line in f:
1074                                         line = line.strip()
1075                                         if not line.startswith('#'):
1076                                                 break
1077                                         line = line[1:].split(':', 1)
1078                                         if len(line) != 2:
1079                                                 continue
1080                                         if line[0].upper() == 'NAME':
1081                                                 item['name'] = line[1].strip()
1082                                         elif line[0].upper() == 'INFO':
1083                                                 item['info'] = line[1].strip()
1084                                         elif line[0].upper() == 'TYPE':
1085                                                 item['type'] = line[1].strip()
1086                                         elif line[0].upper() == 'DEPEND':
1087                                                 pass
1088                                         elif line[0].upper() == 'PARAM':
1089                                                 m = re.match('([a-zA-Z][a-zA-Z0-9_]*)\(([a-zA-Z_]*)(?::([^\)]*))?\) +(.*)', line[1].strip())
1090                                                 if m is not None:
1091                                                         item['params'].append({'name': m.group(1), 'type': m.group(2), 'default': m.group(3), 'description': m.group(4)})
1092                                         else:
1093                                                 print "Unknown item in effect meta data: %s %s" % (line[0], line[1])
1094                                 if item['name'] is not None and item['type'] == 'postprocess':
1095                                         ret.append(item)
1096         return ret
1097
1098 def runPostProcessingPlugins(gcodefilename):
1099         pluginConfigList = getPluginConfig()
1100         pluginList = getPluginList()
1101
1102         for pluginConfig in pluginConfigList:
1103                 plugin = None
1104                 for pluginTest in pluginList:
1105                         if pluginTest['filename'] == pluginConfig['filename']:
1106                                 plugin = pluginTest
1107                 if plugin is None:
1108                         continue
1109
1110                 pythonFile = None
1111                 for basePath in getPluginBasePaths():
1112                         testFilename = os.path.join(basePath, pluginConfig['filename'])
1113                         if os.path.isfile(testFilename):
1114                                 pythonFile = testFilename
1115                 if pythonFile is None:
1116                         continue
1117
1118                 locals = {'filename': gcodefilename}
1119                 for param in plugin['params']:
1120                         value = param['default']
1121                         if param['name'] in pluginConfig['params']:
1122                                 value = pluginConfig['params'][param['name']]
1123
1124                         if param['type'] == 'float':
1125                                 try:
1126                                         value = float(value)
1127                                 except:
1128                                         value = float(param['default'])
1129
1130                         locals[param['name']] = value
1131                 try:
1132                         execfile(pythonFile, locals)
1133                 except:
1134                         locationInfo = traceback.extract_tb(sys.exc_info()[2])[-1]
1135                         return "%s: '%s' @ %s:%s:%d" % (str(sys.exc_info()[0].__name__), str(sys.exc_info()[1]), os.path.basename(locationInfo[0]), locationInfo[2], locationInfo[1])
1136         return None