FlatCAMObj.py 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619
  1. from cStringIO import StringIO
  2. from PyQt4 import QtCore
  3. from copy import copy
  4. from ObjectUI import *
  5. import FlatCAMApp
  6. import inspect # TODO: For debugging only.
  7. from camlib import *
  8. from FlatCAMCommon import LoudDict
  9. from FlatCAMDraw import FlatCAMDraw
  10. ########################################
  11. ## FlatCAMObj ##
  12. ########################################
  13. class FlatCAMObj(QtCore.QObject):
  14. """
  15. Base type of objects handled in FlatCAM. These become interactive
  16. in the GUI, can be plotted, and their options can be modified
  17. by the user in their respective forms.
  18. """
  19. # Instance of the application to which these are related.
  20. # The app should set this value.
  21. app = None
  22. def __init__(self, name):
  23. """
  24. Constructor.
  25. :param name: Name of the object given by the user.
  26. :return: FlatCAMObj
  27. """
  28. QtCore.QObject.__init__(self)
  29. # View
  30. self.ui = None
  31. self.options = LoudDict(name=name)
  32. self.options.set_change_callback(self.on_options_change)
  33. self.form_fields = {}
  34. self.axes = None # Matplotlib axes
  35. self.kind = None # Override with proper name
  36. self.muted_ui = False
  37. # assert isinstance(self.ui, ObjectUI)
  38. # self.ui.name_entry.returnPressed.connect(self.on_name_activate)
  39. # self.ui.offset_button.clicked.connect(self.on_offset_button_click)
  40. # self.ui.scale_button.clicked.connect(self.on_scale_button_click)
  41. def from_dict(self, d):
  42. """
  43. This supersedes ``from_dict`` in derived classes. Derived classes
  44. must inherit from FlatCAMObj first, then from derivatives of Geometry.
  45. ``self.options`` is only updated, not overwritten. This ensures that
  46. options set by the app do not vanish when reading the objects
  47. from a project file.
  48. :param d: Dictionary with attributes to set.
  49. :return: None
  50. """
  51. for attr in self.ser_attrs:
  52. if attr == 'options':
  53. self.options.update(d[attr])
  54. else:
  55. setattr(self, attr, d[attr])
  56. def on_options_change(self, key):
  57. self.emit(QtCore.SIGNAL("optionChanged"), key)
  58. def set_ui(self, ui):
  59. self.ui = ui
  60. self.form_fields = {"name": self.ui.name_entry}
  61. assert isinstance(self.ui, ObjectUI)
  62. self.ui.name_entry.returnPressed.connect(self.on_name_activate)
  63. self.ui.offset_button.clicked.connect(self.on_offset_button_click)
  64. self.ui.scale_button.clicked.connect(self.on_scale_button_click)
  65. def __str__(self):
  66. return "<FlatCAMObj({:12s}): {:20s}>".format(self.kind, self.options["name"])
  67. def on_name_activate(self):
  68. old_name = copy(self.options["name"])
  69. new_name = self.ui.name_entry.get_value()
  70. self.options["name"] = self.ui.name_entry.get_value()
  71. self.app.info("Name changed from %s to %s" % (old_name, new_name))
  72. def on_offset_button_click(self):
  73. self.app.report_usage("obj_on_offset_button")
  74. self.read_form()
  75. vect = self.ui.offsetvector_entry.get_value()
  76. self.offset(vect)
  77. self.plot()
  78. def on_scale_button_click(self):
  79. self.app.report_usage("obj_on_scale_button")
  80. self.read_form()
  81. factor = self.ui.scale_entry.get_value()
  82. self.scale(factor)
  83. self.plot()
  84. def setup_axes(self, figure):
  85. """
  86. 1) Creates axes if they don't exist. 2) Clears axes. 3) Attaches
  87. them to figure if not part of the figure. 4) Sets transparent
  88. background. 5) Sets 1:1 scale aspect ratio.
  89. :param figure: A Matplotlib.Figure on which to add/configure axes.
  90. :type figure: matplotlib.figure.Figure
  91. :return: None
  92. :rtype: None
  93. """
  94. if self.axes is None:
  95. FlatCAMApp.App.log.debug("setup_axes(): New axes")
  96. self.axes = figure.add_axes([0.05, 0.05, 0.9, 0.9],
  97. label=self.options["name"])
  98. elif self.axes not in figure.axes:
  99. FlatCAMApp.App.log.debug("setup_axes(): Clearing and attaching axes")
  100. self.axes.cla()
  101. figure.add_axes(self.axes)
  102. else:
  103. FlatCAMApp.App.log.debug("setup_axes(): Clearing Axes")
  104. self.axes.cla()
  105. # Remove all decoration. The app's axes will have
  106. # the ticks and grid.
  107. self.axes.set_frame_on(False) # No frame
  108. self.axes.set_xticks([]) # No tick
  109. self.axes.set_yticks([]) # No ticks
  110. self.axes.patch.set_visible(False) # No background
  111. self.axes.set_aspect(1)
  112. def to_form(self):
  113. """
  114. Copies options to the UI form.
  115. :return: None
  116. """
  117. FlatCAMApp.App.log.debug(str(inspect.stack()[1][3]) + "--> FlatCAMObj.to_form()")
  118. for option in self.options:
  119. try:
  120. self.set_form_item(option)
  121. except:
  122. self.app.log.warning("Unexpected error:", sys.exc_info())
  123. def read_form(self):
  124. """
  125. Reads form into ``self.options``.
  126. :return: None
  127. :rtype: None
  128. """
  129. FlatCAMApp.App.log.debug(str(inspect.stack()[1][3]) + "--> FlatCAMObj.read_form()")
  130. for option in self.options:
  131. try:
  132. self.read_form_item(option)
  133. except:
  134. self.app.log.warning("Unexpected error:", sys.exc_info())
  135. def build_ui(self):
  136. """
  137. Sets up the UI/form for this object. Show the UI
  138. in the App.
  139. :return: None
  140. :rtype: None
  141. """
  142. self.muted_ui = True
  143. FlatCAMApp.App.log.debug(str(inspect.stack()[1][3]) + "--> FlatCAMObj.build_ui()")
  144. # Remove anything else in the box
  145. # box_children = self.app.ui.notebook.selected_contents.get_children()
  146. # for child in box_children:
  147. # self.app.ui.notebook.selected_contents.remove(child)
  148. # while self.app.ui.selected_layout.count():
  149. # self.app.ui.selected_layout.takeAt(0)
  150. # Put in the UI
  151. # box_selected.pack_start(sw, True, True, 0)
  152. # self.app.ui.notebook.selected_contents.add(self.ui)
  153. # self.app.ui.selected_layout.addWidget(self.ui)
  154. try:
  155. self.app.ui.selected_scroll_area.takeWidget()
  156. except:
  157. self.app.log.debug("Nothing to remove")
  158. self.app.ui.selected_scroll_area.setWidget(self.ui)
  159. self.to_form()
  160. self.muted_ui = False
  161. def set_form_item(self, option):
  162. """
  163. Copies the specified option to the UI form.
  164. :param option: Name of the option (Key in ``self.options``).
  165. :type option: str
  166. :return: None
  167. """
  168. try:
  169. self.form_fields[option].set_value(self.options[option])
  170. except KeyError:
  171. self.app.log.warn("Tried to set an option or field that does not exist: %s" % option)
  172. def read_form_item(self, option):
  173. """
  174. Reads the specified option from the UI form into ``self.options``.
  175. :param option: Name of the option.
  176. :type option: str
  177. :return: None
  178. """
  179. try:
  180. self.options[option] = self.form_fields[option].get_value()
  181. except KeyError:
  182. self.app.log.warning("Failed to read option from field: %s" % option)
  183. # #try read field only when option have equivalent in form_fields
  184. # if option in self.form_fields:
  185. # option_type=type(self.options[option])
  186. # try:
  187. # value=self.form_fields[option].get_value()
  188. # #catch per option as it was ignored anyway, also when syntax error (probably uninitialized field),don't read either.
  189. # except (KeyError,SyntaxError):
  190. # self.app.log.warning("Failed to read option from field: %s" % option)
  191. # else:
  192. # self.app.log.warning("Form fied does not exists: %s" % option)
  193. def plot(self):
  194. """
  195. Plot this object (Extend this method to implement the actual plotting).
  196. Axes get created, appended to canvas and cleared before plotting.
  197. Call this in descendants before doing the plotting.
  198. :return: Whether to continue plotting or not depending on the "plot" option.
  199. :rtype: bool
  200. """
  201. FlatCAMApp.App.log.debug(str(inspect.stack()[1][3]) + " --> FlatCAMObj.plot()")
  202. # Axes must exist and be attached to canvas.
  203. if self.axes is None or self.axes not in self.app.plotcanvas.figure.axes:
  204. self.axes = self.app.plotcanvas.new_axes(self.options['name'])
  205. if not self.options["plot"]:
  206. self.axes.cla()
  207. self.app.plotcanvas.auto_adjust_axes()
  208. return False
  209. # Clear axes or we will plot on top of them.
  210. self.axes.cla() # TODO: Thread safe?
  211. return True
  212. def serialize(self):
  213. """
  214. Returns a representation of the object as a dictionary so
  215. it can be later exported as JSON. Override this method.
  216. :return: Dictionary representing the object
  217. :rtype: dict
  218. """
  219. return
  220. def deserialize(self, obj_dict):
  221. """
  222. Re-builds an object from its serialized version.
  223. :param obj_dict: Dictionary representing a FlatCAMObj
  224. :type obj_dict: dict
  225. :return: None
  226. """
  227. return
  228. class FlatCAMGerber(FlatCAMObj, Gerber):
  229. """
  230. Represents Gerber code.
  231. """
  232. ui_type = GerberObjectUI
  233. def __init__(self, name):
  234. Gerber.__init__(self)
  235. FlatCAMObj.__init__(self, name)
  236. self.kind = "gerber"
  237. # The 'name' is already in self.options from FlatCAMObj
  238. # Automatically updates the UI
  239. self.options.update({
  240. "plot": True,
  241. "multicolored": False,
  242. "solid": False,
  243. "isotooldia": 0.016,
  244. "isopasses": 1,
  245. "isooverlap": 0.15,
  246. "combine_passes": True,
  247. "cutouttooldia": 0.07,
  248. "cutoutmargin": 0.2,
  249. "cutoutgapsize": 0.15,
  250. "gaps": "tb",
  251. "noncoppermargin": 0.0,
  252. "noncopperrounded": False,
  253. "bboxmargin": 0.0,
  254. "bboxrounded": False
  255. })
  256. # Attributes to be included in serialization
  257. # Always append to it because it carries contents
  258. # from predecessors.
  259. self.ser_attrs += ['options', 'kind']
  260. # assert isinstance(self.ui, GerberObjectUI)
  261. # self.ui.plot_cb.stateChanged.connect(self.on_plot_cb_click)
  262. # self.ui.solid_cb.stateChanged.connect(self.on_solid_cb_click)
  263. # self.ui.multicolored_cb.stateChanged.connect(self.on_multicolored_cb_click)
  264. # self.ui.generate_iso_button.clicked.connect(self.on_iso_button_click)
  265. # self.ui.generate_cutout_button.clicked.connect(self.on_generatecutout_button_click)
  266. # self.ui.generate_bb_button.clicked.connect(self.on_generatebb_button_click)
  267. # self.ui.generate_noncopper_button.clicked.connect(self.on_generatenoncopper_button_click)
  268. def set_ui(self, ui):
  269. """
  270. Maps options with GUI inputs.
  271. Connects GUI events to methods.
  272. :param ui: GUI object.
  273. :type ui: GerberObjectUI
  274. :return: None
  275. """
  276. FlatCAMObj.set_ui(self, ui)
  277. FlatCAMApp.App.log.debug("FlatCAMGerber.set_ui()")
  278. self.form_fields.update({
  279. "plot": self.ui.plot_cb,
  280. "multicolored": self.ui.multicolored_cb,
  281. "solid": self.ui.solid_cb,
  282. "isotooldia": self.ui.iso_tool_dia_entry,
  283. "isopasses": self.ui.iso_width_entry,
  284. "isooverlap": self.ui.iso_overlap_entry,
  285. "combine_passes": self.ui.combine_passes_cb,
  286. "cutouttooldia": self.ui.cutout_tooldia_entry,
  287. "cutoutmargin": self.ui.cutout_margin_entry,
  288. "cutoutgapsize": self.ui.cutout_gap_entry,
  289. "gaps": self.ui.gaps_radio,
  290. "noncoppermargin": self.ui.noncopper_margin_entry,
  291. "noncopperrounded": self.ui.noncopper_rounded_cb,
  292. "bboxmargin": self.ui.bbmargin_entry,
  293. "bboxrounded": self.ui.bbrounded_cb
  294. })
  295. assert isinstance(self.ui, GerberObjectUI)
  296. self.ui.plot_cb.stateChanged.connect(self.on_plot_cb_click)
  297. self.ui.solid_cb.stateChanged.connect(self.on_solid_cb_click)
  298. self.ui.multicolored_cb.stateChanged.connect(self.on_multicolored_cb_click)
  299. self.ui.generate_iso_button.clicked.connect(self.on_iso_button_click)
  300. self.ui.generate_cutout_button.clicked.connect(self.on_generatecutout_button_click)
  301. self.ui.generate_bb_button.clicked.connect(self.on_generatebb_button_click)
  302. self.ui.generate_noncopper_button.clicked.connect(self.on_generatenoncopper_button_click)
  303. def on_generatenoncopper_button_click(self, *args):
  304. self.app.report_usage("gerber_on_generatenoncopper_button")
  305. self.read_form()
  306. name = self.options["name"] + "_noncopper"
  307. def geo_init(geo_obj, app_obj):
  308. assert isinstance(geo_obj, FlatCAMGeometry)
  309. bounding_box = self.solid_geometry.envelope.buffer(self.options["noncoppermargin"])
  310. if not self.options["noncopperrounded"]:
  311. bounding_box = bounding_box.envelope
  312. non_copper = bounding_box.difference(self.solid_geometry)
  313. geo_obj.solid_geometry = non_copper
  314. # TODO: Check for None
  315. self.app.new_object("geometry", name, geo_init)
  316. def on_generatebb_button_click(self, *args):
  317. self.app.report_usage("gerber_on_generatebb_button")
  318. self.read_form()
  319. name = self.options["name"] + "_bbox"
  320. def geo_init(geo_obj, app_obj):
  321. assert isinstance(geo_obj, FlatCAMGeometry)
  322. # Bounding box with rounded corners
  323. bounding_box = self.solid_geometry.envelope.buffer(self.options["bboxmargin"])
  324. if not self.options["bboxrounded"]: # Remove rounded corners
  325. bounding_box = bounding_box.envelope
  326. geo_obj.solid_geometry = bounding_box
  327. self.app.new_object("geometry", name, geo_init)
  328. def on_generatecutout_button_click(self, *args):
  329. self.app.report_usage("gerber_on_generatecutout_button")
  330. self.read_form()
  331. name = self.options["name"] + "_cutout"
  332. def geo_init(geo_obj, app_obj):
  333. margin = self.options["cutoutmargin"] + self.options["cutouttooldia"]/2
  334. gap_size = self.options["cutoutgapsize"] + self.options["cutouttooldia"]
  335. minx, miny, maxx, maxy = self.bounds()
  336. minx -= margin
  337. maxx += margin
  338. miny -= margin
  339. maxy += margin
  340. midx = 0.5 * (minx + maxx)
  341. midy = 0.5 * (miny + maxy)
  342. hgap = 0.5 * gap_size
  343. pts = [[midx - hgap, maxy],
  344. [minx, maxy],
  345. [minx, midy + hgap],
  346. [minx, midy - hgap],
  347. [minx, miny],
  348. [midx - hgap, miny],
  349. [midx + hgap, miny],
  350. [maxx, miny],
  351. [maxx, midy - hgap],
  352. [maxx, midy + hgap],
  353. [maxx, maxy],
  354. [midx + hgap, maxy]]
  355. cases = {"tb": [[pts[0], pts[1], pts[4], pts[5]],
  356. [pts[6], pts[7], pts[10], pts[11]]],
  357. "lr": [[pts[9], pts[10], pts[1], pts[2]],
  358. [pts[3], pts[4], pts[7], pts[8]]],
  359. "4": [[pts[0], pts[1], pts[2]],
  360. [pts[3], pts[4], pts[5]],
  361. [pts[6], pts[7], pts[8]],
  362. [pts[9], pts[10], pts[11]]]}
  363. cuts = cases[self.options['gaps']]
  364. geo_obj.solid_geometry = cascaded_union([LineString(segment) for segment in cuts])
  365. # TODO: Check for None
  366. self.app.new_object("geometry", name, geo_init)
  367. def on_iso_button_click(self, *args):
  368. self.app.report_usage("gerber_on_iso_button")
  369. self.read_form()
  370. self.isolate()
  371. def follow(self, outname=None):
  372. """
  373. Creates a geometry object "following" the gerber paths.
  374. :return: None
  375. """
  376. default_name = self.options["name"] + "_follow"
  377. follow_name = outname or default_name
  378. def follow_init(follow_obj, app_obj):
  379. # Propagate options
  380. follow_obj.options["cnctooldia"] = self.options["isotooldia"]
  381. follow_obj.solid_geometry = self.solid_geometry
  382. app_obj.info("Follow geometry created: %s" % follow_obj.options["name"])
  383. # TODO: Do something if this is None. Offer changing name?
  384. self.app.new_object("geometry", follow_name, follow_init)
  385. def isolate(self, dia=None, passes=None, overlap=None, outname=None, combine=None):
  386. """
  387. Creates an isolation routing geometry object in the project.
  388. :param dia: Tool diameter
  389. :param passes: Number of tool widths to cut
  390. :param overlap: Overlap between passes in fraction of tool diameter
  391. :param outname: Base name of the output object
  392. :return: None
  393. """
  394. if dia is None:
  395. dia = self.options["isotooldia"]
  396. if passes is None:
  397. passes = int(self.options["isopasses"])
  398. if overlap is None:
  399. overlap = self.options["isooverlap"]
  400. if combine is None:
  401. combine = self.options["combine_passes"]
  402. else:
  403. combine = bool(combine)
  404. base_name = self.options["name"] + "_iso"
  405. base_name = outname or base_name
  406. def generate_envelope(offset, invert):
  407. # isolation_geometry produces an envelope that is going on the left of the geometry
  408. # (the copper features). To leave the least amount of burrs on the features
  409. # the tool needs to travel on the right side of the features (this is called conventional milling)
  410. # the first pass is the one cutting all of the features, so it needs to be reversed
  411. # the other passes overlap preceding ones and cut the left over copper. It is better for them
  412. # to cut on the right side of the left over copper i.e on the left side of the features.
  413. geom = self.isolation_geometry(offset)
  414. if invert:
  415. if type(geom) is MultiPolygon:
  416. pl = []
  417. for p in geom:
  418. pl.append(Polygon(p.exterior.coords[::-1], p.interiors))
  419. geom = MultiPolygon(pl)
  420. elif type(geom) is Polygon:
  421. geom = Polygon(geom.exterior.coords[::-1], geom.interiors)
  422. else:
  423. raise "Unexpected Geometry"
  424. return geom
  425. if combine:
  426. iso_name = base_name
  427. # TODO: This is ugly. Create way to pass data into init function.
  428. def iso_init(geo_obj, app_obj):
  429. # Propagate options
  430. geo_obj.options["cnctooldia"] = self.options["isotooldia"]
  431. geo_obj.solid_geometry = []
  432. for i in range(passes):
  433. offset = (2 * i + 1) / 2.0 * dia - i * overlap * dia
  434. geom = generate_envelope (offset, i == 0)
  435. geo_obj.solid_geometry.append(geom)
  436. app_obj.info("Isolation geometry created: %s" % geo_obj.options["name"])
  437. # TODO: Do something if this is None. Offer changing name?
  438. self.app.new_object("geometry", iso_name, iso_init)
  439. else:
  440. for i in range(passes):
  441. offset = (2 * i + 1) / 2.0 * dia - i * overlap * dia
  442. if passes > 1:
  443. iso_name = base_name + str(i + 1)
  444. else:
  445. iso_name = base_name
  446. # TODO: This is ugly. Create way to pass data into init function.
  447. def iso_init(geo_obj, app_obj):
  448. # Propagate options
  449. geo_obj.options["cnctooldia"] = self.options["isotooldia"]
  450. geo_obj.solid_geometry = generate_envelope (offset, i == 0)
  451. app_obj.info("Isolation geometry created: %s" % geo_obj.options["name"])
  452. # TODO: Do something if this is None. Offer changing name?
  453. self.app.new_object("geometry", iso_name, iso_init)
  454. def on_plot_cb_click(self, *args):
  455. if self.muted_ui:
  456. return
  457. self.read_form_item('plot')
  458. self.plot()
  459. def on_solid_cb_click(self, *args):
  460. if self.muted_ui:
  461. return
  462. self.read_form_item('solid')
  463. self.plot()
  464. def on_multicolored_cb_click(self, *args):
  465. if self.muted_ui:
  466. return
  467. self.read_form_item('multicolored')
  468. self.plot()
  469. def convert_units(self, units):
  470. """
  471. Converts the units of the object by scaling dimensions in all geometry
  472. and options.
  473. :param units: Units to which to convert the object: "IN" or "MM".
  474. :type units: str
  475. :return: None
  476. :rtype: None
  477. """
  478. factor = Gerber.convert_units(self, units)
  479. self.options['isotooldia'] *= factor
  480. self.options['cutoutmargin'] *= factor
  481. self.options['cutoutgapsize'] *= factor
  482. self.options['noncoppermargin'] *= factor
  483. self.options['bboxmargin'] *= factor
  484. def plot(self):
  485. FlatCAMApp.App.log.debug(str(inspect.stack()[1][3]) + " --> FlatCAMGerber.plot()")
  486. # Does all the required setup and returns False
  487. # if the 'ptint' option is set to False.
  488. if not FlatCAMObj.plot(self):
  489. return
  490. geometry = self.solid_geometry
  491. # Make sure geometry is iterable.
  492. try:
  493. _ = iter(geometry)
  494. except TypeError:
  495. geometry = [geometry]
  496. if self.options["multicolored"]:
  497. linespec = '-'
  498. else:
  499. linespec = 'k-'
  500. if self.options["solid"]:
  501. for poly in geometry:
  502. # TODO: Too many things hardcoded.
  503. try:
  504. patch = PolygonPatch(poly,
  505. facecolor="#BBF268",
  506. edgecolor="#006E20",
  507. alpha=0.75,
  508. zorder=2)
  509. self.axes.add_patch(patch)
  510. except AssertionError:
  511. FlatCAMApp.App.log.warning("A geometry component was not a polygon:")
  512. FlatCAMApp.App.log.warning(str(poly))
  513. else:
  514. for poly in geometry:
  515. x, y = poly.exterior.xy
  516. self.axes.plot(x, y, linespec)
  517. for ints in poly.interiors:
  518. x, y = ints.coords.xy
  519. self.axes.plot(x, y, linespec)
  520. self.app.plotcanvas.auto_adjust_axes()
  521. def serialize(self):
  522. return {
  523. "options": self.options,
  524. "kind": self.kind
  525. }
  526. class FlatCAMExcellon(FlatCAMObj, Excellon):
  527. """
  528. Represents Excellon/Drill code.
  529. """
  530. ui_type = ExcellonObjectUI
  531. def __init__(self, name):
  532. Excellon.__init__(self)
  533. FlatCAMObj.__init__(self, name)
  534. self.kind = "excellon"
  535. self.options.update({
  536. "plot": True,
  537. "solid": False,
  538. "drillz": -0.1,
  539. "travelz": 0.1,
  540. "feedrate": 5.0,
  541. # "toolselection": ""
  542. "tooldia": 0.1,
  543. "toolchange": False,
  544. "toolchangez": 1.0,
  545. "spindlespeed": None
  546. })
  547. # TODO: Document this.
  548. self.tool_cbs = {}
  549. # Attributes to be included in serialization
  550. # Always append to it because it carries contents
  551. # from predecessors.
  552. self.ser_attrs += ['options', 'kind']
  553. @staticmethod
  554. def merge(exc_list, exc_final):
  555. """
  556. Merge excellons in exc_list into exc_final.
  557. Options are allways copied from source .
  558. Tools are also merged, if name for tool is same and size differs, then as name is used next available number from both lists
  559. if only one object is specified in exc_list then this acts as copy only
  560. :param exc_list: List or one object of FlatCAMExcellon Objects to join.
  561. :param exc_final: Destination FlatCAMExcellon object.
  562. :return: None
  563. """
  564. if type(exc_list) is not list:
  565. exc_list_real= list()
  566. exc_list_real.append(exc_list)
  567. else:
  568. exc_list_real=exc_list
  569. for exc in exc_list_real:
  570. # Expand lists
  571. if type(exc) is list:
  572. FlatCAMExcellon.merge(exc, exc_final)
  573. # If not list, merge excellons
  574. else:
  575. # TODO: I realize forms does not save values into options , when object is deselected
  576. # leave this here for future use
  577. # this reinitialize options based on forms, all steps may not be necessary
  578. # exc.app.collection.set_active(exc.options['name'])
  579. # exc.to_form()
  580. # exc.read_form()
  581. for option in exc.options:
  582. if option is not 'name':
  583. try:
  584. exc_final.options[option] = exc.options[option]
  585. except:
  586. exc.app.log.warning("Failed to copy option.",option)
  587. #deep copy of all drills,to avoid any references
  588. for drill in exc.drills:
  589. point = Point(drill['point'].x,drill['point'].y)
  590. exc_final.drills.append({"point": point, "tool": drill['tool']})
  591. toolsrework=dict()
  592. max_numeric_tool=0
  593. for toolname in exc.tools.iterkeys():
  594. numeric_tool=int(toolname)
  595. if numeric_tool>max_numeric_tool:
  596. max_numeric_tool=numeric_tool
  597. toolsrework[exc.tools[toolname]['C']]=toolname
  598. #exc_final as last because names from final tools will be used
  599. for toolname in exc_final.tools.iterkeys():
  600. numeric_tool=int(toolname)
  601. if numeric_tool>max_numeric_tool:
  602. max_numeric_tool=numeric_tool
  603. toolsrework[exc_final.tools[toolname]['C']]=toolname
  604. for toolvalues in toolsrework.iterkeys():
  605. if toolsrework[toolvalues] in exc_final.tools:
  606. if exc_final.tools[toolsrework[toolvalues]]!={"C": toolvalues}:
  607. exc_final.tools[str(max_numeric_tool+1)]={"C": toolvalues}
  608. else:
  609. exc_final.tools[toolsrework[toolvalues]]={"C": toolvalues}
  610. #this value was not co
  611. exc_final.zeros=exc.zeros
  612. exc_final.create_geometry()
  613. def build_ui(self):
  614. FlatCAMObj.build_ui(self)
  615. # Populate tool list
  616. n = len(self.tools)
  617. self.ui.tools_table.setColumnCount(2)
  618. self.ui.tools_table.setHorizontalHeaderLabels(['#', 'Diameter'])
  619. self.ui.tools_table.setRowCount(n)
  620. self.ui.tools_table.setSortingEnabled(False)
  621. i = 0
  622. for tool in self.tools:
  623. id = QtGui.QTableWidgetItem(tool)
  624. id.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
  625. self.ui.tools_table.setItem(i, 0, id) # Tool name/id
  626. dia = QtGui.QTableWidgetItem(str(self.tools[tool]['C']))
  627. dia.setFlags(QtCore.Qt.ItemIsEnabled)
  628. self.ui.tools_table.setItem(i, 1, dia) # Diameter
  629. i += 1
  630. # sort the tool diameter column
  631. self.ui.tools_table.sortItems(1)
  632. # all the tools are selected by default
  633. self.ui.tools_table.selectColumn(0)
  634. self.ui.tools_table.resizeColumnsToContents()
  635. self.ui.tools_table.resizeRowsToContents()
  636. self.ui.tools_table.horizontalHeader().setStretchLastSection(True)
  637. self.ui.tools_table.verticalHeader().hide()
  638. self.ui.tools_table.setSortingEnabled(True)
  639. def set_ui(self, ui):
  640. """
  641. Configures the user interface for this object.
  642. Connects options to form fields.
  643. :param ui: User interface object.
  644. :type ui: ExcellonObjectUI
  645. :return: None
  646. """
  647. FlatCAMObj.set_ui(self, ui)
  648. FlatCAMApp.App.log.debug("FlatCAMExcellon.set_ui()")
  649. self.form_fields.update({
  650. "plot": self.ui.plot_cb,
  651. "solid": self.ui.solid_cb,
  652. "drillz": self.ui.cutz_entry,
  653. "travelz": self.ui.travelz_entry,
  654. "feedrate": self.ui.feedrate_entry,
  655. "tooldia": self.ui.tooldia_entry,
  656. "toolchange": self.ui.toolchange_cb,
  657. "toolchangez": self.ui.toolchangez_entry,
  658. "spindlespeed": self.ui.spindlespeed_entry
  659. })
  660. assert isinstance(self.ui, ExcellonObjectUI), \
  661. "Expected a ExcellonObjectUI, got %s" % type(self.ui)
  662. self.ui.plot_cb.stateChanged.connect(self.on_plot_cb_click)
  663. self.ui.solid_cb.stateChanged.connect(self.on_solid_cb_click)
  664. self.ui.generate_cnc_button.clicked.connect(self.on_create_cncjob_button_click)
  665. self.ui.generate_milling_button.clicked.connect(self.on_generate_milling_button_click)
  666. def get_selected_tools_list(self):
  667. """
  668. Returns the keys to the self.tools dictionary corresponding
  669. to the selections on the tool list in the GUI.
  670. :return: List of tools.
  671. :rtype: list
  672. """
  673. return [str(x.text()) for x in self.ui.tools_table.selectedItems()]
  674. def generate_milling(self, tools=None, outname=None, tooldia=None):
  675. """
  676. Note: This method is a good template for generic operations as
  677. it takes it's options from parameters or otherwise from the
  678. object's options and returns a success, msg tuple as feedback
  679. for shell operations.
  680. :return: Success/failure condition tuple (bool, str).
  681. :rtype: tuple
  682. """
  683. # Get the tools from the list. These are keys
  684. # to self.tools
  685. if tools is None:
  686. tools = self.get_selected_tools_list()
  687. if outname is None:
  688. outname = self.options["name"] + "_mill"
  689. if tooldia is None:
  690. tooldia = self.options["tooldia"]
  691. if len(tools) == 0:
  692. self.app.inform.emit("Please select one or more tools from the list and try again.")
  693. return False, "Error: No tools."
  694. for tool in tools:
  695. if self.tools[tool]["C"] < tooldia:
  696. self.app.inform.emit("[warning] Milling tool is larger than hole size. Cancelled.")
  697. return False, "Error: Milling tool is larger than hole."
  698. def geo_init(geo_obj, app_obj):
  699. assert isinstance(geo_obj, FlatCAMGeometry), \
  700. "Initializer expected a FlatCAMGeometry, got %s" % type(geo_obj)
  701. app_obj.progress.emit(20)
  702. geo_obj.solid_geometry = []
  703. for hole in self.drills:
  704. if hole['tool'] in tools:
  705. geo_obj.solid_geometry.append(
  706. Point(hole['point']).buffer(self.tools[hole['tool']]["C"] / 2 -
  707. tooldia / 2).exterior
  708. )
  709. def geo_thread(app_obj):
  710. app_obj.new_object("geometry", outname, geo_init)
  711. app_obj.progress.emit(100)
  712. # Create a promise with the new name
  713. self.app.collection.promise(outname)
  714. # Send to worker
  715. self.app.worker_task.emit({'fcn': geo_thread, 'params': [self.app]})
  716. return True, ""
  717. def on_generate_milling_button_click(self, *args):
  718. self.app.report_usage("excellon_on_create_milling_button")
  719. self.read_form()
  720. self.generate_milling()
  721. def on_create_cncjob_button_click(self, *args):
  722. self.app.report_usage("excellon_on_create_cncjob_button")
  723. self.read_form()
  724. # Get the tools from the list
  725. tools = self.get_selected_tools_list()
  726. if len(tools) == 0:
  727. self.app.inform.emit("Please select one or more tools from the list and try again.")
  728. return
  729. job_name = self.options["name"] + "_cnc"
  730. # Object initialization function for app.new_object()
  731. def job_init(job_obj, app_obj):
  732. assert isinstance(job_obj, FlatCAMCNCjob), \
  733. "Initializer expected a FlatCAMCNCjob, got %s" % type(job_obj)
  734. app_obj.progress.emit(20)
  735. job_obj.z_cut = self.options["drillz"]
  736. job_obj.z_move = self.options["travelz"]
  737. job_obj.feedrate = self.options["feedrate"]
  738. job_obj.spindlespeed = self.options["spindlespeed"]
  739. # There could be more than one drill size...
  740. # job_obj.tooldia = # TODO: duplicate variable!
  741. # job_obj.options["tooldia"] =
  742. tools_csv = ','.join(tools)
  743. job_obj.generate_from_excellon_by_tool(self, tools_csv,
  744. toolchange=self.options["toolchange"],
  745. toolchangez=self.options["toolchangez"])
  746. app_obj.progress.emit(50)
  747. job_obj.gcode_parse()
  748. app_obj.progress.emit(60)
  749. job_obj.create_geometry()
  750. app_obj.progress.emit(80)
  751. # To be run in separate thread
  752. def job_thread(app_obj):
  753. app_obj.new_object("cncjob", job_name, job_init)
  754. app_obj.progress.emit(100)
  755. # Create promise for the new name.
  756. self.app.collection.promise(job_name)
  757. # Send to worker
  758. # self.app.worker.add_task(job_thread, [self.app])
  759. self.app.worker_task.emit({'fcn': job_thread, 'params': [self.app]})
  760. def on_plot_cb_click(self, *args):
  761. if self.muted_ui:
  762. return
  763. self.read_form_item('plot')
  764. self.plot()
  765. def on_solid_cb_click(self, *args):
  766. if self.muted_ui:
  767. return
  768. self.read_form_item('solid')
  769. self.plot()
  770. def convert_units(self, units):
  771. factor = Excellon.convert_units(self, units)
  772. self.options['drillz'] *= factor
  773. self.options['travelz'] *= factor
  774. self.options['feedrate'] *= factor
  775. def plot(self):
  776. # Does all the required setup and returns False
  777. # if the 'ptint' option is set to False.
  778. if not FlatCAMObj.plot(self):
  779. return
  780. try:
  781. _ = iter(self.solid_geometry)
  782. except TypeError:
  783. self.solid_geometry = [self.solid_geometry]
  784. # Plot excellon (All polygons?)
  785. if self.options["solid"]:
  786. for geo in self.solid_geometry:
  787. patch = PolygonPatch(geo,
  788. facecolor="#C40000",
  789. edgecolor="#750000",
  790. alpha=0.75,
  791. zorder=3)
  792. self.axes.add_patch(patch)
  793. else:
  794. for geo in self.solid_geometry:
  795. x, y = geo.exterior.coords.xy
  796. self.axes.plot(x, y, 'r-')
  797. for ints in geo.interiors:
  798. x, y = ints.coords.xy
  799. self.axes.plot(x, y, 'g-')
  800. self.app.plotcanvas.auto_adjust_axes()
  801. class FlatCAMCNCjob(FlatCAMObj, CNCjob):
  802. """
  803. Represents G-Code.
  804. """
  805. ui_type = CNCObjectUI
  806. def __init__(self, name, units="in", kind="generic", z_move=0.1,
  807. feedrate=3.0, z_cut=-0.002, tooldia=0.0,
  808. spindlespeed=None):
  809. FlatCAMApp.App.log.debug("Creating CNCJob object...")
  810. CNCjob.__init__(self, units=units, kind=kind, z_move=z_move,
  811. feedrate=feedrate, z_cut=z_cut, tooldia=tooldia,
  812. spindlespeed=spindlespeed)
  813. FlatCAMObj.__init__(self, name)
  814. self.kind = "cncjob"
  815. self.options.update({
  816. "plot": True,
  817. "tooldia": 0.4 / 25.4, # 0.4mm in inches
  818. "append": "",
  819. "prepend": "",
  820. "dwell": False,
  821. "dwelltime": 1
  822. })
  823. # Attributes to be included in serialization
  824. # Always append to it because it carries contents
  825. # from predecessors.
  826. self.ser_attrs += ['options', 'kind']
  827. def set_ui(self, ui):
  828. FlatCAMObj.set_ui(self, ui)
  829. FlatCAMApp.App.log.debug("FlatCAMCNCJob.set_ui()")
  830. assert isinstance(self.ui, CNCObjectUI), \
  831. "Expected a CNCObjectUI, got %s" % type(self.ui)
  832. self.form_fields.update({
  833. "plot": self.ui.plot_cb,
  834. "tooldia": self.ui.tooldia_entry,
  835. "append": self.ui.append_text,
  836. "prepend": self.ui.prepend_text,
  837. "dwell": self.ui.dwell_cb,
  838. "dwelltime": self.ui.dwelltime_entry
  839. })
  840. self.ui.plot_cb.stateChanged.connect(self.on_plot_cb_click)
  841. self.ui.updateplot_button.clicked.connect(self.on_updateplot_button_click)
  842. self.ui.export_gcode_button.clicked.connect(self.on_exportgcode_button_click)
  843. def on_updateplot_button_click(self, *args):
  844. """
  845. Callback for the "Updata Plot" button. Reads the form for updates
  846. and plots the object.
  847. """
  848. self.read_form()
  849. self.plot()
  850. def on_exportgcode_button_click(self, *args):
  851. self.app.report_usage("cncjob_on_exportgcode_button")
  852. self.read_form()
  853. try:
  854. filename = QtGui.QFileDialog.getSaveFileName(caption="Export G-Code ...",
  855. directory=self.app.defaults["last_folder"])
  856. except TypeError:
  857. filename = QtGui.QFileDialog.getSaveFileName(caption="Export G-Code ...")
  858. preamble = str(self.ui.prepend_text.get_value())
  859. postamble = str(self.ui.append_text.get_value())
  860. self.export_gcode(filename, preamble=preamble, postamble=postamble)
  861. def dwell_generator(self, lines):
  862. """
  863. Inserts "G4 P..." instructions after spindle-start
  864. instructions (M03 or M04).
  865. """
  866. log.debug("dwell_generator()...")
  867. m3m4re = re.compile(r'^\s*[mM]0[34]')
  868. g4re = re.compile(r'^\s*[gG]4\s+([\d\.\+\-e]+)')
  869. bufline = None
  870. for line in lines:
  871. # If the buffer contains a G4, yield that.
  872. # If current line is a G4, discard it.
  873. if bufline is not None:
  874. yield bufline
  875. bufline = None
  876. if not g4re.search(line):
  877. yield line
  878. continue
  879. # If start spindle, buffer a G4.
  880. if m3m4re.search(line):
  881. log.debug("Found M03/4")
  882. bufline = "G4 P{}\n".format(self.options['dwelltime'])
  883. yield line
  884. raise StopIteration
  885. def export_gcode(self, filename, preamble='', postamble=''):
  886. lines = StringIO(self.gcode)
  887. ## Post processing
  888. # Dwell?
  889. if self.options['dwell']:
  890. log.debug("Will add G04!")
  891. lines = self.dwell_generator(lines)
  892. ## Write
  893. with open(filename, 'w') as f:
  894. f.write(preamble + "\n")
  895. for line in lines:
  896. f.write(line)
  897. f.write(postamble)
  898. # Just for adding it to the recent files list.
  899. self.app.file_opened.emit("cncjob", filename)
  900. self.app.inform.emit("Saved to: " + filename)
  901. def get_gcode(self, preamble='', postamble=''):
  902. #we need this to beable get_gcode separatelly for shell command export_code
  903. return preamble + '\n' + self.gcode + "\n" + postamble
  904. def on_plot_cb_click(self, *args):
  905. if self.muted_ui:
  906. return
  907. self.read_form_item('plot')
  908. self.plot()
  909. def plot(self):
  910. # Does all the required setup and returns False
  911. # if the 'ptint' option is set to False.
  912. if not FlatCAMObj.plot(self):
  913. return
  914. self.plot2(self.axes, tooldia=self.options["tooldia"])
  915. self.app.plotcanvas.auto_adjust_axes()
  916. def convert_units(self, units):
  917. factor = CNCjob.convert_units(self, units)
  918. FlatCAMApp.App.log.debug("FlatCAMCNCjob.convert_units()")
  919. self.options["tooldia"] *= factor
  920. class FlatCAMGeometry(FlatCAMObj, Geometry):
  921. """
  922. Geometric object not associated with a specific
  923. format.
  924. """
  925. ui_type = GeometryObjectUI
  926. @staticmethod
  927. def merge(geo_list, geo_final):
  928. """
  929. Merges the geometry of objects in geo_list into
  930. the geometry of geo_final.
  931. :param geo_list: List of FlatCAMGeometry Objects to join.
  932. :param geo_final: Destination FlatCAMGeometry object.
  933. :return: None
  934. """
  935. if geo_final.solid_geometry is None:
  936. geo_final.solid_geometry = []
  937. if type(geo_final.solid_geometry) is not list:
  938. geo_final.solid_geometry = [geo_final.solid_geometry]
  939. for geo in geo_list:
  940. # Expand lists
  941. if type(geo) is list:
  942. FlatCAMGeometry.merge(geo, geo_final)
  943. # If not list, just append
  944. else:
  945. geo_final.solid_geometry.append(geo.solid_geometry)
  946. # try: # Iterable
  947. # for shape in geo.solid_geometry:
  948. # geo_final.solid_geometry.append(shape)
  949. #
  950. # except TypeError: # Non-iterable
  951. # geo_final.solid_geometry.append(geo.solid_geometry)
  952. def __init__(self, name):
  953. FlatCAMObj.__init__(self, name)
  954. Geometry.__init__(self)
  955. self.kind = "geometry"
  956. self.options.update({
  957. "plot": True,
  958. "cutz": -0.002,
  959. "travelz": 0.1,
  960. "feedrate": 5.0,
  961. "spindlespeed": None,
  962. "cnctooldia": 0.4 / 25.4,
  963. "painttooldia": 0.0625,
  964. "paintoverlap": 0.15,
  965. "paintmargin": 0.01,
  966. "paintmethod": "standard",
  967. "multidepth": False,
  968. "depthperpass": 0.002,
  969. "selectmethod": "single"
  970. })
  971. # Attributes to be included in serialization
  972. # Always append to it because it carries contents
  973. # from predecessors.
  974. self.ser_attrs += ['options', 'kind']
  975. def build_ui(self):
  976. FlatCAMObj.build_ui(self)
  977. def set_ui(self, ui):
  978. FlatCAMObj.set_ui(self, ui)
  979. FlatCAMApp.App.log.debug("FlatCAMGeometry.set_ui()")
  980. assert isinstance(self.ui, GeometryObjectUI), \
  981. "Expected a GeometryObjectUI, got %s" % type(self.ui)
  982. self.form_fields.update({
  983. "plot": self.ui.plot_cb,
  984. "cutz": self.ui.cutz_entry,
  985. "travelz": self.ui.travelz_entry,
  986. "feedrate": self.ui.cncfeedrate_entry,
  987. "spindlespeed": self.ui.cncspindlespeed_entry,
  988. "cnctooldia": self.ui.cnctooldia_entry,
  989. "painttooldia": self.ui.painttooldia_entry,
  990. "paintoverlap": self.ui.paintoverlap_entry,
  991. "paintmargin": self.ui.paintmargin_entry,
  992. "paintmethod": self.ui.paintmethod_combo,
  993. "multidepth": self.ui.mpass_cb,
  994. "depthperpass": self.ui.maxdepth_entry,
  995. "selectmethod": self.ui.selectmethod_combo
  996. })
  997. self.ui.plot_cb.stateChanged.connect(self.on_plot_cb_click)
  998. self.ui.generate_cnc_button.clicked.connect(self.on_generatecnc_button_click)
  999. self.ui.generate_paint_button.clicked.connect(self.on_paint_button_click)
  1000. def on_paint_button_click(self, *args):
  1001. self.app.report_usage("geometry_on_paint_button")
  1002. self.read_form()
  1003. tooldia = self.options["painttooldia"]
  1004. overlap = self.options["paintoverlap"]
  1005. if self.options["selectmethod"] == "all":
  1006. self.paint_poly_all(tooldia, overlap)
  1007. return
  1008. if self.options["selectmethod"] == "single":
  1009. self.app.info("Click inside the desired polygon.")
  1010. # To be called after clicking on the plot.
  1011. def doit(event):
  1012. self.app.info("Painting polygon...")
  1013. self.app.plotcanvas.mpl_disconnect(subscription)
  1014. point = [event.xdata, event.ydata]
  1015. self.paint_poly_single_click(point, tooldia, overlap)
  1016. subscription = self.app.plotcanvas.mpl_connect('button_press_event', doit)
  1017. def paint_poly_single_click(self, inside_pt, tooldia, overlap, outname=None):
  1018. """
  1019. Paints a polygon selected by clicking on its interior.
  1020. Note:
  1021. * The margin is taken directly from the form.
  1022. :param inside_pt: [x, y]
  1023. :param tooldia: Diameter of the painting tool
  1024. :param overlap: Overlap of the tool between passes.
  1025. :param outname: Name of the resulting Geometry Object.
  1026. :return: None
  1027. """
  1028. # Which polygon.
  1029. poly = self.find_polygon(inside_pt)
  1030. # No polygon?
  1031. if poly is None:
  1032. self.app.log.warning('No polygon found.')
  1033. self.app.inform.emit('[warning] No polygon found.')
  1034. return
  1035. proc = self.app.proc_container.new("Painting polygon.")
  1036. name = outname or self.options["name"] + "_paint"
  1037. # Initializes the new geometry object
  1038. def gen_paintarea(geo_obj, app_obj):
  1039. assert isinstance(geo_obj, FlatCAMGeometry), \
  1040. "Initializer expected a FlatCAMGeometry, got %s" % type(geo_obj)
  1041. #assert isinstance(app_obj, App)
  1042. if self.options["paintmethod"] == "seed":
  1043. cp = self.clear_polygon2(poly.buffer(-self.options["paintmargin"]),
  1044. tooldia, overlap=overlap)
  1045. else:
  1046. cp = self.clear_polygon(poly.buffer(-self.options["paintmargin"]),
  1047. tooldia, overlap=overlap)
  1048. geo_obj.solid_geometry = list(cp.get_objects())
  1049. geo_obj.options["cnctooldia"] = tooldia
  1050. # Experimental...
  1051. print "Indexing...",
  1052. geo_obj.make_index()
  1053. print "Done"
  1054. self.app.inform.emit("Done.")
  1055. def job_thread(app_obj):
  1056. try:
  1057. app_obj.new_object("geometry", name, gen_paintarea)
  1058. except Exception as e:
  1059. proc.done()
  1060. raise e
  1061. proc.done()
  1062. self.app.inform.emit("Polygon Paint started ...")
  1063. # Promise object with the new name
  1064. self.app.collection.promise(name)
  1065. # Background
  1066. self.app.worker_task.emit({'fcn': job_thread, 'params': [self.app]})
  1067. def paint_poly_all(self, tooldia, overlap, outname=None):
  1068. proc = self.app.proc_container.new("Painting polygon.")
  1069. name = outname or self.options["name"] + "_paint"
  1070. def recurse(geo):
  1071. try:
  1072. for subg in geo:
  1073. for subsubg in recurse(subg):
  1074. yield subsubg
  1075. except TypeError:
  1076. if isinstance(geo, Polygon):
  1077. yield geo
  1078. raise StopIteration
  1079. # Initializes the new geometry object
  1080. def gen_paintarea(geo_obj, app_obj):
  1081. assert isinstance(geo_obj, FlatCAMGeometry), \
  1082. "Initializer expected a FlatCAMGeometry, got %s" % type(geo_obj)
  1083. geo_obj.solid_geometry = []
  1084. for poly in recurse(self.solid_geometry):
  1085. if self.options["paintmethod"] == "seed":
  1086. cp = self.clear_polygon2(poly.buffer(-self.options["paintmargin"]),
  1087. tooldia, overlap=overlap)
  1088. else:
  1089. cp = self.clear_polygon(poly.buffer(-self.options["paintmargin"]),
  1090. tooldia, overlap=overlap)
  1091. geo_obj.solid_geometry += list(cp.get_objects())
  1092. geo_obj.options["cnctooldia"] = tooldia
  1093. # Experimental...
  1094. print "Indexing...",
  1095. geo_obj.make_index()
  1096. print "Done"
  1097. self.app.inform.emit("Done.")
  1098. def job_thread(app_obj):
  1099. try:
  1100. app_obj.new_object("geometry", name, gen_paintarea)
  1101. except Exception as e:
  1102. proc.done()
  1103. raise e
  1104. proc.done()
  1105. self.app.inform.emit("Polygon Paint started ...")
  1106. # Promise object with the new name
  1107. self.app.collection.promise(name)
  1108. # Background
  1109. self.app.worker_task.emit({'fcn': job_thread, 'params': [self.app]})
  1110. def on_generatecnc_button_click(self, *args):
  1111. self.app.report_usage("geometry_on_generatecnc_button")
  1112. self.read_form()
  1113. self.generatecncjob()
  1114. def generatecncjob(self,
  1115. z_cut=None,
  1116. z_move=None,
  1117. feedrate=None,
  1118. tooldia=None,
  1119. outname=None,
  1120. spindlespeed=None,
  1121. multidepth=None,
  1122. depthperpass=None,
  1123. use_thread=True):
  1124. """
  1125. Creates a CNCJob out of this Geometry object. The actual
  1126. work is done by the target FlatCAMCNCjob object's
  1127. `generate_from_geometry_2()` method.
  1128. :param z_cut: Cut depth (negative)
  1129. :param z_move: Hight of the tool when travelling (not cutting)
  1130. :param feedrate: Feed rate while cutting
  1131. :param tooldia: Tool diameter
  1132. :param outname: Name of the new object
  1133. :param spindlespeed: Spindle speed (RPM)
  1134. :return: None
  1135. """
  1136. outname = outname if outname is not None else self.options["name"] + "_cnc"
  1137. z_cut = z_cut if z_cut is not None else self.options["cutz"]
  1138. z_move = z_move if z_move is not None else self.options["travelz"]
  1139. feedrate = feedrate if feedrate is not None else self.options["feedrate"]
  1140. tooldia = tooldia if tooldia is not None else self.options["cnctooldia"]
  1141. multidepth = multidepth if multidepth is not None else self.options["multidepth"]
  1142. depthperpass = depthperpass if depthperpass is not None else self.options["depthperpass"]
  1143. # To allow default value to be "" (optional in gui) and translate to None
  1144. # if not isinstance(spindlespeed, int):
  1145. # if isinstance(self.options["spindlespeed"], int) or \
  1146. # isinstance(self.options["spindlespeed"], float):
  1147. # spindlespeed = int(self.options["spindlespeed"])
  1148. # else:
  1149. # spindlespeed = None
  1150. if spindlespeed is None:
  1151. # int or None.
  1152. spindlespeed = self.options['spindlespeed']
  1153. # Object initialization function for app.new_object()
  1154. # RUNNING ON SEPARATE THREAD!
  1155. def job_init(job_obj, app_obj):
  1156. assert isinstance(job_obj, FlatCAMCNCjob), \
  1157. "Initializer expected a FlatCAMCNCjob, got %s" % type(job_obj)
  1158. # Propagate options
  1159. job_obj.options["tooldia"] = tooldia
  1160. app_obj.progress.emit(20)
  1161. job_obj.z_cut = z_cut
  1162. job_obj.z_move = z_move
  1163. job_obj.feedrate = feedrate
  1164. job_obj.spindlespeed = spindlespeed
  1165. app_obj.progress.emit(40)
  1166. # TODO: The tolerance should not be hard coded. Just for testing.
  1167. job_obj.generate_from_geometry_2(self,
  1168. multidepth=multidepth,
  1169. depthpercut=depthperpass,
  1170. tolerance=0.0005)
  1171. app_obj.progress.emit(50)
  1172. job_obj.gcode_parse()
  1173. app_obj.progress.emit(80)
  1174. if use_thread:
  1175. # To be run in separate thread
  1176. def job_thread(app_obj):
  1177. with self.app.proc_container.new("Generating CNC Job."):
  1178. app_obj.new_object("cncjob", outname, job_init)
  1179. app_obj.inform.emit("CNCjob created: %s" % outname)
  1180. app_obj.progress.emit(100)
  1181. # Create a promise with the name
  1182. self.app.collection.promise(outname)
  1183. # Send to worker
  1184. self.app.worker_task.emit({'fcn': job_thread, 'params': [self.app]})
  1185. else:
  1186. self.app.new_object("cncjob", outname, job_init)
  1187. def on_plot_cb_click(self, *args): # TODO: args not needed
  1188. if self.muted_ui:
  1189. return
  1190. self.read_form_item('plot')
  1191. self.plot()
  1192. def scale(self, factor):
  1193. """
  1194. Scales all geometry by a given factor.
  1195. :param factor: Factor by which to scale the object's geometry/
  1196. :type factor: float
  1197. :return: None
  1198. :rtype: None
  1199. """
  1200. if type(self.solid_geometry) == list:
  1201. self.solid_geometry = [affinity.scale(g, factor, factor, origin=(0, 0))
  1202. for g in self.solid_geometry]
  1203. else:
  1204. self.solid_geometry = affinity.scale(self.solid_geometry, factor, factor,
  1205. origin=(0, 0))
  1206. def offset(self, vect):
  1207. """
  1208. Offsets all geometry by a given vector/
  1209. :param vect: (x, y) vector by which to offset the object's geometry.
  1210. :type vect: tuple
  1211. :return: None
  1212. :rtype: None
  1213. """
  1214. dx, dy = vect
  1215. def translate_recursion(geom):
  1216. if type(geom) == list:
  1217. geoms=list()
  1218. for local_geom in geom:
  1219. geoms.append(translate_recursion(local_geom))
  1220. return geoms
  1221. else:
  1222. return affinity.translate(geom, xoff=dx, yoff=dy)
  1223. self.solid_geometry=translate_recursion(self.solid_geometry)
  1224. def convert_units(self, units):
  1225. factor = Geometry.convert_units(self, units)
  1226. self.options['cutz'] *= factor
  1227. self.options['travelz'] *= factor
  1228. self.options['feedrate'] *= factor
  1229. self.options['cnctooldia'] *= factor
  1230. self.options['painttooldia'] *= factor
  1231. self.options['paintmargin'] *= factor
  1232. return factor
  1233. def plot_element(self, element):
  1234. try:
  1235. for sub_el in element:
  1236. self.plot_element(sub_el)
  1237. except TypeError: # Element is not iterable...
  1238. if type(element) == Polygon:
  1239. x, y = element.exterior.coords.xy
  1240. self.axes.plot(x, y, 'r-')
  1241. for ints in element.interiors:
  1242. x, y = ints.coords.xy
  1243. self.axes.plot(x, y, 'r-')
  1244. return
  1245. if type(element) == LineString or type(element) == LinearRing:
  1246. x, y = element.coords.xy
  1247. self.axes.plot(x, y, 'r-')
  1248. return
  1249. FlatCAMApp.App.log.warning("Did not plot:" + str(type(element)))
  1250. def plot(self):
  1251. """
  1252. Plots the object into its axes. If None, of if the axes
  1253. are not part of the app's figure, it fetches new ones.
  1254. :return: None
  1255. """
  1256. # Does all the required setup and returns False
  1257. # if the 'ptint' option is set to False.
  1258. if not FlatCAMObj.plot(self):
  1259. return
  1260. # Make sure solid_geometry is iterable.
  1261. # TODO: This method should not modify the object !!!
  1262. # try:
  1263. # _ = iter(self.solid_geometry)
  1264. # except TypeError:
  1265. # if self.solid_geometry is None:
  1266. # self.solid_geometry = []
  1267. # else:
  1268. # self.solid_geometry = [self.solid_geometry]
  1269. #
  1270. # for geo in self.solid_geometry:
  1271. #
  1272. # if type(geo) == Polygon:
  1273. # x, y = geo.exterior.coords.xy
  1274. # self.axes.plot(x, y, 'r-')
  1275. # for ints in geo.interiors:
  1276. # x, y = ints.coords.xy
  1277. # self.axes.plot(x, y, 'r-')
  1278. # continue
  1279. #
  1280. # if type(geo) == LineString or type(geo) == LinearRing:
  1281. # x, y = geo.coords.xy
  1282. # self.axes.plot(x, y, 'r-')
  1283. # continue
  1284. #
  1285. # if type(geo) == MultiPolygon:
  1286. # for poly in geo:
  1287. # x, y = poly.exterior.coords.xy
  1288. # self.axes.plot(x, y, 'r-')
  1289. # for ints in poly.interiors:
  1290. # x, y = ints.coords.xy
  1291. # self.axes.plot(x, y, 'r-')
  1292. # continue
  1293. #
  1294. # FlatCAMApp.App.log.warning("Did not plot:", str(type(geo)))
  1295. self.plot_element(self.solid_geometry)
  1296. self.app.plotcanvas.auto_adjust_axes()