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