chiark / gitweb /
Add support for Z offset machine setting
[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. 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."))
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 won't 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 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."))
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 a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
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 a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
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 a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
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 a value of 210C is usually used.\nFor ABS a value of 230C or higher is required."))
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."))
182 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."))
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 of 4.5mm seems to generate good results."))
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. To make sure you do not get a lot of 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 well built Ultimaker can reach speeds of 250mm/s. But some machines might miss steps then."))
206 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."))
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."))
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."))
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', 'Grid', ['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)"), _("Size of the machine in mm"))
498 setting('machine_depth', '205', float, 'machine', 'hidden').setLabel(_("Maximum depth (mm)"), _("Size of the machine in mm"))
499 setting('machine_height', '200', float, 'machine', 'hidden').setLabel(_("Maximum height (mm)"), _("Size of the machine 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 an 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('extruder_z_offset', '0.0', float, 'machine', 'hidden').setLabel(_("Z-Offset"), _("This value will be added to the Z coordinate of every line in the output G-Code to compensate for a badly calibrate Z height endstop."))
513 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."))
514 setting('serial_port', 'AUTO', str, 'machine', 'hidden').setLabel(_("Serial port"), _("Serial port to use for communication with the printer"))
515 setting('serial_port_auto', '', str, 'machine', 'hidden')
516 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"))
517 setting('serial_baud_auto', '', int, 'machine', 'hidden')
518
519 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."))
520 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."))
521 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."))
522 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."))
523 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."))
524
525 validators.warningAbove(settingsDictionary['filament_flow'], 150, _("More flow than 150% is rare and usually not recommended."))
526 validators.warningBelow(settingsDictionary['filament_flow'], 50, _("Less flow than 50% is rare and usually not recommended."))
527 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."))
528 validators.wallThicknessValidator(settingsDictionary['wall_thickness'])
529 validators.warningAbove(settingsDictionary['print_speed'], 150.0, _("It is highly unlikely that your machine can achieve a printing speed above 150mm/s"))
530 validators.printSpeedValidator(settingsDictionary['print_speed'])
531 validators.warningAbove(settingsDictionary['print_temperature'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
532 validators.warningAbove(settingsDictionary['print_temperature2'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
533 validators.warningAbove(settingsDictionary['print_temperature3'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
534 validators.warningAbove(settingsDictionary['print_temperature4'], 260.0, _("Temperatures above 260C could damage your machine, be careful!"))
535 validators.warningAbove(settingsDictionary['filament_diameter'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
536 validators.warningAbove(settingsDictionary['filament_diameter2'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
537 validators.warningAbove(settingsDictionary['filament_diameter3'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
538 validators.warningAbove(settingsDictionary['filament_diameter4'], 3.5, _("Are you sure your filament is that thick? Normal filament is around 3mm or 1.75mm."))
539 validators.warningAbove(settingsDictionary['travel_speed'], 300.0, _("It is highly unlikely that your machine can achieve a travel speed above 300mm/s"))
540 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."))
541
542 #Conditions for multiple extruders
543 settingsDictionary['print_temperature2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
544 settingsDictionary['print_temperature3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
545 settingsDictionary['print_temperature4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
546 settingsDictionary['filament_diameter2'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
547 settingsDictionary['filament_diameter3'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 2)
548 settingsDictionary['filament_diameter4'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 3)
549 settingsDictionary['support_dual_extrusion'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
550 settingsDictionary['retraction_dual_amount'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
551 settingsDictionary['wipe_tower'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
552 settingsDictionary['wipe_tower_volume'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
553 settingsDictionary['ooze_shield'].addCondition(lambda : int(getMachineSetting('extruder_amount')) > 1)
554 #Heated bed
555 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('has_heated_bed') == 'True')
556
557 #UltiGCode uses less settings, as these settings are located inside the machine instead of gcode.
558 settingsDictionary['print_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
559 settingsDictionary['print_temperature2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
560 settingsDictionary['print_temperature3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
561 settingsDictionary['print_temperature4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
562 settingsDictionary['filament_diameter'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
563 settingsDictionary['filament_diameter2'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
564 settingsDictionary['filament_diameter3'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
565 settingsDictionary['filament_diameter4'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
566 settingsDictionary['filament_flow'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
567 settingsDictionary['print_bed_temperature'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
568 settingsDictionary['retraction_speed'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
569 settingsDictionary['retraction_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
570 settingsDictionary['retraction_dual_amount'].addCondition(lambda : getMachineSetting('gcode_flavor') != 'UltiGCode')
571
572 #Remove fake defined _() because later the localization will define a global _()
573 del _
574
575 #########################################################
576 ## Profile and preferences functions
577 #########################################################
578
579 def getSubCategoriesFor(category):
580         done = {}
581         ret = []
582         for s in settingsList:
583                 if s.getCategory() == category and not s.getSubCategory() in done and s.checkConditions():
584                         done[s.getSubCategory()] = True
585                         ret.append(s.getSubCategory())
586         return ret
587
588 def getSettingsForCategory(category, subCategory = None):
589         ret = []
590         for s in settingsList:
591                 if s.getCategory() == category and (subCategory is None or s.getSubCategory() == subCategory) and s.checkConditions():
592                         ret.append(s)
593         return ret
594
595 ## Profile functions
596 def getBasePath():
597         """
598         :return: The path in which the current configuration files are stored. This depends on the used OS.
599         """
600         if platform.system() == "Windows":
601                 basePath = os.path.normpath(os.path.expanduser('~/.cura/%s' % version.getVersion(False)))
602         elif platform.system() == "Darwin":
603                 basePath = os.path.expanduser('~/Library/Application Support/Cura/%s' % version.getVersion(False))
604         else:
605                 basePath = os.path.expanduser('~/.cura/%s' % version.getVersion(False))
606         if not os.path.isdir(basePath):
607                 try:
608                         os.makedirs(basePath)
609                 except:
610                         print "Failed to create directory: %s" % (basePath)
611         return basePath
612
613 def getAlternativeBasePaths():
614         """
615         Search for alternative installations of Cura and their preference files. Used to load configuration from older versions of Cura.
616         """
617         paths = []
618         try:
619                 basePath = os.path.normpath(os.path.join(getBasePath(), '..'))
620                 for subPath in os.listdir(basePath):
621                         path = os.path.join(basePath, subPath)
622                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
623                                 paths.append(path)
624                         path = os.path.join(basePath, subPath, 'Cura')
625                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != getBasePath():
626                                 paths.append(path)
627
628                 #Check the old base path, which was in the application directory.
629                 oldBasePath = os.path.normpath(os.path.join(os.path.dirname(os.path.abspath(__file__)), ".."))
630                 basePath = os.path.normpath(os.path.join(oldBasePath, ".."))
631                 for subPath in os.listdir(basePath):
632                         path = os.path.join(basePath, subPath)
633                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != oldBasePath:
634                                 paths.append(path)
635                         path = os.path.join(basePath, subPath, 'Cura')
636                         if os.path.isdir(path) and os.path.isfile(os.path.join(path, 'preferences.ini')) and path != oldBasePath:
637                                 paths.append(path)
638         except:
639                 pass
640
641         return paths
642
643 def getDefaultProfilePath():
644         """
645         :return: The default path where the currently used profile is stored and loaded on open and close of Cura.
646         """
647         return os.path.join(getBasePath(), 'current_profile.ini')
648
649 def loadProfile(filename, allMachines = False):
650         """
651                 Read a profile file as active profile settings.
652         :param filename:    The ini filename to save the profile in.
653         :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
654         """
655         global settingsList
656         profileParser = ConfigParser.ConfigParser()
657         try:
658                 profileParser.read(filename)
659         except ConfigParser.ParsingError:
660                 return
661         if allMachines:
662                 n = 0
663                 while profileParser.has_section('profile_%d' % (n)):
664                         for set in settingsList:
665                                 if set.isPreference():
666                                         continue
667                                 section = 'profile_%d' % (n)
668                                 if set.isAlteration():
669                                         section = 'alterations_%d' % (n)
670                                 if profileParser.has_option(section, set.getName()):
671                                         set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'), n)
672                         n += 1
673         else:
674                 for set in settingsList:
675                         if set.isPreference():
676                                 continue
677                         section = 'profile'
678                         if set.isAlteration():
679                                 section = 'alterations'
680                         if profileParser.has_option(section, set.getName()):
681                                 set.setValue(unicode(profileParser.get(section, set.getName()), 'utf-8', 'replace'))
682
683 def saveProfile(filename, allMachines = False):
684         """
685                 Save the current profile to an ini file.
686         :param filename:    The ini filename to save the profile in.
687         :param allMachines: When False only the current active profile is saved. If True all profiles for all machines are saved.
688         """
689         global settingsList
690         profileParser = ConfigParser.ConfigParser()
691         if allMachines:
692                 for set in settingsList:
693                         if set.isPreference() or set.isMachineSetting():
694                                 continue
695                         for n in xrange(0, getMachineCount()):
696                                 if set.isAlteration():
697                                         section = 'alterations_%d' % (n)
698                                 else:
699                                         section = 'profile_%d' % (n)
700                                 if not profileParser.has_section(section):
701                                         profileParser.add_section(section)
702                                 profileParser.set(section, set.getName(), set.getValue(n).encode('utf-8'))
703         else:
704                 profileParser.add_section('profile')
705                 profileParser.add_section('alterations')
706                 for set in settingsList:
707                         if set.isPreference() or set.isMachineSetting():
708                                 continue
709                         if set.isAlteration():
710                                 profileParser.set('alterations', set.getName(), set.getValue().encode('utf-8'))
711                         else:
712                                 profileParser.set('profile', set.getName(), set.getValue().encode('utf-8'))
713
714         try:
715                 profileParser.write(open(filename, 'w'))
716         except:
717                 print "Failed to write profile file: %s" % (filename)
718
719 def resetProfile():
720         """ Reset the profile for the current machine to default. """
721         global settingsList
722         for set in settingsList:
723                 if not set.isProfile():
724                         continue
725                 set.setValue(set.getDefault())
726
727         if getMachineSetting('machine_type') == 'ultimaker':
728                 putProfileSetting('nozzle_size', '0.4')
729                 if getMachineSetting('ultimaker_extruder_upgrade') == 'True':
730                         putProfileSetting('retraction_enable', 'True')
731         elif getMachineSetting('machine_type') == 'ultimaker_plus':
732                 putProfileSetting('nozzle_size', '0.4')
733                 putProfileSetting('retraction_enable', 'True')
734         elif getMachineSetting('machine_type') == 'ultimaker2':
735                 putProfileSetting('nozzle_size', '0.4')
736                 putProfileSetting('retraction_enable', 'True')
737         else:
738                 putProfileSetting('nozzle_size', '0.5')
739                 putProfileSetting('retraction_enable', 'True')
740
741 def setProfileFromString(options):
742         """
743         Parse an encoded string which has all the profile settings stored inside of it.
744         Used in combination with getProfileString to ease sharing of profiles.
745         """
746         options = base64.b64decode(options)
747         options = zlib.decompress(options)
748         (profileOpts, alt) = options.split('\f', 1)
749         global settingsDictionary
750         for option in profileOpts.split('\b'):
751                 if len(option) > 0:
752                         (key, value) = option.split('=', 1)
753                         if key in settingsDictionary:
754                                 if settingsDictionary[key].isProfile():
755                                         settingsDictionary[key].setValue(value)
756         for option in alt.split('\b'):
757                 if len(option) > 0:
758                         (key, value) = option.split('=', 1)
759                         if key in settingsDictionary:
760                                 if settingsDictionary[key].isAlteration():
761                                         settingsDictionary[key].setValue(value)
762
763 def getProfileString():
764         """
765         Get an encoded string which contains all profile settings.
766         Used in combination with setProfileFromString to share settings in files, forums or other text based ways.
767         """
768         p = []
769         alt = []
770         global settingsList
771         for set in settingsList:
772                 if set.isProfile():
773                         if set.getName() in tempOverride:
774                                 p.append(set.getName() + "=" + tempOverride[set.getName()])
775                         else:
776                                 p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
777                 elif set.isAlteration():
778                         if set.getName() in tempOverride:
779                                 alt.append(set.getName() + "=" + tempOverride[set.getName()])
780                         else:
781                                 alt.append(set.getName() + "=" + set.getValue().encode('utf-8'))
782         ret = '\b'.join(p) + '\f' + '\b'.join(alt)
783         ret = base64.b64encode(zlib.compress(ret, 9))
784         return ret
785
786 def insertNewlines(string, every=64): #This should be moved to a better place then profile.
787         lines = []
788         for i in xrange(0, len(string), every):
789                 lines.append(string[i:i+every])
790         return '\n'.join(lines)
791
792 def getPreferencesString():
793         """
794         :return: An encoded string which contains all the current preferences.
795         """
796         p = []
797         global settingsList
798         for set in settingsList:
799                 if set.isPreference():
800                         p.append(set.getName() + "=" + set.getValue().encode('utf-8'))
801         ret = '\b'.join(p)
802         ret = base64.b64encode(zlib.compress(ret, 9))
803         return ret
804
805
806 def getProfileSetting(name):
807         """
808                 Get the value of an profile setting.
809         :param name: Name of the setting to retrieve.
810         :return:     Value of the current setting.
811         """
812         if name in tempOverride:
813                 return tempOverride[name]
814         global settingsDictionary
815         if name in settingsDictionary and settingsDictionary[name].isProfile():
816                 return settingsDictionary[name].getValue()
817         traceback.print_stack()
818         sys.stderr.write('Error: "%s" not found in profile settings\n' % (name))
819         return ''
820
821 def getProfileSettingFloat(name):
822         try:
823                 setting = getProfileSetting(name).replace(',', '.')
824                 return float(eval(setting, {}, {}))
825         except:
826                 return 0.0
827
828 def putProfileSetting(name, value):
829         """ Store a certain value in a profile setting. """
830         global settingsDictionary
831         if name in settingsDictionary and settingsDictionary[name].isProfile():
832                 settingsDictionary[name].setValue(value)
833
834 def isProfileSetting(name):
835         """ Check if a certain key name is actually a profile value. """
836         global settingsDictionary
837         if name in settingsDictionary and settingsDictionary[name].isProfile():
838                 return True
839         return False
840
841 ## Preferences functions
842 def getPreferencePath():
843         """
844         :return: The full path of the preference ini file.
845         """
846         return os.path.join(getBasePath(), 'preferences.ini')
847
848 def getPreferenceFloat(name):
849         """
850         Get the float value of a preference, returns 0.0 if the preference is not a invalid float
851         """
852         try:
853                 setting = getPreference(name).replace(',', '.')
854                 return float(eval(setting, {}, {}))
855         except:
856                 return 0.0
857
858 def getPreferenceColour(name):
859         """
860         Get a preference setting value as a color array. The color is stored as #RRGGBB hex string in the setting.
861         """
862         colorString = getPreference(name)
863         return [float(int(colorString[1:3], 16)) / 255, float(int(colorString[3:5], 16)) / 255, float(int(colorString[5:7], 16)) / 255, 1.0]
864
865 def loadPreferences(filename):
866         """
867         Read a configuration file as global config
868         """
869         global settingsList
870         profileParser = ConfigParser.ConfigParser()
871         try:
872                 profileParser.read(filename)
873         except ConfigParser.ParsingError:
874                 return
875
876         for set in settingsList:
877                 if set.isPreference():
878                         if profileParser.has_option('preference', set.getName()):
879                                 set.setValue(unicode(profileParser.get('preference', set.getName()), 'utf-8', 'replace'))
880
881         n = 0
882         while profileParser.has_section('machine_%d' % (n)):
883                 for set in settingsList:
884                         if set.isMachineSetting():
885                                 if profileParser.has_option('machine_%d' % (n), set.getName()):
886                                         set.setValue(unicode(profileParser.get('machine_%d' % (n), set.getName()), 'utf-8', 'replace'), n)
887                 n += 1
888
889         setActiveMachine(int(getPreferenceFloat('active_machine')))
890
891 def loadMachineSettings(filename):
892         global settingsList
893         #Read a configuration file as global config
894         profileParser = ConfigParser.ConfigParser()
895         try:
896                 profileParser.read(filename)
897         except ConfigParser.ParsingError:
898                 return
899
900         for set in settingsList:
901                 if set.isMachineSetting():
902                         if profileParser.has_option('machine', set.getName()):
903                                 set.setValue(unicode(profileParser.get('machine', set.getName()), 'utf-8', 'replace'))
904         checkAndUpdateMachineName()
905
906 def savePreferences(filename):
907         global settingsList
908         #Save the current profile to an ini file
909         parser = ConfigParser.ConfigParser()
910         parser.add_section('preference')
911
912         for set in settingsList:
913                 if set.isPreference():
914                         parser.set('preference', set.getName(), set.getValue().encode('utf-8'))
915
916         n = 0
917         while getMachineSetting('machine_name', n) != '':
918                 parser.add_section('machine_%d' % (n))
919                 for set in settingsList:
920                         if set.isMachineSetting():
921                                 parser.set('machine_%d' % (n), set.getName(), set.getValue(n).encode('utf-8'))
922                 n += 1
923         try:
924                 parser.write(open(filename, 'w'))
925         except:
926                 print "Failed to write preferences file: %s" % (filename)
927
928 def getPreference(name):
929         if name in tempOverride:
930                 return tempOverride[name]
931         global settingsDictionary
932         if name in settingsDictionary and settingsDictionary[name].isPreference():
933                 return settingsDictionary[name].getValue()
934         traceback.print_stack()
935         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
936         return ''
937
938 def putPreference(name, value):
939         #Check if we have a configuration file loaded, else load the default.
940         global settingsDictionary
941         if name in settingsDictionary and settingsDictionary[name].isPreference():
942                 settingsDictionary[name].setValue(value)
943                 savePreferences(getPreferencePath())
944                 return
945         traceback.print_stack()
946         sys.stderr.write('Error: "%s" not found in preferences\n' % (name))
947
948 def isPreference(name):
949         global settingsDictionary
950         if name in settingsDictionary and settingsDictionary[name].isPreference():
951                 return True
952         return False
953
954 def getMachineSettingFloat(name, index = None):
955         try:
956                 setting = getMachineSetting(name, index).replace(',', '.')
957                 return float(eval(setting, {}, {}))
958         except:
959                 return 0.0
960
961 def getMachineSetting(name, index = None):
962         if name in tempOverride:
963                 return tempOverride[name]
964         global settingsDictionary
965         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
966                 return settingsDictionary[name].getValue(index)
967         traceback.print_stack()
968         sys.stderr.write('Error: "%s" not found in machine settings\n' % (name))
969         return ''
970
971 def putMachineSetting(name, value, index = None):
972         #Check if we have a configuration file loaded, else load the default.
973         global settingsDictionary
974         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
975                 settingsDictionary[name].setValue(value, index)
976         savePreferences(getPreferencePath())
977
978 def isMachineSetting(name):
979         global settingsDictionary
980         if name in settingsDictionary and settingsDictionary[name].isMachineSetting():
981                 return True
982         return False
983
984 def checkAndUpdateMachineName():
985         global _selectedMachineIndex
986         name = getMachineSetting('machine_name')
987         index = None
988         if name == '':
989                 name = getMachineSetting('machine_type')
990         for n in xrange(0, getMachineCount()):
991                 if n == _selectedMachineIndex:
992                         continue
993                 if index is None:
994                         if name == getMachineSetting('machine_name', n):
995                                 index = 1
996                 else:
997                         if '%s (%d)' % (name, index) == getMachineSetting('machine_name', n):
998                                 index += 1
999         if index is not None:
1000                 name = '%s (%d)' % (name, index)
1001         putMachineSetting('machine_name', name)
1002         putPreference('active_machine', _selectedMachineIndex)
1003
1004 def getMachineCount():
1005         n = 0
1006         while getMachineSetting('machine_name', n) != '':
1007                 n += 1
1008         if n < 1:
1009                 return 1
1010         return n
1011
1012 def setActiveMachine(index):
1013         global _selectedMachineIndex
1014         _selectedMachineIndex = index
1015         putPreference('active_machine', _selectedMachineIndex)
1016
1017 def removeMachine(index):
1018         global _selectedMachineIndex
1019         global settingsList
1020         if getMachineCount() < 2:
1021                 return
1022         for n in xrange(index, getMachineCount()):
1023                 for setting in settingsList:
1024                         if setting.isMachineSetting():
1025                                 setting.setValue(setting.getValue(n+1), n)
1026
1027         if _selectedMachineIndex >= index:
1028                 setActiveMachine(getMachineCount() - 1)
1029
1030 ## Temp overrides for multi-extruder slicing and the project planner.
1031 tempOverride = {}
1032 def setTempOverride(name, value):
1033         tempOverride[name] = unicode(value).encode("utf-8")
1034 def clearTempOverride(name):
1035         del tempOverride[name]
1036 def resetTempOverride():
1037         tempOverride.clear()
1038
1039 #########################################################
1040 ## Utility functions to calculate common profile values
1041 #########################################################
1042 def calculateEdgeWidth():
1043         wallThickness = getProfileSettingFloat('wall_thickness')
1044         nozzleSize = getProfileSettingFloat('nozzle_size')
1045
1046         if getProfileSetting('spiralize') == 'True' or getProfileSetting('simple_mode') == 'True':
1047                 return wallThickness
1048
1049         if wallThickness < 0.01:
1050                 return nozzleSize
1051         if wallThickness < nozzleSize:
1052                 return wallThickness
1053
1054         lineCount = int(wallThickness / (nozzleSize - 0.0001))
1055         if lineCount == 0:
1056                 return nozzleSize
1057         lineWidth = wallThickness / lineCount
1058         lineWidthAlt = wallThickness / (lineCount + 1)
1059         if lineWidth > nozzleSize * 1.5:
1060                 return lineWidthAlt
1061         return lineWidth
1062
1063 def calculateLineCount():
1064         wallThickness = getProfileSettingFloat('wall_thickness')
1065         nozzleSize = getProfileSettingFloat('nozzle_size')
1066
1067         if wallThickness < 0.01:
1068                 return 0
1069         if wallThickness < nozzleSize:
1070                 return 1
1071         if getProfileSetting('spiralize') == 'True' or getProfileSetting('simple_mode') == 'True':
1072                 return 1
1073
1074         lineCount = int(wallThickness / (nozzleSize - 0.0001))
1075         if lineCount < 1:
1076                 lineCount = 1
1077         lineWidth = wallThickness / lineCount
1078         lineWidthAlt = wallThickness / (lineCount + 1)
1079         if lineWidth > nozzleSize * 1.5:
1080                 return lineCount + 1
1081         return lineCount
1082
1083 def calculateSolidLayerCount():
1084         layerHeight = getProfileSettingFloat('layer_height')
1085         solidThickness = getProfileSettingFloat('solid_layer_thickness')
1086         if layerHeight == 0.0:
1087                 return 1
1088         return int(math.ceil(solidThickness / (layerHeight - 0.0001)))
1089
1090 def calculateObjectSizeOffsets():
1091         size = 0.0
1092
1093         if getProfileSetting('platform_adhesion') == 'Brim':
1094                 size += getProfileSettingFloat('brim_line_count') * calculateEdgeWidth()
1095         elif getProfileSetting('platform_adhesion') == 'Raft':
1096                 pass
1097         else:
1098                 if getProfileSettingFloat('skirt_line_count') > 0:
1099                         size += getProfileSettingFloat('skirt_line_count') * calculateEdgeWidth() + getProfileSettingFloat('skirt_gap')
1100
1101         #if getProfileSetting('enable_raft') != 'False':
1102         #       size += profile.getProfileSettingFloat('raft_margin') * 2
1103         #if getProfileSetting('support') != 'None':
1104         #       extraSizeMin = extraSizeMin + numpy.array([3.0, 0, 0])
1105         #       extraSizeMax = extraSizeMax + numpy.array([3.0, 0, 0])
1106         return [size, size]
1107
1108 def getMachineCenterCoords():
1109         if getMachineSetting('machine_center_is_zero') == 'True':
1110                 return [0, 0]
1111         elif getMachineSetting('machine_type') == 'lulzbot_mini':
1112                 return [(getMachineSettingFloat('machine_width') / 2) + 2.5, (getMachineSettingFloat('machine_width') / 2) + 0.5]
1113         return [getMachineSettingFloat('machine_width') / 2, getMachineSettingFloat('machine_depth') / 2]
1114
1115 #Returns a list of convex polygons, first polygon is the allowed area of the machine,
1116 # the rest of the polygons are the dis-allowed areas of the machine.
1117 def getMachineSizePolygons():
1118         size = numpy.array([getMachineSettingFloat('machine_width'), getMachineSettingFloat('machine_depth'), getMachineSettingFloat('machine_height')], numpy.float32)
1119         ret = []
1120         if getMachineSetting('machine_shape') == 'Circular':
1121                 # Circle platform for delta printers...
1122                 circle = []
1123                 steps = 32
1124                 for n in xrange(0, steps):
1125                         circle.append([math.cos(float(n)/steps*2*math.pi) * size[0]/2, math.sin(float(n)/steps*2*math.pi) * size[1]/2])
1126                 ret.append(numpy.array(circle, numpy.float32))
1127         else:
1128                 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))
1129
1130         if getMachineSetting('machine_type') == 'ultimaker2':
1131                 #UM2 no-go zones
1132                 w = 25
1133                 h = 10
1134                 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))
1135                 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))
1136                 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))
1137                 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))
1138         return ret
1139
1140 #returns the number of extruders minimal used. Normally this returns 1, but with dual-extrusion support material it returns 2
1141 def minimalExtruderCount():
1142         if int(getMachineSetting('extruder_amount')) < 2:
1143                 return 1
1144         if getProfileSetting('support') == 'None':
1145                 return 1
1146         if getProfileSetting('support_dual_extrusion') == 'Second extruder':
1147                 return 2
1148         return 1
1149
1150 def getGCodeExtension():
1151         if getMachineSetting('gcode_flavor') == 'BFB':
1152                 return '.bfb'
1153         return '.gcode'
1154
1155 #########################################################
1156 ## Alteration file functions
1157 #########################################################
1158 def replaceTagMatch(m):
1159         pre = m.group(1)
1160         tag = m.group(2)
1161         if tag == 'time':
1162                 return pre + time.strftime('%H:%M:%S')
1163         if tag == 'date':
1164                 return pre + time.strftime('%d-%m-%Y')
1165         if tag == 'day':
1166                 return pre + ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'][int(time.strftime('%w'))]
1167         if tag == 'print_time':
1168                 return pre + '#P_TIME#'
1169         if tag == 'filament_amount':
1170                 return pre + '#F_AMNT#'
1171         if tag == 'filament_weight':
1172                 return pre + '#F_WGHT#'
1173         if tag == 'filament_cost':
1174                 return pre + '#F_COST#'
1175         if tag == 'profile_string':
1176                 return pre + 'CURA_PROFILE_STRING:%s' % (getProfileString())
1177         if pre == 'F' and tag == 'max_z_speed':
1178                 f = getProfileSettingFloat('travel_speed') * 60
1179         if pre == 'F' and tag in ['print_speed', 'retraction_speed', 'travel_speed', 'bottom_layer_speed', 'cool_min_feedrate']:
1180                 f = getProfileSettingFloat(tag) * 60
1181         elif isProfileSetting(tag):
1182                 f = getProfileSettingFloat(tag)
1183         elif isPreference(tag):
1184                 f = getProfileSettingFloat(tag)
1185         else:
1186                 return '%s?%s?' % (pre, tag)
1187         if (f % 1) == 0:
1188                 return pre + str(int(f))
1189         return pre + str(f)
1190
1191 def replaceGCodeTags(filename, gcodeInt):
1192         f = open(filename, 'r+')
1193         data = f.read(2048)
1194         data = data.replace('#P_TIME#', ('%5d:%02d' % (int(gcodeInt.totalMoveTimeMinute / 60), int(gcodeInt.totalMoveTimeMinute % 60)))[-8:])
1195         data = data.replace('#F_AMNT#', ('%8.2f' % (gcodeInt.extrusionAmount / 1000))[-8:])
1196         data = data.replace('#F_WGHT#', ('%8.2f' % (gcodeInt.calculateWeight() * 1000))[-8:])
1197         cost = gcodeInt.calculateCost()
1198         if cost is None:
1199                 cost = 'Unknown'
1200         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
1201         f.seek(0)
1202         f.write(data)
1203         f.close()
1204
1205 def replaceGCodeTagsFromSlicer(filename, slicerInt):
1206         f = open(filename, 'r+')
1207         data = f.read(2048)
1208         data = data.replace('#P_TIME#', ('%8.2f' % (int(slicerInt._printTimeSeconds)))[-8:])
1209         data = data.replace('#F_AMNT#', ('%8.2f' % (slicerInt._filamentMM[0]))[-8:])
1210         data = data.replace('#F_WGHT#', ('%8.2f' % (float(slicerInt.getFilamentWeight()) * 1000))[-8:])
1211         cost = slicerInt.getFilamentCost()
1212         if cost is None:
1213                 cost = 'Unknown'
1214         data = data.replace('#F_COST#', ('%8s' % (cost.split(' ')[0]))[-8:])
1215         f.seek(0)
1216         f.write(data)
1217         f.close()
1218
1219 ### Get aleration raw contents. (Used internally in Cura)
1220 def getAlterationFile(filename):
1221         if filename in tempOverride:
1222                 return tempOverride[filename]
1223         global settingsDictionary
1224         if filename in settingsDictionary and settingsDictionary[filename].isAlteration():
1225                 return settingsDictionary[filename].getValue()
1226         traceback.print_stack()
1227         sys.stderr.write('Error: "%s" not found in alteration settings\n' % (filename))
1228         return ''
1229
1230 def setAlterationFile(name, value):
1231         #Check if we have a configuration file loaded, else load the default.
1232         global settingsDictionary
1233         if name in settingsDictionary and settingsDictionary[name].isAlteration():
1234                 settingsDictionary[name].setValue(value)
1235         saveProfile(getDefaultProfilePath(), True)
1236
1237 def isTagIn(tag, contents):
1238         contents = re.sub(';[^\n]*\n', '', contents)
1239         return tag in contents
1240
1241 ### Get the alteration file for output. (Used by Skeinforge)
1242 def getAlterationFileContents(filename, extruderCount = 1):
1243         prefix = ''
1244         postfix = ''
1245         alterationContents = getAlterationFile(filename)
1246         if getMachineSetting('gcode_flavor') == 'UltiGCode':
1247                 if filename == 'end.gcode':
1248                         return 'M25 ;Stop reading from this point on.\n;CURA_PROFILE_STRING:%s\n' % (getProfileString())
1249                 return ''
1250         if filename == 'start.gcode':
1251                 if extruderCount > 1:
1252                         alterationContents = getAlterationFile("start%d.gcode" % (extruderCount))
1253                 #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.
1254                 #We also set our steps per E here, if configured.
1255                 eSteps = getMachineSettingFloat('steps_per_e')
1256                 if eSteps > 0:
1257                         prefix += 'M92 E%f\n' % (eSteps)
1258                 temp = getProfileSettingFloat('print_temperature')
1259                 bedTemp = 0
1260                 if getMachineSetting('has_heated_bed') == 'True':
1261                         bedTemp = getProfileSettingFloat('print_bed_temperature')
1262
1263                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1264                         prefix += 'M140 S%f\n' % (bedTemp)
1265                 if temp > 0 and not isTagIn('{print_temperature}', alterationContents):
1266                         if extruderCount > 0:
1267                                 for n in xrange(1, extruderCount):
1268                                         t = temp
1269                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1270                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1271                                         prefix += 'M104 T%d S%f\n' % (n, t)
1272                                 for n in xrange(0, extruderCount):
1273                                         t = temp
1274                                         if n > 0 and getProfileSettingFloat('print_temperature%d' % (n+1)) > 0:
1275                                                 t = getProfileSettingFloat('print_temperature%d' % (n+1))
1276                                         prefix += 'M109 T%d S%f\n' % (n, t)
1277                                 prefix += 'T0\n'
1278                         else:
1279                                 prefix += 'M109 S%f\n' % (temp)
1280                 if bedTemp > 0 and not isTagIn('{print_bed_temperature}', alterationContents):
1281                         prefix += 'M190 S%f\n' % (bedTemp)
1282         elif filename == 'end.gcode':
1283                 if extruderCount > 1:
1284                         alterationContents = getAlterationFile("end%d.gcode" % (extruderCount))
1285                 #Append the profile string to the end of the GCode, so we can load it from the GCode file later.
1286                 #postfix = ';CURA_PROFILE_STRING:%s\n' % (getProfileString())
1287         return unicode(prefix + re.sub("(.)\{([^\}]*)\}", replaceTagMatch, alterationContents).rstrip() + '\n' + postfix).strip().encode('utf-8') + '\n'