307 lines
14 KiB
Python
307 lines
14 KiB
Python
from tclCommands.TclCommand import TclCommand
|
|
|
|
import collections
|
|
import logging
|
|
|
|
import gettext
|
|
import appTranslation as fcTranslate
|
|
import builtins
|
|
|
|
fcTranslate.apply_language('strings')
|
|
if '_' not in builtins.__dict__:
|
|
_ = gettext.gettext
|
|
|
|
log = logging.getLogger('base')
|
|
|
|
|
|
class TclCommandCopperClear(TclCommand):
|
|
"""
|
|
Clear the non-copper areas.
|
|
"""
|
|
|
|
# Array of all command aliases, to be able use old names for backward compatibility (add_poly, add_polygon)
|
|
aliases = ['ncc_clear', 'ncc']
|
|
|
|
description = '%s %s' % ("--", "Clear excess copper.")
|
|
|
|
# dictionary of types from Tcl command, needs to be ordered
|
|
arg_names = collections.OrderedDict([
|
|
('name', str),
|
|
])
|
|
|
|
# dictionary of types from Tcl command, needs to be ordered , this is for options like -optionname value
|
|
option_types = collections.OrderedDict([
|
|
('tooldia', str),
|
|
('overlap', float),
|
|
('order', str),
|
|
('margin', float),
|
|
('method', str),
|
|
('connect', str),
|
|
('contour', str),
|
|
('offset', float),
|
|
('rest', str),
|
|
('all', int),
|
|
('ref', str),
|
|
('box', str),
|
|
('outname', str),
|
|
])
|
|
|
|
# array of mandatory options for current Tcl command: required = {'name','outname'}
|
|
required = ['name']
|
|
|
|
# structured help for current command, args needs to be ordered
|
|
help = {
|
|
'main': "Clear excess copper in polygons. Basically it's a negative Paint.",
|
|
'args': collections.OrderedDict([
|
|
('name', 'Name of the source Geometry object. String.'),
|
|
('tooldia', 'Diameter of the tool to be used. Can be a comma separated list of diameters.\n'
|
|
'WARNING: No space is allowed between tool diameters. E.g: correct: 0.5,1 / incorrect: 0.5, 1'),
|
|
('overlap', 'Percentage of tool diameter to overlap current pass over previous pass. Float [0, 99.9999]\n'
|
|
'E.g: for a 25% from tool diameter overlap use -overlap 25'),
|
|
('margin', 'Bounding box margin. Float number.'),
|
|
('order', 'Can have the values: "no", "fwd" and "rev". String.'
|
|
'It is useful when there are multiple tools in tooldia parameter.'
|
|
'"no" -> the order used is the one provided.'
|
|
'"fwd" -> tools are ordered from smallest to biggest.'
|
|
'"rev" -> tools are ordered from biggest to smallest.'),
|
|
('method', 'Algorithm for copper clearing. Can be: "standard", "seed" or "lines".'),
|
|
('connect', 'Draw lines to minimize tool lifts. True (1) or False (0)'),
|
|
('contour', 'Cut around the perimeter of the painting. True (1) or False (0)'),
|
|
('rest', 'Use rest-machining. True (1) or False (0)'),
|
|
('offset', 'If used, the copper clearing will finish to a distance from copper features. Float number.'),
|
|
('all', 'If used will copper clear the whole object. Either "-all" or "-box <value>" has to be used.'),
|
|
('box', 'Name of the object to be used as reference. Either "-all" or "-box <value>" has to be used. '
|
|
'String.'),
|
|
('outname', 'Name of the resulting Geometry object. String. No spaces.'),
|
|
]),
|
|
'examples': ["ncc obj_name -tooldia 0.3,1 -overlap 10 -margin 1.0 -method 'lines' -all"]
|
|
}
|
|
|
|
def execute(self, args, unnamed_args):
|
|
"""
|
|
execute current TCL shell command
|
|
|
|
:param args: array of known named arguments and options
|
|
:param unnamed_args: array of other values which were passed into command
|
|
without -somename and we do not have them in known arg_names
|
|
:return: None or exception
|
|
"""
|
|
|
|
name = args['name']
|
|
|
|
# Get source object.
|
|
try:
|
|
obj = self.app.collection.get_by_name(str(name))
|
|
except Exception as e:
|
|
log.error("TclCommandCopperClear.execute() --> %s" % str(e))
|
|
self.raise_tcl_error("%s: %s" % (_("Could not retrieve object"), name))
|
|
return "Could not retrieve object: %s" % name
|
|
|
|
if obj is None:
|
|
return "Object not found: %s" % name
|
|
|
|
if 'tooldia' in args:
|
|
tooldia = str(args['tooldia'])
|
|
else:
|
|
tooldia = str(self.app.defaults["tools_ncc_tools"])
|
|
|
|
if 'overlap' in args:
|
|
overlap = float(args['overlap']) / 100.0
|
|
else:
|
|
overlap = float(self.app.defaults["tools_ncc_overlap"]) / 100.0
|
|
|
|
if 'order' in args:
|
|
order = args['order']
|
|
else:
|
|
order = str(self.app.defaults["tools_ncc_order"])
|
|
|
|
if 'margin' in args:
|
|
margin = float(args['margin'])
|
|
else:
|
|
margin = float(self.app.defaults["tools_ncc_margin"])
|
|
|
|
if 'method' in args:
|
|
method = args['method']
|
|
if method == "standard":
|
|
method_data = 0
|
|
elif method == "seed":
|
|
method_data = 1
|
|
elif method == "lines":
|
|
method_data = 2
|
|
else:
|
|
return "Method not supported or typo.\n" \
|
|
"Supported methods are: 'standard', 'seed' and 'lines'."
|
|
else:
|
|
method = str(self.app.defaults["tools_ncc_method"])
|
|
method_data = method
|
|
|
|
if 'connect' in args:
|
|
try:
|
|
par = args['connect'].capitalize()
|
|
except AttributeError:
|
|
par = args['connect']
|
|
connect = bool(eval(par))
|
|
else:
|
|
connect = bool(eval(str(self.app.defaults["tools_ncc_connect"])))
|
|
|
|
if 'contour' in args:
|
|
try:
|
|
par = args['contour'].capitalize()
|
|
except AttributeError:
|
|
par = args['contour']
|
|
contour = bool(eval(par))
|
|
else:
|
|
contour = bool(eval(str(self.app.defaults["tools_ncc_contour"])))
|
|
|
|
offset = 0.0
|
|
if 'offset' in args:
|
|
offset = float(args['offset'])
|
|
has_offset = True
|
|
else:
|
|
has_offset = False
|
|
|
|
try:
|
|
tools = [float(eval(dia)) for dia in tooldia.split(",") if dia != '']
|
|
except AttributeError:
|
|
tools = [float(tooldia)]
|
|
|
|
if 'rest' in args:
|
|
try:
|
|
par = args['rest'].capitalize()
|
|
except AttributeError:
|
|
par = args['rest']
|
|
rest = bool(eval(par))
|
|
else:
|
|
rest = bool(eval(str(self.app.defaults["tools_ncc_rest"])))
|
|
|
|
if 'outname' in args:
|
|
outname = args['outname']
|
|
else:
|
|
if rest is True:
|
|
outname = name + "_ncc"
|
|
else:
|
|
outname = name + "_ncc_rm"
|
|
|
|
# used only to have correct information's in the obj.tools[tool]['data'] dict
|
|
if "all" in args:
|
|
select = 0 # 'ITSELF
|
|
else:
|
|
select = 2 # 'REFERENCE Object'
|
|
|
|
# store here the default data for Geometry Data
|
|
default_data = self.app.options.copy()
|
|
default_data.update({
|
|
"name": outname,
|
|
"plot": False,
|
|
"tools_mill_cutz": self.app.defaults["tools_mill_cutz"],
|
|
"tools_mill_vtipdia": float(self.app.defaults["tools_mill_vtipdia"]),
|
|
"tools_mill_vtipangle": float(self.app.defaults["tools_mill_vtipangle"]),
|
|
"tools_mill_travelz": self.app.defaults["tools_mill_travelz"],
|
|
"tools_mill_feedrate": self.app.defaults["tools_mill_feedrate"],
|
|
"tools_mill_feedrate_z": self.app.defaults["tools_mill_feedrate_z"],
|
|
"tools_mill_feedrate_rapid": self.app.defaults["tools_mill_feedrate_rapid"],
|
|
"tools_mill_dwell": self.app.defaults["tools_mill_dwell"],
|
|
"tools_mill_dwelltime": self.app.defaults["tools_mill_dwelltime"],
|
|
"tools_mill_multidepth": self.app.defaults["tools_mill_multidepth"],
|
|
"tools_mill_ppname_g": self.app.defaults["tools_mill_ppname_g"],
|
|
"tools_mill_depthperpass": self.app.defaults["tools_mill_depthperpass"],
|
|
"tools_mill_extracut": self.app.defaults["tools_mill_extracut"],
|
|
"tools_mill_extracut_length": self.app.defaults["tools_mill_extracut_length"],
|
|
"tools_mill_toolchange": self.app.defaults["tools_mill_toolchange"],
|
|
"tools_mill_toolchangez": self.app.defaults["tools_mill_toolchangez"],
|
|
"tools_mill_endz": self.app.defaults["tools_mill_endz"],
|
|
"tools_mill_endxy": self.app.defaults["tools_mill_endxy"],
|
|
"tools_mill_spindlespeed": self.app.defaults["tools_mill_spindlespeed"],
|
|
"tools_mill_toolchangexy": self.app.defaults["tools_mill_toolchangexy"],
|
|
"tools_mill_startz": self.app.defaults["tools_mill_startz"],
|
|
|
|
"area_exclusion": self.app.defaults["tools_mill_area_exclusion"],
|
|
"area_shape": self.app.defaults["tools_mill_area_shape"],
|
|
"area_strategy": self.app.defaults["tools_mill_area_strategy"],
|
|
"area_overz": float(self.app.defaults["tools_mill_area_overz"]),
|
|
|
|
"tooldia": tooldia,
|
|
"tools_ncc_operation": self.app.defaults["tools_ncc_operation"],
|
|
|
|
"tools_ncc_margin": margin,
|
|
"tools_ncc_method": method_data,
|
|
"tools_ncc_ref": select,
|
|
"tools_ncc_connect": connect,
|
|
"tools_ncc_contour": contour,
|
|
"tools_ncc_overlap": overlap,
|
|
|
|
"tools_ncc_offset_choice": self.app.defaults["tools_ncc_offset_choice"],
|
|
"tools_ncc_offset_value": self.app.defaults["tools_ncc_offset_value"],
|
|
"tools_ncc_milling_type": self.app.defaults["tools_ncc_milling_type"]
|
|
})
|
|
ncc_tools = {}
|
|
|
|
tooluid = 0
|
|
for tool in tools:
|
|
tooluid += 1
|
|
ncc_tools.update({
|
|
int(tooluid): {
|
|
'tooldia': float('%.*f' % (obj.decimals, tool)),
|
|
'data': dict(default_data),
|
|
'solid_geometry': []
|
|
}
|
|
})
|
|
ncc_tools[int(tooluid)]['data']['tooldia'] = self.app.dec_format(tool, obj.decimals)
|
|
|
|
# Non-Copper clear all polygons in the non-copper clear object
|
|
if select == 0: # 'all' in args
|
|
self.app.ncclear_tool.clear_copper_tcl(ncc_obj=obj,
|
|
select_method=0, # ITSELF
|
|
ncctooldia=tooldia,
|
|
overlap=overlap,
|
|
order=order,
|
|
margin=margin,
|
|
has_offset=has_offset,
|
|
offset=offset,
|
|
method=method_data,
|
|
outname=outname,
|
|
connect=connect,
|
|
contour=contour,
|
|
rest=rest,
|
|
tools_storage=ncc_tools,
|
|
plot=False,
|
|
run_threaded=False)
|
|
return
|
|
|
|
# Non-Copper clear all polygons found within the box object from the the non_copper cleared object
|
|
if select == 2: # Reference Object 'box' in args
|
|
box_name = args['box']
|
|
|
|
# Get box source object.
|
|
try:
|
|
box_obj = self.app.collection.get_by_name(str(box_name))
|
|
except Exception as e:
|
|
self.app.log.error("TclCommandCopperClear.execute() --> %s" % str(e))
|
|
self.app.log.error("Could not retrieve object: %s" % name)
|
|
self.raise_tcl_error("%s: %s" % (_("Could not retrieve object"), name))
|
|
return "fail"
|
|
|
|
self.app.ncclear_tool.clear_copper_tcl(ncc_obj=obj,
|
|
sel_obj=box_obj,
|
|
select_method=2, # REFERENCE OBJECT
|
|
ncctooldia=tooldia,
|
|
overlap=overlap,
|
|
order=order,
|
|
margin=margin,
|
|
has_offset=has_offset,
|
|
offset=offset,
|
|
method=method_data,
|
|
outname=outname,
|
|
connect=connect,
|
|
contour=contour,
|
|
rest=rest,
|
|
tools_storage=ncc_tools,
|
|
plot=False,
|
|
run_threaded=False)
|
|
return
|
|
|
|
# if the program reached this then it's an error because neither -all or -box <value> was used.
|
|
self.app.log.error("Expected either -box <value> or -all. Copper clearing failed.")
|
|
self.raise_tcl_error('%s' % _("Expected either -box <value> or -all."))
|
|
return "fail"
|