FlatCAMApp.py 151 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059
  1. import sys
  2. import urllib
  3. import getopt
  4. import random
  5. import logging
  6. import simplejson as json
  7. import re
  8. import webbrowser
  9. import os
  10. import Tkinter
  11. from PyQt4 import QtCore
  12. import time # Just used for debugging. Double check before removing.
  13. from contextlib import contextmanager
  14. ########################################
  15. ## Imports part of FlatCAM ##
  16. ########################################
  17. from FlatCAMWorker import Worker
  18. from ObjectCollection import *
  19. from FlatCAMObj import *
  20. from PlotCanvas import *
  21. from FlatCAMGUI import *
  22. from FlatCAMCommon import LoudDict
  23. from FlatCAMShell import FCShell
  24. from FlatCAMDraw import FlatCAMDraw
  25. from FlatCAMProcess import *
  26. from MeasurementTool import Measurement
  27. from DblSidedTool import DblSidedTool
  28. from xml.dom.minidom import parseString as parse_xml_string
  29. import tclCommands
  30. ########################################
  31. ## App ##
  32. ########################################
  33. class App(QtCore.QObject):
  34. """
  35. The main application class. The constructor starts the GUI.
  36. """
  37. ## Get Cmd Line Options
  38. cmd_line_shellfile = ''
  39. cmd_line_help = "FlatCam.py --shellfile=<cmd_line_shellfile>"
  40. try:
  41. cmd_line_options, args = getopt.getopt(sys.argv[1:], "h:", "shellfile=")
  42. except getopt.GetoptError:
  43. print cmd_line_help
  44. sys.exit(2)
  45. for opt, arg in cmd_line_options:
  46. if opt == '-h':
  47. print cmd_line_help
  48. sys.exit()
  49. elif opt == '--shellfile':
  50. cmd_line_shellfile = arg
  51. ## Logging ##
  52. log = logging.getLogger('base')
  53. log.setLevel(logging.DEBUG)
  54. # log.setLevel(logging.WARNING)
  55. formatter = logging.Formatter('[%(levelname)s][%(threadName)s] %(message)s')
  56. handler = logging.StreamHandler()
  57. handler.setFormatter(formatter)
  58. log.addHandler(handler)
  59. ## Version
  60. version = 8.4
  61. version_date = "2015/10"
  62. ## URL for update checks and statistics
  63. version_url = "http://flatcam.org/version"
  64. ## App URL
  65. app_url = "http://flatcam.org"
  66. ## Manual URL
  67. manual_url = "http://flatcam.org/manual/index.html"
  68. ##################
  69. ## Signals ##
  70. ##################
  71. # Inform the user
  72. # Handled by:
  73. # * App.info() --> Print on the status bar
  74. inform = QtCore.pyqtSignal(str)
  75. # General purpose background task
  76. worker_task = QtCore.pyqtSignal(dict)
  77. # File opened
  78. # Handled by:
  79. # * register_folder()
  80. # * register_recent()
  81. file_opened = QtCore.pyqtSignal(str, str) # File type and filename
  82. progress = QtCore.pyqtSignal(int) # Percentage of progress
  83. plots_updated = QtCore.pyqtSignal()
  84. # Emitted by new_object() and passes the new object as argument.
  85. # on_object_created() adds the object to the collection,
  86. # and emits new_object_available.
  87. object_created = QtCore.pyqtSignal(object)
  88. # Emitted when a new object has been added to the collection
  89. # and is ready to be used.
  90. new_object_available = QtCore.pyqtSignal(object)
  91. # Emmited when shell command is finished(one command only)
  92. shell_command_finished = QtCore.pyqtSignal(object)
  93. # Emitted when an unhandled exception happens
  94. # in the worker task.
  95. thread_exception = QtCore.pyqtSignal(object)
  96. message = QtCore.pyqtSignal(str, str, str)
  97. def __init__(self, user_defaults=True, post_gui=None):
  98. """
  99. Starts the application.
  100. :return: app
  101. :rtype: App
  102. """
  103. App.log.info("FlatCAM Starting...")
  104. ###################
  105. ### OS-specific ###
  106. ###################
  107. if sys.platform == 'win32':
  108. from win32com.shell import shell, shellcon
  109. App.log.debug("Win32!")
  110. self.data_path = shell.SHGetFolderPath(0, shellcon.CSIDL_APPDATA, None, 0) + \
  111. '/FlatCAM'
  112. self.os = 'windows'
  113. else: # Linux/Unix/MacOS
  114. self.data_path = os.path.expanduser('~') + \
  115. '/.FlatCAM'
  116. self.os = 'unix'
  117. ###############################
  118. ### Setup folders and files ###
  119. ###############################
  120. if not os.path.exists(self.data_path):
  121. os.makedirs(self.data_path)
  122. App.log.debug('Created data folder: ' + self.data_path)
  123. try:
  124. f = open(self.data_path + '/defaults.json')
  125. f.close()
  126. except IOError:
  127. App.log.debug('Creating empty defaults.json')
  128. f = open(self.data_path + '/defaults.json', 'w')
  129. json.dump({}, f)
  130. f.close()
  131. try:
  132. f = open(self.data_path + '/recent.json')
  133. f.close()
  134. except IOError:
  135. App.log.debug('Creating empty recent.json')
  136. f = open(self.data_path + '/recent.json', 'w')
  137. json.dump([], f)
  138. f.close()
  139. # Application directory. Chdir to it. Otherwise, trying to load
  140. # GUI icons will fail as thir path is relative.
  141. # This will fail under cx_freeze ...
  142. self.app_home = os.path.dirname(os.path.realpath(__file__))
  143. App.log.debug("Application path is " + self.app_home)
  144. App.log.debug("Started in " + os.getcwd())
  145. os.chdir(self.app_home)
  146. ####################
  147. ## Initialize GUI ##
  148. ####################
  149. QtCore.QObject.__init__(self)
  150. self.ui = FlatCAMGUI(self.version)
  151. self.connect(self.ui,
  152. QtCore.SIGNAL("geomUpdate(int, int, int, int)"),
  153. self.save_geometry)
  154. #### Plot Area ####
  155. # self.plotcanvas = PlotCanvas(self.ui.splitter)
  156. self.plotcanvas = PlotCanvas(self.ui.right_layout, self)
  157. self.plotcanvas.mpl_connect('button_press_event', self.on_click_over_plot)
  158. self.plotcanvas.mpl_connect('motion_notify_event', self.on_mouse_move_over_plot)
  159. self.plotcanvas.mpl_connect('key_press_event', self.on_key_over_plot)
  160. self.ui.splitter.setStretchFactor(1, 2)
  161. ##############
  162. #### Data ####
  163. ##############
  164. self.recent = []
  165. self.clipboard = QtGui.QApplication.clipboard()
  166. self.proc_container = FCVisibleProcessContainer(self.ui.activity_view)
  167. self.project_filename = None
  168. self.toggle_units_ignore = False
  169. self.defaults_form = GlobalOptionsUI()
  170. self.defaults_form_fields = {
  171. "units": self.defaults_form.units_radio,
  172. "gerber_plot": self.defaults_form.gerber_group.plot_cb,
  173. "gerber_solid": self.defaults_form.gerber_group.solid_cb,
  174. "gerber_multicolored": self.defaults_form.gerber_group.multicolored_cb,
  175. "gerber_isotooldia": self.defaults_form.gerber_group.iso_tool_dia_entry,
  176. "gerber_isopasses": self.defaults_form.gerber_group.iso_width_entry,
  177. "gerber_isooverlap": self.defaults_form.gerber_group.iso_overlap_entry,
  178. "gerber_combine_passes": self.defaults_form.gerber_group.combine_passes_cb,
  179. "gerber_cutouttooldia": self.defaults_form.gerber_group.cutout_tooldia_entry,
  180. "gerber_cutoutmargin": self.defaults_form.gerber_group.cutout_margin_entry,
  181. "gerber_cutoutgapsize": self.defaults_form.gerber_group.cutout_gap_entry,
  182. "gerber_gaps": self.defaults_form.gerber_group.gaps_radio,
  183. "gerber_noncoppermargin": self.defaults_form.gerber_group.noncopper_margin_entry,
  184. "gerber_noncopperrounded": self.defaults_form.gerber_group.noncopper_rounded_cb,
  185. "gerber_bboxmargin": self.defaults_form.gerber_group.bbmargin_entry,
  186. "gerber_bboxrounded": self.defaults_form.gerber_group.bbrounded_cb,
  187. "excellon_plot": self.defaults_form.excellon_group.plot_cb,
  188. "excellon_solid": self.defaults_form.excellon_group.solid_cb,
  189. "excellon_drillz": self.defaults_form.excellon_group.cutz_entry,
  190. "excellon_travelz": self.defaults_form.excellon_group.travelz_entry,
  191. "excellon_feedrate": self.defaults_form.excellon_group.feedrate_entry,
  192. "excellon_spindlespeed": self.defaults_form.excellon_group.spindlespeed_entry,
  193. "excellon_toolchangez": self.defaults_form.excellon_group.toolchangez_entry,
  194. "geometry_plot": self.defaults_form.geometry_group.plot_cb,
  195. "geometry_cutz": self.defaults_form.geometry_group.cutz_entry,
  196. "geometry_travelz": self.defaults_form.geometry_group.travelz_entry,
  197. "geometry_feedrate": self.defaults_form.geometry_group.cncfeedrate_entry,
  198. "geometry_cnctooldia": self.defaults_form.geometry_group.cnctooldia_entry,
  199. "geometry_painttooldia": self.defaults_form.geometry_group.painttooldia_entry,
  200. "geometry_spindlespeed": self.defaults_form.geometry_group.cncspindlespeed_entry,
  201. "geometry_paintoverlap": self.defaults_form.geometry_group.paintoverlap_entry,
  202. "geometry_paintmargin": self.defaults_form.geometry_group.paintmargin_entry,
  203. "cncjob_plot": self.defaults_form.cncjob_group.plot_cb,
  204. "cncjob_tooldia": self.defaults_form.cncjob_group.tooldia_entry,
  205. "cncjob_prepend": self.defaults_form.cncjob_group.prepend_text,
  206. "cncjob_append": self.defaults_form.cncjob_group.append_text
  207. }
  208. self.defaults = LoudDict()
  209. self.defaults.set_change_callback(self.on_defaults_dict_change) # When the dictionary changes.
  210. self.defaults.update({
  211. "serial": 0,
  212. "stats": {},
  213. "units": "IN",
  214. "gerber_plot": True,
  215. "gerber_solid": True,
  216. "gerber_multicolored": False,
  217. "gerber_isotooldia": 0.016,
  218. "gerber_isopasses": 1,
  219. "gerber_isooverlap": 0.15,
  220. "gerber_cutouttooldia": 0.07,
  221. "gerber_cutoutmargin": 0.1,
  222. "gerber_cutoutgapsize": 0.15,
  223. "gerber_gaps": "4",
  224. "gerber_noncoppermargin": 0.0,
  225. "gerber_noncopperrounded": False,
  226. "gerber_bboxmargin": 0.0,
  227. "gerber_bboxrounded": False,
  228. "excellon_plot": True,
  229. "excellon_solid": False,
  230. "excellon_drillz": -0.1,
  231. "excellon_travelz": 0.1,
  232. "excellon_feedrate": 3.0,
  233. "excellon_spindlespeed": None,
  234. "excellon_toolchangez": 1.0,
  235. "geometry_plot": True,
  236. "geometry_cutz": -0.002,
  237. "geometry_travelz": 0.1,
  238. "geometry_feedrate": 3.0,
  239. "geometry_cnctooldia": 0.016,
  240. "geometry_spindlespeed": None,
  241. "geometry_painttooldia": 0.07,
  242. "geometry_paintoverlap": 0.15,
  243. "geometry_paintmargin": 0.0,
  244. "cncjob_plot": True,
  245. "cncjob_tooldia": 0.016,
  246. "cncjob_prepend": "",
  247. "cncjob_append": "",
  248. # Persistence
  249. "last_folder": None,
  250. # Default window geometry
  251. "def_win_x": 100,
  252. "def_win_y": 100,
  253. "def_win_w": 1024,
  254. "def_win_h": 650,
  255. # Constants...
  256. "defaults_save_period_ms": 20000, # Time between default saves.
  257. "shell_shape": [500, 300], # Shape of the shell in pixels.
  258. "shell_at_startup": False, # Show the shell at startup.
  259. "recent_limit": 10, # Max. items in recent list.
  260. "fit_key": '1',
  261. "zoom_out_key": '2',
  262. "zoom_in_key": '3',
  263. "zoom_ratio": 1.5,
  264. "point_clipboard_format": "(%.4f, %.4f)",
  265. "zdownrate": None,
  266. "excellon_zeros": "L",
  267. "gerber_use_buffer_for_union": True,
  268. "cncjob_coordinate_format": "X%.4fY%.4f"
  269. })
  270. ###############################
  271. ### Load defaults from file ###
  272. if user_defaults:
  273. self.load_defaults()
  274. chars = 'abcdefghijklmnopqrstuvwxyz0123456789'
  275. if self.defaults['serial'] == 0 or len(str(self.defaults['serial'])) < 10:
  276. self.defaults['serial'] = ''.join([random.choice(chars) for i in range(20)])
  277. self.save_defaults(silent=True)
  278. self.propagate_defaults()
  279. self.restore_main_win_geom()
  280. def auto_save_defaults():
  281. try:
  282. self.save_defaults(silent=True)
  283. finally:
  284. QtCore.QTimer.singleShot(self.defaults["defaults_save_period_ms"], auto_save_defaults)
  285. if user_defaults:
  286. QtCore.QTimer.singleShot(self.defaults["defaults_save_period_ms"], auto_save_defaults)
  287. self.options_form = GlobalOptionsUI()
  288. self.options_form_fields = {
  289. "units": self.options_form.units_radio,
  290. "gerber_plot": self.options_form.gerber_group.plot_cb,
  291. "gerber_solid": self.options_form.gerber_group.solid_cb,
  292. "gerber_multicolored": self.options_form.gerber_group.multicolored_cb,
  293. "gerber_isotooldia": self.options_form.gerber_group.iso_tool_dia_entry,
  294. "gerber_isopasses": self.options_form.gerber_group.iso_width_entry,
  295. "gerber_isooverlap": self.options_form.gerber_group.iso_overlap_entry,
  296. "gerber_combine_passes": self.options_form.gerber_group.combine_passes_cb,
  297. "gerber_cutouttooldia": self.options_form.gerber_group.cutout_tooldia_entry,
  298. "gerber_cutoutmargin": self.options_form.gerber_group.cutout_margin_entry,
  299. "gerber_cutoutgapsize": self.options_form.gerber_group.cutout_gap_entry,
  300. "gerber_gaps": self.options_form.gerber_group.gaps_radio,
  301. "gerber_noncoppermargin": self.options_form.gerber_group.noncopper_margin_entry,
  302. "gerber_noncopperrounded": self.options_form.gerber_group.noncopper_rounded_cb,
  303. "gerber_bboxmargin": self.options_form.gerber_group.bbmargin_entry,
  304. "gerber_bboxrounded": self.options_form.gerber_group.bbrounded_cb,
  305. "excellon_plot": self.options_form.excellon_group.plot_cb,
  306. "excellon_solid": self.options_form.excellon_group.solid_cb,
  307. "excellon_drillz": self.options_form.excellon_group.cutz_entry,
  308. "excellon_travelz": self.options_form.excellon_group.travelz_entry,
  309. "excellon_feedrate": self.options_form.excellon_group.feedrate_entry,
  310. "excellon_spindlespeed": self.options_form.excellon_group.spindlespeed_entry,
  311. "excellon_toolchangez": self.options_form.excellon_group.toolchangez_entry,
  312. "geometry_plot": self.options_form.geometry_group.plot_cb,
  313. "geometry_cutz": self.options_form.geometry_group.cutz_entry,
  314. "geometry_travelz": self.options_form.geometry_group.travelz_entry,
  315. "geometry_feedrate": self.options_form.geometry_group.cncfeedrate_entry,
  316. "geometry_spindlespeed": self.options_form.geometry_group.cncspindlespeed_entry,
  317. "geometry_cnctooldia": self.options_form.geometry_group.cnctooldia_entry,
  318. "geometry_painttooldia": self.options_form.geometry_group.painttooldia_entry,
  319. "geometry_paintoverlap": self.options_form.geometry_group.paintoverlap_entry,
  320. "geometry_paintmargin": self.options_form.geometry_group.paintmargin_entry,
  321. "cncjob_plot": self.options_form.cncjob_group.plot_cb,
  322. "cncjob_tooldia": self.options_form.cncjob_group.tooldia_entry,
  323. "cncjob_prepend": self.options_form.cncjob_group.prepend_text,
  324. "cncjob_append": self.options_form.cncjob_group.append_text
  325. }
  326. self.options = LoudDict()
  327. self.options.set_change_callback(self.on_options_dict_change)
  328. self.options.update({
  329. "units": "IN",
  330. "gerber_plot": True,
  331. "gerber_solid": True,
  332. "gerber_multicolored": False,
  333. "gerber_isotooldia": 0.016,
  334. "gerber_isopasses": 1,
  335. "gerber_isooverlap": 0.15,
  336. "gerber_combine_passes": True,
  337. "gerber_cutouttooldia": 0.07,
  338. "gerber_cutoutmargin": 0.1,
  339. "gerber_cutoutgapsize": 0.15,
  340. "gerber_gaps": "4",
  341. "gerber_noncoppermargin": 0.0,
  342. "gerber_noncopperrounded": False,
  343. "gerber_bboxmargin": 0.0,
  344. "gerber_bboxrounded": False,
  345. "excellon_plot": True,
  346. "excellon_solid": False,
  347. "excellon_drillz": -0.1,
  348. "excellon_travelz": 0.1,
  349. "excellon_feedrate": 3.0,
  350. "excellon_spindlespeed": None,
  351. "excellon_toolchangez": 1.0,
  352. "geometry_plot": True,
  353. "geometry_cutz": -0.002,
  354. "geometry_travelz": 0.1,
  355. "geometry_feedrate": 3.0,
  356. "geometry_spindlespeed": None,
  357. "geometry_cnctooldia": 0.016,
  358. "geometry_painttooldia": 0.07,
  359. "geometry_paintoverlap": 0.15,
  360. "geometry_paintmargin": 0.0,
  361. "cncjob_plot": True,
  362. "cncjob_tooldia": 0.016,
  363. "cncjob_prepend": "",
  364. "cncjob_append": ""
  365. })
  366. self.options.update(self.defaults) # Copy app defaults to project options
  367. #self.options_write_form()
  368. self.on_options_combo_change(0) # Will show the initial form
  369. self.collection = ObjectCollection()
  370. self.ui.project_tab_layout.addWidget(self.collection.view)
  371. #### End of Data ####
  372. #### Worker ####
  373. App.log.info("Starting Worker...")
  374. self.worker = Worker(self)
  375. self.thr1 = QtCore.QThread()
  376. self.worker.moveToThread(self.thr1)
  377. self.connect(self.thr1, QtCore.SIGNAL("started()"), self.worker.run)
  378. self.thr1.start()
  379. #### Check for updates ####
  380. # Separate thread (Not worker)
  381. App.log.info("Checking for updates in backgroud (this is version %s)." % str(self.version))
  382. self.worker2 = Worker(self, name="worker2")
  383. self.thr2 = QtCore.QThread()
  384. self.worker2.moveToThread(self.thr2)
  385. self.connect(self.thr2, QtCore.SIGNAL("started()"), self.worker2.run)
  386. self.connect(self.thr2, QtCore.SIGNAL("started()"),
  387. lambda: self.worker_task.emit({'fcn': self.version_check,
  388. 'params': [],
  389. 'worker_name': "worker2"}))
  390. self.thr2.start()
  391. ### Signal handling ###
  392. ## Custom signals
  393. self.inform.connect(self.info)
  394. self.message.connect(self.message_dialog)
  395. self.progress.connect(self.set_progress_bar)
  396. self.object_created.connect(self.on_object_created)
  397. self.plots_updated.connect(self.on_plots_updated)
  398. self.file_opened.connect(self.register_recent)
  399. self.file_opened.connect(lambda kind, filename: self.register_folder(filename))
  400. ## Standard signals
  401. # Menu
  402. self.ui.menufilenew.triggered.connect(self.on_file_new)
  403. self.ui.menufileopengerber.triggered.connect(self.on_fileopengerber)
  404. self.ui.menufileopenexcellon.triggered.connect(self.on_fileopenexcellon)
  405. self.ui.menufileopengcode.triggered.connect(self.on_fileopengcode)
  406. self.ui.menufileopenproject.triggered.connect(self.on_file_openproject)
  407. self.ui.menufileimportsvg.triggered.connect(self.on_file_importsvg)
  408. self.ui.menufileexportsvg.triggered.connect(self.on_file_exportsvg)
  409. self.ui.menufilesaveproject.triggered.connect(self.on_file_saveproject)
  410. self.ui.menufilesaveprojectas.triggered.connect(self.on_file_saveprojectas)
  411. self.ui.menufilesaveprojectcopy.triggered.connect(lambda: self.on_file_saveprojectas(make_copy=True))
  412. self.ui.menufilesavedefaults.triggered.connect(self.on_file_savedefaults)
  413. self.ui.menueditnew.triggered.connect(lambda: self.new_object('geometry', 'New Geometry', lambda x, y: None))
  414. self.ui.menueditedit.triggered.connect(self.edit_geometry)
  415. self.ui.menueditok.triggered.connect(self.editor2geometry)
  416. self.ui.menueditjoin.triggered.connect(self.on_edit_join)
  417. self.ui.menueditdelete.triggered.connect(self.on_delete)
  418. self.ui.menuoptions_transfer_a2o.triggered.connect(self.on_options_app2object)
  419. self.ui.menuoptions_transfer_a2p.triggered.connect(self.on_options_app2project)
  420. self.ui.menuoptions_transfer_o2a.triggered.connect(self.on_options_object2app)
  421. self.ui.menuoptions_transfer_p2a.triggered.connect(self.on_options_project2app)
  422. self.ui.menuoptions_transfer_o2p.triggered.connect(self.on_options_object2project)
  423. self.ui.menuoptions_transfer_p2o.triggered.connect(self.on_options_project2object)
  424. self.ui.menuviewdisableall.triggered.connect(self.disable_plots)
  425. self.ui.menuviewdisableother.triggered.connect(lambda: self.disable_plots(except_current=True))
  426. self.ui.menuviewenable.triggered.connect(self.enable_all_plots)
  427. self.ui.menutoolshell.triggered.connect(lambda: self.shell.show())
  428. self.ui.menuhelp_about.triggered.connect(self.on_about)
  429. self.ui.menuhelp_home.triggered.connect(lambda: webbrowser.open(self.app_url))
  430. self.ui.menuhelp_manual.triggered.connect(lambda: webbrowser.open(self.manual_url))
  431. # Toolbar
  432. self.ui.zoom_fit_btn.triggered.connect(self.on_zoom_fit)
  433. self.ui.zoom_in_btn.triggered.connect(lambda: self.plotcanvas.zoom(1.5))
  434. self.ui.zoom_out_btn.triggered.connect(lambda: self.plotcanvas.zoom(1 / 1.5))
  435. self.ui.clear_plot_btn.triggered.connect(self.plotcanvas.clear)
  436. self.ui.replot_btn.triggered.connect(self.on_toolbar_replot)
  437. self.ui.newgeo_btn.triggered.connect(lambda: self.new_object('geometry', 'New Geometry', lambda x, y: None))
  438. self.ui.editgeo_btn.triggered.connect(self.edit_geometry)
  439. self.ui.updategeo_btn.triggered.connect(self.editor2geometry)
  440. self.ui.delete_btn.triggered.connect(self.on_delete)
  441. self.ui.shell_btn.triggered.connect(lambda: self.shell.show())
  442. # Object list
  443. self.collection.view.activated.connect(self.on_row_activated)
  444. # Options
  445. self.ui.options_combo.activated.connect(self.on_options_combo_change)
  446. self.options_form.units_radio.group_toggle_fn = self.on_toggle_units
  447. ####################
  448. ### Other setups ###
  449. ####################
  450. # Sets up FlatCAMObj, FCProcess and FCProcessContainer.
  451. self.setup_obj_classes()
  452. self.setup_recent_items()
  453. self.setup_component_editor()
  454. #########################
  455. ### Tools and Plugins ###
  456. #########################
  457. self.dblsidedtool = DblSidedTool(self)
  458. self.dblsidedtool.install()
  459. self.measeurement_tool = Measurement(self)
  460. self.measeurement_tool.install()
  461. self.draw = FlatCAMDraw(self, disabled=True)
  462. #############
  463. ### Shell ###
  464. #############
  465. # TODO: Move this to its own class
  466. self.shell = FCShell(self)
  467. self.shell.setWindowIcon(self.ui.app_icon)
  468. self.shell.setWindowTitle("FlatCAM Shell")
  469. if self.defaults["shell_at_startup"]:
  470. self.shell.show()
  471. self.shell.resize(*self.defaults["shell_shape"])
  472. self.shell.append_output("FlatCAM %s\n(c) 2014-2015 Juan Pablo Caram\n\n" % self.version)
  473. self.shell.append_output("Type help to get started.\n\n")
  474. self.init_tcl()
  475. if self.cmd_line_shellfile:
  476. try:
  477. with open(self.cmd_line_shellfile, "r") as myfile:
  478. cmd_line_shellfile_text = myfile.read()
  479. self.shell._sysShell.exec_command(cmd_line_shellfile_text)
  480. except Exception as ext:
  481. print "ERROR: ", ext
  482. sys.exit(2)
  483. # Post-GUI initialization: Experimental attempt
  484. # to perform unit tests on the GUI.
  485. if post_gui is not None:
  486. post_gui(self)
  487. App.log.debug("END of constructor. Releasing control.")
  488. def init_tcl(self):
  489. if hasattr(self,'tcl'):
  490. # self.tcl = None
  491. # TODO we need to clean non default variables and procedures here
  492. # new object cannot be used here as it will not remember values created for next passes,
  493. # because tcl was execudted in old instance of TCL
  494. pass
  495. else:
  496. self.tcl = Tkinter.Tcl()
  497. self.setup_shell()
  498. def defaults_read_form(self):
  499. for option in self.defaults_form_fields:
  500. self.defaults[option] = self.defaults_form_fields[option].get_value()
  501. def defaults_write_form(self):
  502. for option in self.defaults:
  503. self.defaults_write_form_field(option)
  504. # try:
  505. # self.defaults_form_fields[option].set_value(self.defaults[option])
  506. # except KeyError:
  507. # #self.log.debug("defaults_write_form(): No field for: %s" % option)
  508. # # TODO: Rethink this?
  509. # pass
  510. def defaults_write_form_field(self, field):
  511. try:
  512. self.defaults_form_fields[field].set_value(self.defaults[field])
  513. except KeyError:
  514. #self.log.debug("defaults_write_form(): No field for: %s" % option)
  515. # TODO: Rethink this?
  516. pass
  517. def disable_plots(self, except_current=False):
  518. """
  519. Disables all plots with exception of the current object if specified.
  520. :param except_current: Wether to skip the current object.
  521. :rtype except_current: boolean
  522. :return: None
  523. """
  524. # TODO: This method is very similar to replot_all. Try to merge.
  525. self.progress.emit(10)
  526. def worker_task(app_obj):
  527. percentage = 0.1
  528. try:
  529. delta = 0.9 / len(self.collection.get_list())
  530. except ZeroDivisionError:
  531. self.progress.emit(0)
  532. return
  533. for obj in self.collection.get_list():
  534. if obj != self.collection.get_active() or not except_current:
  535. obj.options['plot'] = False
  536. obj.plot()
  537. percentage += delta
  538. self.progress.emit(int(percentage*100))
  539. self.progress.emit(0)
  540. self.plots_updated.emit()
  541. # Send to worker
  542. self.worker_task.emit({'fcn': worker_task, 'params': [self]})
  543. def edit_geometry(self):
  544. """
  545. Send the current geometry object (if any) into the editor.
  546. :return: None
  547. """
  548. if not isinstance(self.collection.get_active(), FlatCAMGeometry):
  549. self.info("Select a Geometry Object to edit.")
  550. return
  551. self.ui.updategeo_btn.setEnabled(True)
  552. self.draw.edit_fcgeometry(self.collection.get_active())
  553. def editor2geometry(self):
  554. """
  555. Transfers the geometry in the editor to the current geometry object.
  556. :return: None
  557. """
  558. geo = self.collection.get_active()
  559. if not isinstance(geo, FlatCAMGeometry):
  560. self.info("Select a Geometry Object to update.")
  561. return
  562. self.draw.update_fcgeometry(geo)
  563. self.draw.deactivate()
  564. self.ui.updategeo_btn.setEnabled(False)
  565. geo.plot()
  566. def get_last_folder(self):
  567. return self.defaults["last_folder"]
  568. def report_usage(self, resource):
  569. """
  570. Increments usage counter for the given resource
  571. in self.defaults['stats'].
  572. :param resource: Name of the resource.
  573. :return: None
  574. """
  575. if resource in self.defaults['stats']:
  576. self.defaults['stats'][resource] += 1
  577. else:
  578. self.defaults['stats'][resource] = 1
  579. class TclErrorException(Exception):
  580. """
  581. this exception is deffined here, to be able catch it if we sucessfully handle all errors from shell command
  582. """
  583. pass
  584. def raise_tcl_unknown_error(self, unknownException):
  585. """
  586. raise Exception if is different type than TclErrorException
  587. :param unknownException:
  588. :return:
  589. """
  590. if not isinstance(unknownException, self.TclErrorException):
  591. self.raise_tcl_error("Unknown error: %s" % str(unknownException))
  592. else:
  593. raise unknownException
  594. def raise_tcl_error(self, text):
  595. """
  596. this method pass exception from python into TCL as error, so we get stacktrace and reason
  597. :param text: text of error
  598. :return: raise exception
  599. """
  600. self.tcl.eval('return -code error "%s"' % text)
  601. raise self.TclErrorException(text)
  602. def exec_command(self, text):
  603. """
  604. Handles input from the shell. See FlatCAMApp.setup_shell for shell commands.
  605. Also handles execution in separated threads
  606. :param text:
  607. :return: output if there was any
  608. """
  609. self.report_usage('exec_command')
  610. result = self.exec_command_test(text, False)
  611. return result
  612. def exec_command_test(self, text, reraise=True):
  613. """
  614. Handles input from the shell. See FlatCAMApp.setup_shell for shell commands.
  615. :param text: Input command
  616. :param reraise: raise exception and not hide it, used mainly in unittests
  617. :return: output if there was any
  618. """
  619. text = str(text)
  620. try:
  621. self.shell.open_proccessing()
  622. result = self.tcl.eval(str(text))
  623. if result!='None':
  624. self.shell.append_output(result + '\n')
  625. except Tkinter.TclError, e:
  626. #this will display more precise answer if something in TCL shell fail
  627. result = self.tcl.eval("set errorInfo")
  628. self.log.error("Exec command Exception: %s" % (result + '\n'))
  629. self.shell.append_error('ERROR: ' + result + '\n')
  630. #show error in console and just return or in test raise exception
  631. if reraise:
  632. raise e
  633. finally:
  634. self.shell.close_proccessing()
  635. pass
  636. return result
  637. """
  638. Code below is unsused. Saved for later.
  639. """
  640. parts = re.findall(r'([\w\\:\.]+|".*?")+', text)
  641. parts = [p.replace('\n', '').replace('"', '') for p in parts]
  642. self.log.debug(parts)
  643. try:
  644. if parts[0] not in commands:
  645. self.shell.append_error("Unknown command\n")
  646. return
  647. #import inspect
  648. #inspect.getargspec(someMethod)
  649. if (type(commands[parts[0]]["params"]) is not list and len(parts)-1 != commands[parts[0]]["params"]) or \
  650. (type(commands[parts[0]]["params"]) is list and len(parts)-1 not in commands[parts[0]]["params"]):
  651. self.shell.append_error(
  652. "Command %s takes %d arguments. %d given.\n" %
  653. (parts[0], commands[parts[0]]["params"], len(parts)-1)
  654. )
  655. return
  656. cmdfcn = commands[parts[0]]["fcn"]
  657. cmdconv = commands[parts[0]]["converters"]
  658. if len(parts) - 1 > 0:
  659. retval = cmdfcn(*[cmdconv[i](parts[i + 1]) for i in range(len(parts)-1)])
  660. else:
  661. retval = cmdfcn()
  662. retfcn = commands[parts[0]]["retfcn"]
  663. if retval and retfcn(retval):
  664. self.shell.append_output(retfcn(retval) + "\n")
  665. except Exception, e:
  666. #self.shell.append_error(''.join(traceback.format_exc()))
  667. #self.shell.append_error("?\n")
  668. self.shell.append_error(str(e) + "\n")
  669. def info(self, msg):
  670. """
  671. Writes on the status bar.
  672. :param msg: Text to write.
  673. :return: None
  674. """
  675. match = re.search("\[([^\]]+)\](.*)", msg)
  676. if match:
  677. self.ui.fcinfo.set_status(QtCore.QString(match.group(2)), level=match.group(1))
  678. else:
  679. self.ui.fcinfo.set_status(QtCore.QString(msg), level="info")
  680. def load_defaults(self):
  681. """
  682. Loads the aplication's default settings from defaults.json into
  683. ``self.defaults``.
  684. :return: None
  685. """
  686. try:
  687. f = open(self.data_path + "/defaults.json")
  688. options = f.read()
  689. f.close()
  690. except IOError:
  691. self.log.error("Could not load defaults file.")
  692. self.inform.emit("ERROR: Could not load defaults file.")
  693. return
  694. try:
  695. defaults = json.loads(options)
  696. except:
  697. e = sys.exc_info()[0]
  698. App.log.error(str(e))
  699. self.inform.emit("ERROR: Failed to parse defaults file.")
  700. return
  701. self.defaults.update(defaults)
  702. def save_geometry(self, x, y, width, height):
  703. self.defaults["def_win_x"] = x
  704. self.defaults["def_win_y"] = y
  705. self.defaults["def_win_w"] = width
  706. self.defaults["def_win_h"] = height
  707. self.save_defaults()
  708. def message_dialog(self, title, message, kind="info"):
  709. icon = {"info": QtGui.QMessageBox.Information,
  710. "warning": QtGui.QMessageBox.Warning,
  711. "error": QtGui.QMessageBox.Critical}[str(kind)]
  712. dlg = QtGui.QMessageBox(icon, title, message, parent=self.ui)
  713. dlg.setText(message)
  714. dlg.exec_()
  715. def register_recent(self, kind, filename):
  716. self.log.debug("register_recent()")
  717. self.log.debug(" %s" % kind)
  718. self.log.debug(" %s" % filename)
  719. record = {'kind': str(kind), 'filename': str(filename)}
  720. if record in self.recent:
  721. return
  722. self.recent.insert(0, record)
  723. if len(self.recent) > self.defaults['recent_limit']: # Limit reached
  724. self.recent.pop()
  725. try:
  726. f = open(self.data_path + '/recent.json', 'w')
  727. except IOError:
  728. App.log.error("Failed to open recent items file for writing.")
  729. self.inform.emit('Failed to open recent files file for writing.')
  730. return
  731. #try:
  732. json.dump(self.recent, f)
  733. # except:
  734. # App.log.error("Failed to write to recent items file.")
  735. # self.inform.emit('ERROR: Failed to write to recent items file.')
  736. # f.close()
  737. f.close()
  738. # Re-buid the recent items menu
  739. self.setup_recent_items()
  740. def new_object(self, kind, name, initialize, active=True, fit=True, plot=True):
  741. """
  742. Creates a new specalized FlatCAMObj and attaches it to the application,
  743. this is, updates the GUI accordingly, any other records and plots it.
  744. This method is thread-safe.
  745. :param kind: The kind of object to create. One of 'gerber',
  746. 'excellon', 'cncjob' and 'geometry'.
  747. :type kind: str
  748. :param name: Name for the object.
  749. :type name: str
  750. :param initialize: Function to run after creation of the object
  751. but before it is attached to the application. The function is
  752. called with 2 parameters: the new object and the App instance.
  753. :type initialize: function
  754. :return: None
  755. :rtype: None
  756. """
  757. App.log.debug("new_object()")
  758. t0 = time.time() # Debug
  759. ### Check for existing name
  760. # while name in self.collection.get_names():
  761. # ## Create a new name
  762. # # Ends with number?
  763. # App.log.debug("new_object(): Object name (%s) exists, changing." % name)
  764. # match = re.search(r'(.*[^\d])?(\d+)$', name)
  765. # if match: # Yes: Increment the number!
  766. # base = match.group(1) or ''
  767. # num = int(match.group(2))
  768. # name = base + str(num + 1)
  769. # else: # No: add a number!
  770. # name += "_1"
  771. ## Create object
  772. classdict = {
  773. "gerber": FlatCAMGerber,
  774. "excellon": FlatCAMExcellon,
  775. "cncjob": FlatCAMCNCjob,
  776. "geometry": FlatCAMGeometry
  777. }
  778. App.log.debug("Calling object constructor...")
  779. obj = classdict[kind](name)
  780. obj.units = self.options["units"] # TODO: The constructor should look at defaults.
  781. # Set default options from self.options
  782. for option in self.options:
  783. if option.find(kind + "_") == 0:
  784. oname = option[len(kind) + 1:]
  785. obj.options[oname] = self.options[option]
  786. # Initialize as per user request
  787. # User must take care to implement initialize
  788. # in a thread-safe way as is is likely that we
  789. # have been invoked in a separate thread.
  790. t1 = time.time()
  791. self.log.debug("%f seconds before initialize()." % (t1 - t0))
  792. initialize(obj, self)
  793. t2 = time.time()
  794. self.log.debug("%f seconds executing initialize()." % (t2 - t1))
  795. # Check units and convert if necessary
  796. # This condition CAN be true because initialize() can change obj.units
  797. if self.options["units"].upper() != obj.units.upper():
  798. self.inform.emit("Converting units to " + self.options["units"] + ".")
  799. obj.convert_units(self.options["units"])
  800. t3 = time.time()
  801. self.log.debug("%f seconds converting units." % (t3 - t2))
  802. FlatCAMApp.App.log.debug("Moving new object back to main thread.")
  803. # Move the object to the main thread and let the app know that it is available.
  804. obj.moveToThread(QtGui.QApplication.instance().thread())
  805. self.object_created.emit(obj)
  806. return obj
  807. def options_read_form(self):
  808. for option in self.options_form_fields:
  809. self.options[option] = self.options_form_fields[option].get_value()
  810. def options_write_form(self):
  811. for option in self.options:
  812. self.options_write_form_field(option)
  813. def options_write_form_field(self, field):
  814. try:
  815. self.options_form_fields[field].set_value(self.options[field])
  816. except KeyError:
  817. # Changed from error to debug. This allows to have data stored
  818. # which is not user-editable.
  819. self.log.debug("options_write_form_field(): No field for: %s" % field)
  820. def on_about(self):
  821. """
  822. Displays the "about" dialog.
  823. :return: None
  824. """
  825. self.report_usage("on_about")
  826. version = self.version
  827. version_date = self.version_date
  828. class AboutDialog(QtGui.QDialog):
  829. def __init__(self, parent=None):
  830. QtGui.QDialog.__init__(self, parent)
  831. # Icon and title
  832. self.setWindowIcon(parent.app_icon)
  833. self.setWindowTitle("FlatCAM")
  834. layout1 = QtGui.QVBoxLayout()
  835. self.setLayout(layout1)
  836. layout2 = QtGui.QHBoxLayout()
  837. layout1.addLayout(layout2)
  838. logo = QtGui.QLabel()
  839. logo.setPixmap(QtGui.QPixmap('share/flatcam_icon256.png'))
  840. layout2.addWidget(logo, stretch=0)
  841. title = QtGui.QLabel(
  842. "<font size=8><B>FlatCAM</B></font><BR>"
  843. "Version %s (%s)<BR>"
  844. "<BR>"
  845. "2D Computer-Aided Printed Circuit Board<BR>"
  846. "Manufacturing.<BR>"
  847. "<BR>"
  848. "(c) 2014-2015 Juan Pablo Caram" % (version, version_date)
  849. )
  850. layout2.addWidget(title, stretch=1)
  851. layout3 = QtGui.QHBoxLayout()
  852. layout1.addLayout(layout3)
  853. layout3.addStretch()
  854. okbtn = QtGui.QPushButton("Close")
  855. layout3.addWidget(okbtn)
  856. okbtn.clicked.connect(self.accept)
  857. AboutDialog(self.ui).exec_()
  858. def on_file_savedefaults(self):
  859. """
  860. Callback for menu item File->Save Defaults. Saves application default options
  861. ``self.defaults`` to defaults.json.
  862. :return: None
  863. """
  864. self.save_defaults()
  865. def save_defaults(self, silent=False):
  866. """
  867. Saves application default options
  868. ``self.defaults`` to defaults.json.
  869. :return: None
  870. """
  871. self.report_usage("save_defaults")
  872. ## Read options from file ##
  873. try:
  874. f = open(self.data_path + "/defaults.json")
  875. options = f.read()
  876. f.close()
  877. except:
  878. e = sys.exc_info()[0]
  879. App.log.error("Could not load defaults file.")
  880. App.log.error(str(e))
  881. self.inform.emit("[error] Could not load defaults file.")
  882. return
  883. try:
  884. defaults = json.loads(options)
  885. except:
  886. e = sys.exc_info()[0]
  887. App.log.error("Failed to parse defaults file.")
  888. App.log.error(str(e))
  889. self.inform.emit("[error] Failed to parse defaults file.")
  890. return
  891. # Update options
  892. self.defaults_read_form()
  893. defaults.update(self.defaults)
  894. # Save update options
  895. try:
  896. f = open(self.data_path + "/defaults.json", "w")
  897. json.dump(defaults, f)
  898. f.close()
  899. except:
  900. self.inform.emit("[error] Failed to write defaults to file.")
  901. return
  902. if not silent:
  903. self.inform.emit("Defaults saved.")
  904. def on_edit_join(self):
  905. """
  906. Callback for Edit->Join. Joins the selected geometry objects into
  907. a new one.
  908. :return: None
  909. """
  910. objs = self.collection.get_selected()
  911. def initialize(obj, app):
  912. FlatCAMGeometry.merge(objs, obj)
  913. self.new_object("geometry", "Combo", initialize)
  914. def on_options_app2project(self):
  915. """
  916. Callback for Options->Transfer Options->App=>Project. Copies options
  917. from application defaults to project defaults.
  918. :return: None
  919. """
  920. self.report_usage("on_options_app2project")
  921. self.defaults_read_form()
  922. self.options.update(self.defaults)
  923. self.options_write_form()
  924. def on_options_project2app(self):
  925. """
  926. Callback for Options->Transfer Options->Project=>App. Copies options
  927. from project defaults to application defaults.
  928. :return: None
  929. """
  930. self.report_usage("on_options_project2app")
  931. self.options_read_form()
  932. self.defaults.update(self.options)
  933. self.defaults_write_form()
  934. def on_options_project2object(self):
  935. """
  936. Callback for Options->Transfer Options->Project=>Object. Copies options
  937. from project defaults to the currently selected object.
  938. :return: None
  939. """
  940. self.report_usage("on_options_project2object")
  941. self.options_read_form()
  942. obj = self.collection.get_active()
  943. if obj is None:
  944. self.inform.emit("WARNING: No object selected.")
  945. return
  946. for option in self.options:
  947. if option.find(obj.kind + "_") == 0:
  948. oname = option[len(obj.kind)+1:]
  949. obj.options[oname] = self.options[option]
  950. obj.to_form() # Update UI
  951. def on_options_object2project(self):
  952. """
  953. Callback for Options->Transfer Options->Object=>Project. Copies options
  954. from the currently selected object to project defaults.
  955. :return: None
  956. """
  957. self.report_usage("on_options_object2project")
  958. obj = self.collection.get_active()
  959. if obj is None:
  960. self.inform.emit("WARNING: No object selected.")
  961. return
  962. obj.read_form()
  963. for option in obj.options:
  964. if option in ['name']: # TODO: Handle this better...
  965. continue
  966. self.options[obj.kind + "_" + option] = obj.options[option]
  967. self.options_write_form()
  968. def on_options_object2app(self):
  969. """
  970. Callback for Options->Transfer Options->Object=>App. Copies options
  971. from the currently selected object to application defaults.
  972. :return: None
  973. """
  974. self.report_usage("on_options_object2app")
  975. obj = self.collection.get_active()
  976. if obj is None:
  977. self.inform.emit("WARNING: No object selected.")
  978. return
  979. obj.read_form()
  980. for option in obj.options:
  981. if option in ['name']: # TODO: Handle this better...
  982. continue
  983. self.defaults[obj.kind + "_" + option] = obj.options[option]
  984. self.defaults_write_form()
  985. def on_options_app2object(self):
  986. """
  987. Callback for Options->Transfer Options->App=>Object. Copies options
  988. from application defaults to the currently selected object.
  989. :return: None
  990. """
  991. self.report_usage("on_options_app2object")
  992. self.defaults_read_form()
  993. obj = self.collection.get_active()
  994. if obj is None:
  995. self.inform.emit("WARNING: No object selected.")
  996. return
  997. for option in self.defaults:
  998. if option.find(obj.kind + "_") == 0:
  999. oname = option[len(obj.kind)+1:]
  1000. obj.options[oname] = self.defaults[option]
  1001. obj.to_form() # Update UI
  1002. def on_options_dict_change(self, field):
  1003. self.options_write_form_field(field)
  1004. if field == "units":
  1005. self.set_screen_units(self.options['units'])
  1006. def on_defaults_dict_change(self, field):
  1007. self.defaults_write_form_field(field)
  1008. def set_screen_units(self, units):
  1009. self.ui.units_label.setText("[" + self.options["units"].lower() + "]")
  1010. def on_toggle_units(self):
  1011. """
  1012. Callback for the Units radio-button change in the Options tab.
  1013. Changes the application's default units or the current project's units.
  1014. If changing the project's units, the change propagates to all of
  1015. the objects in the project.
  1016. :return: None
  1017. """
  1018. self.report_usage("on_toggle_units")
  1019. if self.toggle_units_ignore:
  1020. return
  1021. # If option is the same, then ignore
  1022. if self.options_form.units_radio.get_value().upper() == self.options['units'].upper():
  1023. self.log.debug("on_toggle_units(): Same as options, so ignoring.")
  1024. return
  1025. # Options to scale
  1026. dimensions = ['gerber_isotooldia', 'gerber_cutoutmargin', 'gerber_cutoutgapsize',
  1027. 'gerber_noncoppermargin', 'gerber_bboxmargin', 'excellon_drillz',
  1028. 'excellon_travelz', 'excellon_feedrate', 'excellon_toolchangez', 'cncjob_tooldia',
  1029. 'geometry_cutz', 'geometry_travelz', 'geometry_feedrate',
  1030. 'geometry_cnctooldia', 'geometry_painttooldia', 'geometry_paintoverlap',
  1031. 'geometry_paintmargin']
  1032. def scale_options(sfactor):
  1033. for dim in dimensions:
  1034. self.options[dim] *= sfactor
  1035. # The scaling factor depending on choice of units.
  1036. factor = 1/25.4
  1037. if self.options_form.units_radio.get_value().upper() == 'MM':
  1038. factor = 25.4
  1039. # Changing project units. Warn user.
  1040. msgbox = QtGui.QMessageBox()
  1041. msgbox.setText("<B>Change project units ...</B>")
  1042. msgbox.setInformativeText("Changing the units of the project causes all geometrical "
  1043. "properties of all objects to be scaled accordingly. Continue?")
  1044. msgbox.setStandardButtons(QtGui.QMessageBox.Cancel | QtGui.QMessageBox.Ok)
  1045. msgbox.setDefaultButton(QtGui.QMessageBox.Ok)
  1046. response = msgbox.exec_()
  1047. if response == QtGui.QMessageBox.Ok:
  1048. self.options_read_form()
  1049. scale_options(factor)
  1050. self.options_write_form()
  1051. for obj in self.collection.get_list():
  1052. units = self.options_form.units_radio.get_value().upper()
  1053. obj.convert_units(units)
  1054. current = self.collection.get_active()
  1055. if current is not None:
  1056. current.to_form()
  1057. self.plot_all()
  1058. else:
  1059. # Undo toggling
  1060. self.toggle_units_ignore = True
  1061. if self.options_form.units_radio.get_value().upper() == 'MM':
  1062. self.options_form.units_radio.set_value('IN')
  1063. else:
  1064. self.options_form.units_radio.set_value('MM')
  1065. self.toggle_units_ignore = False
  1066. self.options_read_form()
  1067. self.inform.emit("Converted units to %s" % self.options["units"])
  1068. #self.ui.units_label.setText("[" + self.options["units"] + "]")
  1069. self.set_screen_units(self.options["units"])
  1070. def on_options_combo_change(self, sel):
  1071. """
  1072. Called when the combo box to choose between application defaults and
  1073. project option changes value. The corresponding variables are
  1074. copied to the UI.
  1075. :param sel: The option index that was chosen.
  1076. :return: None
  1077. """
  1078. # combo_sel = self.ui.notebook.combo_options.get_active()
  1079. App.log.debug("Options --> %s" % sel)
  1080. # Remove anything else in the box
  1081. # box_children = self.options_box.get_children()
  1082. # box_children = self.ui.notebook.options_contents.get_children()
  1083. # for child in box_children:
  1084. # self.ui.notebook.options_contents.remove(child)
  1085. # try:
  1086. # self.ui.options_area.removeWidget(self.defaults_form)
  1087. # except:
  1088. # pass
  1089. #
  1090. # try:
  1091. # self.ui.options_area.removeWidget(self.options_form)
  1092. # except:
  1093. # pass
  1094. form = [self.defaults_form, self.options_form][sel]
  1095. # self.ui.notebook.options_contents.pack_start(form, False, False, 1)
  1096. try:
  1097. self.ui.options_scroll_area.takeWidget()
  1098. except:
  1099. self.log.debug("Nothing to remove")
  1100. self.ui.options_scroll_area.setWidget(form)
  1101. form.show()
  1102. # self.options2form()
  1103. def on_delete(self):
  1104. """
  1105. Delete the currently selected FlatCAMObjs.
  1106. :return: None
  1107. """
  1108. self.log.debug("on_delete()")
  1109. self.report_usage("on_delete")
  1110. while (self.collection.get_active()):
  1111. self.delete_first_selected()
  1112. def delete_first_selected(self):
  1113. # Keep this for later
  1114. try:
  1115. name = self.collection.get_active().options["name"]
  1116. except AttributeError:
  1117. self.log.debug("Nothing selected for deletion")
  1118. return
  1119. # Remove plot
  1120. self.plotcanvas.figure.delaxes(self.collection.get_active().axes)
  1121. self.plotcanvas.auto_adjust_axes()
  1122. # Clear form
  1123. self.setup_component_editor()
  1124. # Remove from dictionary
  1125. self.collection.delete_active()
  1126. self.inform.emit("Object deleted: %s" % name)
  1127. def on_plots_updated(self):
  1128. """
  1129. Callback used to report when the plots have changed.
  1130. Adjust axes and zooms to fit.
  1131. :return: None
  1132. """
  1133. self.plotcanvas.auto_adjust_axes()
  1134. self.on_zoom_fit(None)
  1135. def on_toolbar_replot(self):
  1136. """
  1137. Callback for toolbar button. Re-plots all objects.
  1138. :return: None
  1139. """
  1140. self.report_usage("on_toolbar_replot")
  1141. self.log.debug("on_toolbar_replot()")
  1142. try:
  1143. self.collection.get_active().read_form()
  1144. except AttributeError:
  1145. self.log.debug("on_toolbar_replot(): AttributeError")
  1146. pass
  1147. self.plot_all()
  1148. def on_row_activated(self, index):
  1149. self.ui.notebook.setCurrentWidget(self.ui.selected_tab)
  1150. def on_object_created(self, obj):
  1151. """
  1152. Event callback for object creation.
  1153. :param obj: The newly created FlatCAM object.
  1154. :return: None
  1155. """
  1156. t0 = time.time() # DEBUG
  1157. self.log.debug("on_object_created()")
  1158. # The Collection might change the name if there is a collision
  1159. self.collection.append(obj)
  1160. self.inform.emit("Object (%s) created: %s" % (obj.kind, obj.options['name']))
  1161. self.new_object_available.emit(obj)
  1162. obj.plot()
  1163. self.on_zoom_fit(None)
  1164. t1 = time.time() # DEBUG
  1165. self.log.debug("%f seconds adding object and plotting." % (t1 - t0))
  1166. def on_zoom_fit(self, event):
  1167. """
  1168. Callback for zoom-out request. This can be either from the corresponding
  1169. toolbar button or the '1' key when the canvas is focused. Calls ``self.adjust_axes()``
  1170. with axes limits from the geometry bounds of all objects.
  1171. :param event: Ignored.
  1172. :return: None
  1173. """
  1174. xmin, ymin, xmax, ymax = self.collection.get_bounds()
  1175. width = xmax - xmin
  1176. height = ymax - ymin
  1177. xmin -= 0.05 * width
  1178. xmax += 0.05 * width
  1179. ymin -= 0.05 * height
  1180. ymax += 0.05 * height
  1181. self.plotcanvas.adjust_axes(xmin, ymin, xmax, ymax)
  1182. def on_key_over_plot(self, event):
  1183. """
  1184. Callback for the key pressed event when the canvas is focused. Keyboard
  1185. shortcuts are handled here. So far, these are the shortcuts:
  1186. ========== ============================================
  1187. Key Action
  1188. ========== ============================================
  1189. '1' Zoom-fit. Fits the axes limits to the data.
  1190. '2' Zoom-out.
  1191. '3' Zoom-in.
  1192. 'm' Toggle on-off the measuring tool.
  1193. ========== ============================================
  1194. :param event: Ignored.
  1195. :return: None
  1196. """
  1197. if event.key == self.defaults['fit_key']: # 1
  1198. self.on_zoom_fit(None)
  1199. return
  1200. if event.key == self.defaults['zoom_out_key']: # 2
  1201. self.plotcanvas.zoom(1 / self.defaults['zoom_ratio'], self.mouse)
  1202. return
  1203. if event.key == self.defaults['zoom_in_key']: # 3
  1204. self.plotcanvas.zoom(self.defaults['zoom_ratio'], self.mouse)
  1205. return
  1206. # if event.key == 'm':
  1207. # if self.measure.toggle_active():
  1208. # self.inform.emit("Measuring tool ON")
  1209. # else:
  1210. # self.inform.emit("Measuring tool OFF")
  1211. # return
  1212. def on_click_over_plot(self, event):
  1213. """
  1214. Callback for the mouse click event over the plot. This event is generated
  1215. by the Matplotlib backend and has been registered in ``self.__init__()``.
  1216. For details, see: http://matplotlib.org/users/event_handling.html
  1217. Default actions are:
  1218. * Copy coordinates to clipboard. Ex.: (65.5473, -13.2679)
  1219. :param event: Contains information about the event, like which button
  1220. was clicked, the pixel coordinates and the axes coordinates.
  1221. :return: None
  1222. """
  1223. # So it can receive key presses
  1224. self.plotcanvas.canvas.setFocus()
  1225. try:
  1226. App.log.debug('button=%d, x=%d, y=%d, xdata=%f, ydata=%f' % (
  1227. event.button, event.x, event.y, event.xdata, event.ydata))
  1228. self.clipboard.setText(self.defaults["point_clipboard_format"] % (event.xdata, event.ydata))
  1229. except Exception, e:
  1230. App.log.debug("Outside plot?")
  1231. App.log.debug(str(e))
  1232. def on_mouse_move_over_plot(self, event):
  1233. """
  1234. Callback for the mouse motion event over the plot. This event is generated
  1235. by the Matplotlib backend and has been registered in ``self.__init__()``.
  1236. For details, see: http://matplotlib.org/users/event_handling.html
  1237. :param event: Contains information about the event.
  1238. :return: None
  1239. """
  1240. try: # May fail in case mouse not within axes
  1241. self.ui.position_label.setText("X: %.4f Y: %.4f" % (
  1242. event.xdata, event.ydata))
  1243. self.mouse = [event.xdata, event.ydata]
  1244. except:
  1245. self.ui.position_label.setText("")
  1246. self.mouse = None
  1247. def on_file_new(self):
  1248. """
  1249. Callback for menu item File->New. Returns the application to its
  1250. startup state. This method is thread-safe.
  1251. :return: None
  1252. """
  1253. self.report_usage("on_file_new")
  1254. # Remove everything from memory
  1255. App.log.debug("on_file_new()")
  1256. self.plotcanvas.clear()
  1257. # tcl needs to be reinitialized, otherwise old shell variables etc remains
  1258. self.init_tcl()
  1259. self.collection.delete_all()
  1260. self.setup_component_editor()
  1261. # Clear project filename
  1262. self.project_filename = None
  1263. # Re-fresh project options
  1264. self.on_options_app2project()
  1265. def on_fileopengerber(self):
  1266. """
  1267. File menu callback for opening a Gerber.
  1268. :return: None
  1269. """
  1270. self.report_usage("on_fileopengerber")
  1271. App.log.debug("on_fileopengerber()")
  1272. try:
  1273. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Gerber",
  1274. directory=self.get_last_folder())
  1275. except TypeError:
  1276. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Gerber")
  1277. # The Qt methods above will return a QString which can cause problems later.
  1278. # So far json.dump() will fail to serialize it.
  1279. # TODO: Improve the serialization methods and remove this fix.
  1280. filename = str(filename)
  1281. if str(filename) == "":
  1282. self.inform.emit("Open cancelled.")
  1283. else:
  1284. self.worker_task.emit({'fcn': self.open_gerber,
  1285. 'params': [filename]})
  1286. def on_fileopenexcellon(self):
  1287. """
  1288. File menu callback for opening an Excellon file.
  1289. :return: None
  1290. """
  1291. self.report_usage("on_fileopenexcellon")
  1292. App.log.debug("on_fileopenexcellon()")
  1293. try:
  1294. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Excellon",
  1295. directory=self.get_last_folder())
  1296. except TypeError:
  1297. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Excellon")
  1298. # The Qt methods above will return a QString which can cause problems later.
  1299. # So far json.dump() will fail to serialize it.
  1300. # TODO: Improve the serialization methods and remove this fix.
  1301. filename = str(filename)
  1302. if str(filename) == "":
  1303. self.inform.emit("Open cancelled.")
  1304. else:
  1305. self.worker_task.emit({'fcn': self.open_excellon,
  1306. 'params': [filename]})
  1307. def on_fileopengcode(self):
  1308. """
  1309. File menu call back for opening gcode.
  1310. :return: None
  1311. """
  1312. self.report_usage("on_fileopengcode")
  1313. App.log.debug("on_fileopengcode()")
  1314. try:
  1315. filename = QtGui.QFileDialog.getOpenFileName(caption="Open G-Code",
  1316. directory=self.get_last_folder())
  1317. except TypeError:
  1318. filename = QtGui.QFileDialog.getOpenFileName(caption="Open G-Code")
  1319. # The Qt methods above will return a QString which can cause problems later.
  1320. # So far json.dump() will fail to serialize it.
  1321. # TODO: Improve the serialization methods and remove this fix.
  1322. filename = str(filename)
  1323. if str(filename) == "":
  1324. self.inform.emit("Open cancelled.")
  1325. else:
  1326. self.worker_task.emit({'fcn': self.open_gcode,
  1327. 'params': [filename]})
  1328. def on_file_openproject(self):
  1329. """
  1330. File menu callback for opening a project.
  1331. :return: None
  1332. """
  1333. self.report_usage("on_file_openproject")
  1334. App.log.debug("on_file_openproject()")
  1335. try:
  1336. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Project",
  1337. directory=self.get_last_folder())
  1338. except TypeError:
  1339. filename = QtGui.QFileDialog.getOpenFileName(caption="Open Project")
  1340. # The Qt methods above will return a QString which can cause problems later.
  1341. # So far json.dump() will fail to serialize it.
  1342. # TODO: Improve the serialization methods and remove this fix.
  1343. filename = str(filename)
  1344. if str(filename) == "":
  1345. self.inform.emit("Open cancelled.")
  1346. else:
  1347. # self.worker_task.emit({'fcn': self.open_project,
  1348. # 'params': [filename]})
  1349. # The above was failing because open_project() is not
  1350. # thread safe. The new_project()
  1351. self.open_project(filename)
  1352. def on_file_exportsvg(self):
  1353. """
  1354. Callback for menu item File->Export SVG.
  1355. :return: None
  1356. """
  1357. self.report_usage("on_file_exportsvg")
  1358. App.log.debug("on_file_exportsvg()")
  1359. obj = self.collection.get_active()
  1360. if obj is None:
  1361. self.inform.emit("WARNING: No object selected.")
  1362. msg = "Please Select a Geometry object to export"
  1363. msgbox = QtGui.QMessageBox()
  1364. msgbox.setInformativeText(msg)
  1365. msgbox.setStandardButtons(QtGui.QMessageBox.Ok)
  1366. msgbox.setDefaultButton(QtGui.QMessageBox.Ok)
  1367. msgbox.exec_()
  1368. return
  1369. # Check for more compatible types and add as required
  1370. if (not isinstance(obj, FlatCAMGeometry) and not isinstance(obj, FlatCAMGerber) and not isinstance(obj, FlatCAMCNCjob)
  1371. and not isinstance(obj, FlatCAMExcellon)):
  1372. msg = "ERROR: Only Geometry, Gerber and CNCJob objects can be used."
  1373. msgbox = QtGui.QMessageBox()
  1374. msgbox.setInformativeText(msg)
  1375. msgbox.setStandardButtons(QtGui.QMessageBox.Ok)
  1376. msgbox.setDefaultButton(QtGui.QMessageBox.Ok)
  1377. msgbox.exec_()
  1378. return
  1379. name = self.collection.get_active().options["name"]
  1380. try:
  1381. filename = QtGui.QFileDialog.getSaveFileName(caption="Export SVG",
  1382. directory=self.get_last_folder(), filter="*.svg")
  1383. except TypeError:
  1384. filename = QtGui.QFileDialog.getSaveFileName(caption="Export SVG")
  1385. filename = str(filename)
  1386. if str(filename) == "":
  1387. self.inform.emit("Export SVG cancelled.")
  1388. return
  1389. else:
  1390. self.export_svg(name, filename)
  1391. def on_file_importsvg(self):
  1392. """
  1393. Callback for menu item File->Import SVG.
  1394. :return: None
  1395. """
  1396. self.report_usage("on_file_importsvg")
  1397. App.log.debug("on_file_importsvg()")
  1398. try:
  1399. filename = QtGui.QFileDialog.getOpenFileName(caption="Import SVG",
  1400. directory=self.get_last_folder())
  1401. except TypeError:
  1402. filename = QtGui.QFileDialog.getOpenFileName(caption="Import SVG")
  1403. filename = str(filename)
  1404. if str(filename) == "":
  1405. self.inform.emit("Open cancelled.")
  1406. else:
  1407. self.worker_task.emit({'fcn': self.import_svg,
  1408. 'params': [filename]})
  1409. def on_file_saveproject(self):
  1410. """
  1411. Callback for menu item File->Save Project. Saves the project to
  1412. ``self.project_filename`` or calls ``self.on_file_saveprojectas()``
  1413. if set to None. The project is saved by calling ``self.save_project()``.
  1414. :return: None
  1415. """
  1416. self.report_usage("on_file_saveproject")
  1417. if self.project_filename is None:
  1418. self.on_file_saveprojectas()
  1419. else:
  1420. self.save_project(self.project_filename)
  1421. self.file_opened.emit("project", self.project_filename)
  1422. self.inform.emit("Project saved to: " + self.project_filename)
  1423. def on_file_saveprojectas(self, make_copy=False):
  1424. """
  1425. Callback for menu item File->Save Project As... Opens a file
  1426. chooser and saves the project to the given file via
  1427. ``self.save_project()``.
  1428. :return: None
  1429. """
  1430. self.report_usage("on_file_saveprojectas")
  1431. try:
  1432. filename = QtGui.QFileDialog.getSaveFileName(caption="Save Project As ...",
  1433. directory=self.get_last_folder())
  1434. except TypeError:
  1435. filename = QtGui.QFileDialog.getSaveFileName(caption="Save Project As ...")
  1436. try:
  1437. f = open(filename, 'r')
  1438. f.close()
  1439. exists = True
  1440. except IOError:
  1441. exists = False
  1442. msg = "File exists. Overwrite?"
  1443. if exists:
  1444. msgbox = QtGui.QMessageBox()
  1445. msgbox.setInformativeText(msg)
  1446. msgbox.setStandardButtons(QtGui.QMessageBox.Cancel | QtGui.QMessageBox.Ok)
  1447. msgbox.setDefaultButton(QtGui.QMessageBox.Cancel)
  1448. result = msgbox.exec_()
  1449. if result == QtGui.QMessageBox.Cancel:
  1450. return
  1451. self.save_project(filename)
  1452. self.file_opened.emit("project", filename)
  1453. if not make_copy:
  1454. self.project_filename = filename
  1455. self.inform.emit("Project saved to: " + self.project_filename)
  1456. else:
  1457. self.inform.emit("Project copy saved to: " + self.project_filename)
  1458. def export_svg(self, obj_name, filename, scale_factor=0.00):
  1459. """
  1460. Exports a Geometry Object to a SVG File
  1461. :param filename: Path to the SVG file to save to.
  1462. :param outname:
  1463. :return:
  1464. """
  1465. self.log.debug("export_svg()")
  1466. try:
  1467. obj = self.collection.get_by_name(str(obj_name))
  1468. except:
  1469. return "Could not retrieve object: %s" % obj_name
  1470. with self.proc_container.new("Exporting SVG") as proc:
  1471. exported_svg = obj.export_svg(scale_factor=scale_factor)
  1472. # Determine bounding area for svg export
  1473. bounds = obj.bounds()
  1474. size = obj.size()
  1475. # Convert everything to strings for use in the xml doc
  1476. svgwidth = str(size[0])
  1477. svgheight = str(size[1])
  1478. minx = str(bounds[0])
  1479. miny = str(bounds[1] - size[1])
  1480. uom = obj.units.lower()
  1481. # Add a SVG Header and footer to the svg output from shapely
  1482. # The transform flips the Y Axis so that everything renders properly within svg apps such as inkscape
  1483. svg_header = '<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" '
  1484. svg_header += 'width="' + svgwidth + uom + '" '
  1485. svg_header += 'height="' + svgheight + uom + '" '
  1486. svg_header += 'viewBox="' + minx + ' ' + miny + ' ' + svgwidth + ' ' + svgheight + '">'
  1487. svg_header += '<g transform="scale(1,-1)">'
  1488. svg_footer = '</g> </svg>'
  1489. svg_elem = svg_header + exported_svg + svg_footer
  1490. # Parse the xml through a xml parser just to add line feeds and to make it look more pretty for the output
  1491. doc = parse_xml_string(svg_elem)
  1492. with open(filename, 'w') as fp:
  1493. fp.write(doc.toprettyxml())
  1494. def import_svg(self, filename, outname=None):
  1495. """
  1496. Adds a new Geometry Object to the projects and populates
  1497. it with shapes extracted from the SVG file.
  1498. :param filename: Path to the SVG file.
  1499. :param outname:
  1500. :return:
  1501. """
  1502. def obj_init(geo_obj, app_obj):
  1503. geo_obj.import_svg(filename)
  1504. with self.proc_container.new("Importing SVG") as proc:
  1505. # Object name
  1506. name = outname or filename.split('/')[-1].split('\\')[-1]
  1507. self.new_object("geometry", name, obj_init)
  1508. # Register recent file
  1509. self.file_opened.emit("svg", filename)
  1510. # GUI feedback
  1511. self.inform.emit("Opened: " + filename)
  1512. def open_gerber(self, filename, follow=False, outname=None):
  1513. """
  1514. Opens a Gerber file, parses it and creates a new object for
  1515. it in the program. Thread-safe.
  1516. :param filename: Gerber file filename
  1517. :type filename: str
  1518. :param follow: If true, the parser will not create polygons, just lines
  1519. following the gerber path.
  1520. :type follow: bool
  1521. :return: None
  1522. """
  1523. # How the object should be initialized
  1524. def obj_init(gerber_obj, app_obj):
  1525. assert isinstance(gerber_obj, FlatCAMGerber), \
  1526. "Expected to initialize a FlatCAMGerber but got %s" % type(gerber_obj)
  1527. # Opening the file happens here
  1528. self.progress.emit(30)
  1529. try:
  1530. gerber_obj.parse_file(filename, follow=follow)
  1531. except IOError:
  1532. app_obj.inform.emit("[error] Failed to open file: " + filename)
  1533. app_obj.progress.emit(0)
  1534. raise IOError('Failed to open file: ' + filename)
  1535. except ParseError, e:
  1536. app_obj.inform.emit("[error] Failed to parse file: " + filename + ". " + e[0])
  1537. app_obj.progress.emit(0)
  1538. self.log.error(str(e))
  1539. raise
  1540. # Further parsing
  1541. self.progress.emit(70) # TODO: Note the mixture of self and app_obj used here
  1542. App.log.debug("open_gerber()")
  1543. with self.proc_container.new("Opening Gerber") as proc:
  1544. self.progress.emit(10)
  1545. # Object name
  1546. name = outname or filename.split('/')[-1].split('\\')[-1]
  1547. ### Object creation ###
  1548. self.new_object("gerber", name, obj_init)
  1549. # Register recent file
  1550. self.file_opened.emit("gerber", filename)
  1551. self.progress.emit(100)
  1552. #proc.done()
  1553. # GUI feedback
  1554. self.inform.emit("Opened: " + filename)
  1555. def open_excellon(self, filename, outname=None):
  1556. """
  1557. Opens an Excellon file, parses it and creates a new object for
  1558. it in the program. Thread-safe.
  1559. :param filename: Excellon file filename
  1560. :type filename: str
  1561. :return: None
  1562. """
  1563. App.log.debug("open_excellon()")
  1564. #self.progress.emit(10)
  1565. # How the object should be initialized
  1566. def obj_init(excellon_obj, app_obj):
  1567. #self.progress.emit(20)
  1568. try:
  1569. excellon_obj.parse_file(filename)
  1570. except IOError:
  1571. app_obj.inform.emit("[error] Cannot open file: " + filename)
  1572. self.progress.emit(0) # TODO: self and app_bjj mixed
  1573. raise IOError("Cannot open file: " + filename)
  1574. try:
  1575. excellon_obj.create_geometry()
  1576. except Exception as e:
  1577. app_obj.inform.emit("[error] Failed to create geometry after parsing: " + filename)
  1578. self.progress.emit(0)
  1579. raise e
  1580. #self.progress.emit(70)
  1581. with self.proc_container.new("Opening Excellon."):
  1582. # Object name
  1583. name = outname or filename.split('/')[-1].split('\\')[-1]
  1584. self.new_object("excellon", name, obj_init)
  1585. # Register recent file
  1586. self.file_opened.emit("excellon", filename)
  1587. # GUI feedback
  1588. self.inform.emit("Opened: " + filename)
  1589. #self.progress.emit(100)
  1590. def open_gcode(self, filename, outname=None):
  1591. """
  1592. Opens a G-gcode file, parses it and creates a new object for
  1593. it in the program. Thread-safe.
  1594. :param filename: G-code file filename
  1595. :type filename: str
  1596. :return: None
  1597. """
  1598. App.log.debug("open_gcode()")
  1599. # How the object should be initialized
  1600. def obj_init(job_obj, app_obj_):
  1601. """
  1602. :type app_obj_: App
  1603. """
  1604. assert isinstance(app_obj_, App), \
  1605. "Initializer expected App, got %s" % type(app_obj_)
  1606. self.progress.emit(10)
  1607. try:
  1608. f = open(filename)
  1609. gcode = f.read()
  1610. f.close()
  1611. except IOError:
  1612. app_obj_.inform.emit("[error] Failed to open " + filename)
  1613. self.progress.emit(0)
  1614. raise IOError("Failed to open " + filename)
  1615. job_obj.gcode = gcode
  1616. self.progress.emit(20)
  1617. job_obj.gcode_parse()
  1618. self.progress.emit(60)
  1619. job_obj.create_geometry()
  1620. with self.proc_container.new("Opening G-Code."):
  1621. # Object name
  1622. name = outname or filename.split('/')[-1].split('\\')[-1]
  1623. # New object creation and file processing
  1624. try:
  1625. self.new_object("cncjob", name, obj_init)
  1626. except Exception as e:
  1627. # e = sys.exc_info()
  1628. App.log.error(str(e))
  1629. self.message_dialog("Failed to create CNCJob Object",
  1630. "Attempting to create a FlatCAM CNCJob Object from " +
  1631. "G-Code file failed during processing:\n" +
  1632. str(e[0]) + " " + str(e[1]), kind="error")
  1633. self.progress.emit(0)
  1634. self.collection.delete_active()
  1635. raise e
  1636. # Register recent file
  1637. self.file_opened.emit("cncjob", filename)
  1638. # GUI feedback
  1639. self.inform.emit("Opened: " + filename)
  1640. self.progress.emit(100)
  1641. def open_project(self, filename):
  1642. """
  1643. Loads a project from the specified file.
  1644. 1) Loads and parses file
  1645. 2) Registers the file as recently opened.
  1646. 3) Calls on_file_new()
  1647. 4) Updates options
  1648. 5) Calls new_object() with the object's from_dict() as init method.
  1649. 6) Calls plot_all()
  1650. :param filename: Name of the file from which to load.
  1651. :type filename: str
  1652. :return: None
  1653. """
  1654. App.log.debug("Opening project: " + filename)
  1655. ## Open and parse
  1656. try:
  1657. f = open(filename, 'r')
  1658. except IOError:
  1659. App.log.error("Failed to open project file: %s" % filename)
  1660. self.inform.emit("[error] Failed to open project file: %s" % filename)
  1661. return
  1662. try:
  1663. d = json.load(f, object_hook=dict2obj)
  1664. except:
  1665. App.log.error("Failed to parse project file: %s" % filename)
  1666. self.inform.emit("[error] Failed to parse project file: %s" % filename)
  1667. f.close()
  1668. return
  1669. self.file_opened.emit("project", filename)
  1670. ## Clear the current project
  1671. ## NOT THREAD SAFE ##
  1672. self.on_file_new()
  1673. ##Project options
  1674. self.options.update(d['options'])
  1675. self.project_filename = filename
  1676. #self.ui.units_label.setText("[" + self.options["units"] + "]")
  1677. self.set_screen_units(self.options["units"])
  1678. ## Re create objects
  1679. App.log.debug("Re-creating objects...")
  1680. for obj in d['objs']:
  1681. def obj_init(obj_inst, app_inst):
  1682. obj_inst.from_dict(obj)
  1683. App.log.debug(obj['kind'] + ": " + obj['options']['name'])
  1684. self.new_object(obj['kind'], obj['options']['name'], obj_init, active=False, fit=False, plot=False)
  1685. self.plot_all()
  1686. self.inform.emit("Project loaded from: " + filename)
  1687. App.log.debug("Project loaded")
  1688. def propagate_defaults(self):
  1689. """
  1690. This method is used to set default values in classes. It's
  1691. an alternative to project options but allows the use
  1692. of values invisible to the user.
  1693. :return: None
  1694. """
  1695. self.log.debug("propagate_defaults()")
  1696. # Which objects to update the given parameters.
  1697. routes = {
  1698. "zdownrate": CNCjob,
  1699. "excellon_zeros": Excellon,
  1700. "gerber_use_buffer_for_union": Gerber,
  1701. "cncjob_coordinate_format": CNCjob
  1702. # "spindlespeed": CNCjob
  1703. }
  1704. for param in routes:
  1705. if param in routes[param].defaults:
  1706. try:
  1707. routes[param].defaults[param] = self.defaults[param]
  1708. self.log.debug(" " + param + " OK")
  1709. except KeyError:
  1710. self.log.debug(" ERROR: " + param + " not in defaults.")
  1711. else:
  1712. # Try extracting the name:
  1713. # classname_param here is param in the object
  1714. if param.find(routes[param].__name__.lower() + "_") == 0:
  1715. p = param[len(routes[param].__name__) + 1:]
  1716. if p in routes[param].defaults:
  1717. routes[param].defaults[p] = self.defaults[param]
  1718. self.log.debug(" " + param + " OK!")
  1719. def restore_main_win_geom(self):
  1720. self.ui.setGeometry(self.defaults["def_win_x"],
  1721. self.defaults["def_win_y"],
  1722. self.defaults["def_win_w"],
  1723. self.defaults["def_win_h"])
  1724. def plot_all(self):
  1725. """
  1726. Re-generates all plots from all objects.
  1727. :return: None
  1728. """
  1729. self.log.debug("plot_all()")
  1730. self.plotcanvas.clear()
  1731. self.progress.emit(10)
  1732. def worker_task(app_obj):
  1733. percentage = 0.1
  1734. try:
  1735. delta = 0.9 / len(self.collection.get_list())
  1736. except ZeroDivisionError:
  1737. self.progress.emit(0)
  1738. return
  1739. for obj in self.collection.get_list():
  1740. obj.plot()
  1741. percentage += delta
  1742. self.progress.emit(int(percentage*100))
  1743. self.progress.emit(0)
  1744. self.plots_updated.emit()
  1745. # Send to worker
  1746. #self.worker.add_task(worker_task, [self])
  1747. self.worker_task.emit({'fcn': worker_task, 'params': [self]})
  1748. def register_folder(self, filename):
  1749. self.defaults["last_folder"] = os.path.split(str(filename))[0]
  1750. def set_progress_bar(self, percentage, text=""):
  1751. self.ui.progress_bar.setValue(int(percentage))
  1752. def setup_shell(self):
  1753. """
  1754. Creates shell functions. Runs once at startup.
  1755. :return: None
  1756. """
  1757. self.log.debug("setup_shell()")
  1758. def shelp(p=None):
  1759. if not p:
  1760. return "Available commands:\n" + \
  1761. '\n'.join([' ' + cmd for cmd in sorted(commands)]) + \
  1762. "\n\nType help <command_name> for usage.\n Example: help open_gerber"
  1763. if p not in commands:
  1764. return "Unknown command: %s" % p
  1765. return commands[p]["help"]
  1766. def options(name):
  1767. ops = self.collection.get_by_name(str(name)).options
  1768. return '\n'.join(["%s: %s" % (o, ops[o]) for o in ops])
  1769. def h(*args):
  1770. """
  1771. Pre-processes arguments to detect '-keyword value' pairs into dictionary
  1772. and standalone parameters into list.
  1773. """
  1774. kwa = {}
  1775. a = []
  1776. n = len(args)
  1777. name = None
  1778. for i in range(n):
  1779. match = re.search(r'^-([a-zA-Z].*)', args[i])
  1780. if match:
  1781. assert name is None
  1782. name = match.group(1)
  1783. continue
  1784. if name is None:
  1785. a.append(args[i])
  1786. else:
  1787. kwa[name] = args[i]
  1788. name = None
  1789. return a, kwa
  1790. @contextmanager
  1791. def wait_signal(signal, timeout=10000):
  1792. """Block loop until signal emitted, or timeout (ms) elapses."""
  1793. loop = QtCore.QEventLoop()
  1794. signal.connect(loop.quit)
  1795. status = {'timed_out': False}
  1796. def report_quit():
  1797. status['timed_out'] = True
  1798. loop.quit()
  1799. yield
  1800. oeh = sys.excepthook
  1801. ex = []
  1802. def exceptHook(type_, value, traceback):
  1803. ex.append(value)
  1804. oeh(type_, value, traceback)
  1805. sys.excepthook = exceptHook
  1806. if timeout is not None:
  1807. QtCore.QTimer.singleShot(timeout, report_quit)
  1808. loop.exec_()
  1809. sys.excepthook = oeh
  1810. if ex:
  1811. self.raiseTclError(str(ex[0]))
  1812. if status['timed_out']:
  1813. raise Exception('Timed out!')
  1814. # def wait_signal2(signal, timeout=10000):
  1815. # """Block loop until signal emitted, or timeout (ms) elapses."""
  1816. # loop = QtCore.QEventLoop()
  1817. # signal.connect(loop.quit)
  1818. # status = {'timed_out': False}
  1819. #
  1820. # def report_quit():
  1821. # status['timed_out'] = True
  1822. # loop.quit()
  1823. #
  1824. # if timeout is not None:
  1825. # QtCore.QTimer.singleShot(timeout, report_quit)
  1826. # loop.exec_()
  1827. #
  1828. # if status['timed_out']:
  1829. # raise Exception('Timed out!')
  1830. def mytest(*args):
  1831. to = int(args[0])
  1832. try:
  1833. for rec in self.recent:
  1834. if rec['kind'] == 'gerber':
  1835. self.open_gerber(str(rec['filename']))
  1836. break
  1837. basename = self.collection.get_names()[0]
  1838. isolate(basename, '-passes', '10', '-combine', '1')
  1839. iso = self.collection.get_by_name(basename + "_iso")
  1840. with wait_signal(self.new_object_available, to):
  1841. iso.generatecncjob()
  1842. # iso.generatecncjob()
  1843. # wait_signal2(self.new_object_available, to)
  1844. return str(self.collection.get_names())
  1845. except Exception as e:
  1846. return str(e)
  1847. def mytest2(*args):
  1848. to = int(args[0])
  1849. for rec in self.recent:
  1850. if rec['kind'] == 'gerber':
  1851. self.open_gerber(str(rec['filename']))
  1852. break
  1853. basename = self.collection.get_names()[0]
  1854. isolate(basename, '-passes', '10', '-combine', '1')
  1855. iso = self.collection.get_by_name(basename + "_iso")
  1856. with wait_signal(self.new_object_available, to):
  1857. 1/0 # Force exception
  1858. iso.generatecncjob()
  1859. return str(self.collection.get_names())
  1860. def mytest3(*args):
  1861. to = int(args[0])
  1862. def sometask(*args):
  1863. time.sleep(2)
  1864. self.inform.emit("mytest3")
  1865. with wait_signal(self.inform, to):
  1866. self.worker_task.emit({'fcn': sometask, 'params': []})
  1867. return "mytest3 done"
  1868. def mytest4(*args):
  1869. to = int(args[0])
  1870. def sometask(*args):
  1871. time.sleep(2)
  1872. 1/0 # Force exception
  1873. self.inform.emit("mytest4")
  1874. with wait_signal(self.inform, to):
  1875. self.worker_task.emit({'fcn': sometask, 'params': []})
  1876. return "mytest3 done"
  1877. def export_svg(name, filename, *args):
  1878. a, kwa = h(*args)
  1879. types = {'scale_factor': float}
  1880. for key in kwa:
  1881. if key not in types:
  1882. return 'Unknown parameter: %s' % key
  1883. kwa[key] = types[key](kwa[key])
  1884. self.export_svg(str(name), str(filename), **kwa)
  1885. def import_svg(filename, *args):
  1886. a, kwa = h(*args)
  1887. types = {'outname': str}
  1888. for key in kwa:
  1889. if key not in types:
  1890. return 'Unknown parameter: %s' % key
  1891. kwa[key] = types[key](kwa[key])
  1892. self.import_svg(str(filename), **kwa)
  1893. def open_gerber(filename, *args):
  1894. a, kwa = h(*args)
  1895. types = {'follow': bool,
  1896. 'outname': str}
  1897. for key in kwa:
  1898. if key not in types:
  1899. return 'Unknown parameter: %s' % key
  1900. kwa[key] = types[key](kwa[key])
  1901. self.open_gerber(str(filename), **kwa)
  1902. def open_excellon(filename, *args):
  1903. a, kwa = h(*args)
  1904. types = {'outname': str}
  1905. for key in kwa:
  1906. if key not in types:
  1907. return 'Unknown parameter: %s' % key
  1908. kwa[key] = types[key](kwa[key])
  1909. self.open_excellon(str(filename), **kwa)
  1910. def open_gcode(filename, *args):
  1911. a, kwa = h(*args)
  1912. types = {'outname': str}
  1913. for key in kwa:
  1914. if key not in types:
  1915. return 'Unknown parameter: %s' % key
  1916. kwa[key] = types[key](kwa[key])
  1917. self.open_gcode(str(filename), **kwa)
  1918. def cutout(name, *args):
  1919. a, kwa = h(*args)
  1920. types = {'dia': float,
  1921. 'margin': float,
  1922. 'gapsize': float,
  1923. 'gaps': str}
  1924. for key in kwa:
  1925. if key not in types:
  1926. return 'Unknown parameter: %s' % key
  1927. kwa[key] = types[key](kwa[key])
  1928. try:
  1929. obj = self.collection.get_by_name(str(name))
  1930. except:
  1931. return "Could not retrieve object: %s" % name
  1932. def geo_init_me(geo_obj, app_obj):
  1933. margin = kwa['margin']+kwa['dia']/2
  1934. gap_size = kwa['dia']+kwa['gapsize']
  1935. minx, miny, maxx, maxy = obj.bounds()
  1936. minx -= margin
  1937. maxx += margin
  1938. miny -= margin
  1939. maxy += margin
  1940. midx = 0.5 * (minx + maxx)
  1941. midy = 0.5 * (miny + maxy)
  1942. hgap = 0.5 * gap_size
  1943. pts = [[midx - hgap, maxy],
  1944. [minx, maxy],
  1945. [minx, midy + hgap],
  1946. [minx, midy - hgap],
  1947. [minx, miny],
  1948. [midx - hgap, miny],
  1949. [midx + hgap, miny],
  1950. [maxx, miny],
  1951. [maxx, midy - hgap],
  1952. [maxx, midy + hgap],
  1953. [maxx, maxy],
  1954. [midx + hgap, maxy]]
  1955. cases = {"tb": [[pts[0], pts[1], pts[4], pts[5]],
  1956. [pts[6], pts[7], pts[10], pts[11]]],
  1957. "lr": [[pts[9], pts[10], pts[1], pts[2]],
  1958. [pts[3], pts[4], pts[7], pts[8]]],
  1959. "4": [[pts[0], pts[1], pts[2]],
  1960. [pts[3], pts[4], pts[5]],
  1961. [pts[6], pts[7], pts[8]],
  1962. [pts[9], pts[10], pts[11]]]}
  1963. cuts = cases[kwa['gaps']]
  1964. geo_obj.solid_geometry = cascaded_union([LineString(segment) for segment in cuts])
  1965. try:
  1966. obj.app.new_object("geometry", name + "_cutout", geo_init_me)
  1967. except Exception, e:
  1968. return "Operation failed: %s" % str(e)
  1969. return 'Ok'
  1970. def geocutout(name=None, *args):
  1971. '''
  1972. TCL shell command - see help section
  1973. Subtract gaps from geometry, this will not create new object
  1974. :param name: name of object
  1975. :param args: array of arguments
  1976. :return: "Ok" if completed without errors
  1977. '''
  1978. try:
  1979. a, kwa = h(*args)
  1980. types = {'dia': float,
  1981. 'gapsize': float,
  1982. 'gaps': str}
  1983. # How gaps wil be rendered:
  1984. # lr - left + right
  1985. # tb - top + bottom
  1986. # 4 - left + right +top + bottom
  1987. # 2lr - 2*left + 2*right
  1988. # 2tb - 2*top + 2*bottom
  1989. # 8 - 2*left + 2*right +2*top + 2*bottom
  1990. if name is None:
  1991. self.raise_tcl_error('Argument name is missing.')
  1992. for key in kwa:
  1993. if key not in types:
  1994. self.raise_tcl_error('Unknown parameter: %s' % key)
  1995. try:
  1996. kwa[key] = types[key](kwa[key])
  1997. except Exception, e:
  1998. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, str(types[key])))
  1999. try:
  2000. obj = self.collection.get_by_name(str(name))
  2001. except:
  2002. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2003. # Get min and max data for each object as we just cut rectangles across X or Y
  2004. xmin, ymin, xmax, ymax = obj.bounds()
  2005. px = 0.5 * (xmin + xmax)
  2006. py = 0.5 * (ymin + ymax)
  2007. lenghtx = (xmax - xmin)
  2008. lenghty = (ymax - ymin)
  2009. gapsize = kwa['gapsize'] + kwa['dia'] / 2
  2010. if kwa['gaps'] == '8' or kwa['gaps']=='2lr':
  2011. subtract_rectangle(name,
  2012. xmin - gapsize,
  2013. py - gapsize + lenghty / 4,
  2014. xmax + gapsize,
  2015. py + gapsize + lenghty / 4)
  2016. subtract_rectangle(name,
  2017. xmin-gapsize,
  2018. py - gapsize - lenghty / 4,
  2019. xmax + gapsize,
  2020. py + gapsize - lenghty / 4)
  2021. if kwa['gaps'] == '8' or kwa['gaps']=='2tb':
  2022. subtract_rectangle(name,
  2023. px - gapsize + lenghtx / 4,
  2024. ymin-gapsize,
  2025. px + gapsize + lenghtx / 4,
  2026. ymax + gapsize)
  2027. subtract_rectangle(name,
  2028. px - gapsize - lenghtx / 4,
  2029. ymin - gapsize,
  2030. px + gapsize - lenghtx / 4,
  2031. ymax + gapsize)
  2032. if kwa['gaps'] == '4' or kwa['gaps']=='lr':
  2033. subtract_rectangle(name,
  2034. xmin - gapsize,
  2035. py - gapsize,
  2036. xmax + gapsize,
  2037. py + gapsize)
  2038. if kwa['gaps'] == '4' or kwa['gaps']=='tb':
  2039. subtract_rectangle(name,
  2040. px - gapsize,
  2041. ymin - gapsize,
  2042. px + gapsize,
  2043. ymax + gapsize)
  2044. except Exception as unknown:
  2045. self.raise_tcl_unknown_error(unknown)
  2046. def mirror(name, *args):
  2047. a, kwa = h(*args)
  2048. types = {'box': str,
  2049. 'axis': str,
  2050. 'dist': float}
  2051. for key in kwa:
  2052. if key not in types:
  2053. return 'Unknown parameter: %s' % key
  2054. kwa[key] = types[key](kwa[key])
  2055. # Get source object.
  2056. try:
  2057. obj = self.collection.get_by_name(str(name))
  2058. except:
  2059. return "Could not retrieve object: %s" % name
  2060. if obj is None:
  2061. return "Object not found: %s" % name
  2062. if not isinstance(obj, FlatCAMGerber) and not isinstance(obj, FlatCAMExcellon):
  2063. return "ERROR: Only Gerber and Excellon objects can be mirrored."
  2064. # Axis
  2065. try:
  2066. axis = kwa['axis'].upper()
  2067. except KeyError:
  2068. return "ERROR: Specify -axis X or -axis Y"
  2069. # Box
  2070. if 'box' in kwa:
  2071. try:
  2072. box = self.collection.get_by_name(kwa['box'])
  2073. except:
  2074. return "Could not retrieve object box: %s" % kwa['box']
  2075. if box is None:
  2076. return "Object box not found: %s" % kwa['box']
  2077. try:
  2078. xmin, ymin, xmax, ymax = box.bounds()
  2079. px = 0.5 * (xmin + xmax)
  2080. py = 0.5 * (ymin + ymax)
  2081. obj.mirror(axis, [px, py])
  2082. obj.plot()
  2083. except Exception, e:
  2084. return "Operation failed: %s" % str(e)
  2085. else:
  2086. try:
  2087. dist = float(kwa['dist'])
  2088. except KeyError:
  2089. dist = 0.0
  2090. except ValueError:
  2091. return "Invalid distance: %s" % kwa['dist']
  2092. try:
  2093. obj.mirror(axis, [dist, dist])
  2094. obj.plot()
  2095. except Exception, e:
  2096. return "Operation failed: %s" % str(e)
  2097. return 'Ok'
  2098. def aligndrillgrid(outname, *args):
  2099. a, kwa = h(*args)
  2100. types = {'gridx': float,
  2101. 'gridy': float,
  2102. 'gridoffsetx': float,
  2103. 'gridoffsety': float,
  2104. 'columns':int,
  2105. 'rows':int,
  2106. 'dia': float
  2107. }
  2108. for key in kwa:
  2109. if key not in types:
  2110. return 'Unknown parameter: %s' % key
  2111. kwa[key] = types[key](kwa[key])
  2112. if 'columns' not in kwa or 'rows' not in kwa:
  2113. return "ERROR: Specify -columns and -rows"
  2114. if 'gridx' not in kwa or 'gridy' not in kwa:
  2115. return "ERROR: Specify -gridx and -gridy"
  2116. if 'dia' not in kwa:
  2117. return "ERROR: Specify -dia"
  2118. if 'gridoffsetx' not in kwa:
  2119. gridoffsetx=0
  2120. else:
  2121. gridoffsetx=kwa['gridoffsetx']
  2122. if 'gridoffsety' not in kwa:
  2123. gridoffsety=0
  2124. else:
  2125. gridoffsety=kwa['gridoffsety']
  2126. # Tools
  2127. tools = {"1": {"C": kwa['dia']}}
  2128. def aligndrillgrid_init_me(init_obj, app_obj):
  2129. drills = []
  2130. currenty=0
  2131. for row in range(kwa['rows']):
  2132. currentx=0
  2133. for col in range(kwa['columns']):
  2134. point = Point(currentx + gridoffsetx, currenty + gridoffsety)
  2135. drills.append({"point": point, "tool": "1"})
  2136. currentx = currentx + kwa['gridx']
  2137. currenty = currenty + kwa['gridy']
  2138. init_obj.tools = tools
  2139. init_obj.drills = drills
  2140. init_obj.create_geometry()
  2141. self.new_object("excellon", outname , aligndrillgrid_init_me)
  2142. def aligndrill(name, *args):
  2143. a, kwa = h(*args)
  2144. types = {'box': str,
  2145. 'axis': str,
  2146. 'holes': str,
  2147. 'grid': float,
  2148. 'minoffset': float,
  2149. 'gridoffset': float,
  2150. 'axisoffset': float,
  2151. 'dia': float,
  2152. 'dist': float}
  2153. for key in kwa:
  2154. if key not in types:
  2155. return 'Unknown parameter: %s' % key
  2156. kwa[key] = types[key](kwa[key])
  2157. # Get source object.
  2158. try:
  2159. obj = self.collection.get_by_name(str(name))
  2160. except:
  2161. return "Could not retrieve object: %s" % name
  2162. if obj is None:
  2163. return "Object not found: %s" % name
  2164. if not isinstance(obj, FlatCAMGeometry) and not isinstance(obj, FlatCAMGerber) and not isinstance(obj, FlatCAMExcellon):
  2165. return "ERROR: Only Gerber, Geometry and Excellon objects can be used."
  2166. # Axis
  2167. try:
  2168. axis = kwa['axis'].upper()
  2169. except KeyError:
  2170. return "ERROR: Specify -axis X or -axis Y"
  2171. if not ('holes' in kwa or ('grid' in kwa and 'gridoffset' in kwa)):
  2172. return "ERROR: Specify -holes or -grid with -gridoffset "
  2173. if 'holes' in kwa:
  2174. try:
  2175. holes = eval("[" + kwa['holes'] + "]")
  2176. except KeyError:
  2177. return "ERROR: Wrong -holes format (X1,Y1),(X2,Y2)"
  2178. xscale, yscale = {"X": (1.0, -1.0), "Y": (-1.0, 1.0)}[axis]
  2179. # Tools
  2180. tools = {"1": {"C": kwa['dia']}}
  2181. def alligndrill_init_me(init_obj, app_obj):
  2182. drills = []
  2183. if 'holes' in kwa:
  2184. for hole in holes:
  2185. point = Point(hole)
  2186. point_mirror = affinity.scale(point, xscale, yscale, origin=(px, py))
  2187. drills.append({"point": point, "tool": "1"})
  2188. drills.append({"point": point_mirror, "tool": "1"})
  2189. else:
  2190. if not 'box' in kwa:
  2191. return "ERROR: -grid can be used only for -box"
  2192. if 'axisoffset' in kwa:
  2193. axisoffset=kwa['axisoffset']
  2194. else:
  2195. axisoffset=0
  2196. # This will align hole to given aligngridoffset and minimal offset from pcb, based on selected axis
  2197. if axis == "X":
  2198. firstpoint = kwa['gridoffset']
  2199. while (xmin - kwa['minoffset']) < firstpoint:
  2200. firstpoint = firstpoint - kwa['grid']
  2201. lastpoint = kwa['gridoffset']
  2202. while (xmax + kwa['minoffset']) > lastpoint:
  2203. lastpoint = lastpoint + kwa['grid']
  2204. localHoles = (firstpoint, axisoffset), (lastpoint, axisoffset)
  2205. else:
  2206. firstpoint = kwa['gridoffset']
  2207. while (ymin - kwa['minoffset']) < firstpoint:
  2208. firstpoint = firstpoint - kwa['grid']
  2209. lastpoint = kwa['gridoffset']
  2210. while (ymax + kwa['minoffset']) > lastpoint:
  2211. lastpoint=lastpoint+kwa['grid']
  2212. localHoles = (axisoffset, firstpoint), (axisoffset, lastpoint)
  2213. for hole in localHoles:
  2214. point = Point(hole)
  2215. point_mirror = affinity.scale(point, xscale, yscale, origin=(px, py))
  2216. drills.append({"point": point, "tool": "1"})
  2217. drills.append({"point": point_mirror, "tool": "1"})
  2218. init_obj.tools = tools
  2219. init_obj.drills = drills
  2220. init_obj.create_geometry()
  2221. # Box
  2222. if 'box' in kwa:
  2223. try:
  2224. box = self.collection.get_by_name(kwa['box'])
  2225. except:
  2226. return "Could not retrieve object box: %s" % kwa['box']
  2227. if box is None:
  2228. return "Object box not found: %s" % kwa['box']
  2229. try:
  2230. xmin, ymin, xmax, ymax = box.bounds()
  2231. px = 0.5 * (xmin + xmax)
  2232. py = 0.5 * (ymin + ymax)
  2233. obj.app.new_object("excellon", name + "_aligndrill", alligndrill_init_me)
  2234. except Exception, e:
  2235. return "Operation failed: %s" % str(e)
  2236. else:
  2237. try:
  2238. dist = float(kwa['dist'])
  2239. except KeyError:
  2240. dist = 0.0
  2241. except ValueError:
  2242. return "Invalid distance: %s" % kwa['dist']
  2243. try:
  2244. px=dist
  2245. py=dist
  2246. obj.app.new_object("excellon", name + "_alligndrill", alligndrill_init_me)
  2247. except Exception, e:
  2248. return "Operation failed: %s" % str(e)
  2249. return 'Ok'
  2250. def drillcncjob(name=None, *args):
  2251. '''
  2252. TCL shell command - see help section
  2253. :param name: name of object
  2254. :param args: array of arguments
  2255. :return: "Ok" if completed without errors
  2256. '''
  2257. try:
  2258. a, kwa = h(*args)
  2259. types = {'tools': str,
  2260. 'outname': str,
  2261. 'drillz': float,
  2262. 'travelz': float,
  2263. 'feedrate': float,
  2264. 'spindlespeed': int,
  2265. 'toolchange': int
  2266. }
  2267. if name is None:
  2268. self.raise_tcl_error('Argument name is missing.')
  2269. for key in kwa:
  2270. if key not in types:
  2271. self.raise_tcl_error('Unknown parameter: %s' % key)
  2272. try:
  2273. kwa[key] = types[key](kwa[key])
  2274. except Exception, e:
  2275. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, str(types[key])))
  2276. try:
  2277. obj = self.collection.get_by_name(str(name))
  2278. except:
  2279. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2280. if obj is None:
  2281. self.raise_tcl_error('Object not found: %s' % name)
  2282. if not isinstance(obj, FlatCAMExcellon):
  2283. self.raise_tcl_error('Only Excellon objects can be drilled, got %s %s.' % (name, type(obj)))
  2284. try:
  2285. # Get the tools from the list
  2286. job_name = kwa["outname"]
  2287. # Object initialization function for app.new_object()
  2288. def job_init(job_obj, app_obj):
  2289. job_obj.z_cut = kwa["drillz"]
  2290. job_obj.z_move = kwa["travelz"]
  2291. job_obj.feedrate = kwa["feedrate"]
  2292. job_obj.spindlespeed = kwa["spindlespeed"] if "spindlespeed" in kwa else None
  2293. toolchange = True if "toolchange" in kwa and kwa["toolchange"] == 1 else False
  2294. job_obj.generate_from_excellon_by_tool(obj, kwa["tools"], toolchange)
  2295. job_obj.gcode_parse()
  2296. job_obj.create_geometry()
  2297. obj.app.new_object("cncjob", job_name, job_init)
  2298. except Exception, e:
  2299. self.raise_tcl_error("Operation failed: %s" % str(e))
  2300. except Exception as unknown:
  2301. self.raise_tcl_unknown_error(unknown)
  2302. def millholes(name=None, *args):
  2303. '''
  2304. TCL shell command - see help section
  2305. :param name: name of object
  2306. :param args: array of arguments
  2307. :return: "Ok" if completed without errors
  2308. '''
  2309. try:
  2310. a, kwa = h(*args)
  2311. types = {'tooldia': float,
  2312. 'tools': str,
  2313. 'outname': str}
  2314. if name is None:
  2315. self.raise_tcl_error('Argument name is missing.')
  2316. for key in kwa:
  2317. if key not in types:
  2318. self.raise_tcl_error('Unknown parameter: %s' % key)
  2319. try:
  2320. kwa[key] = types[key](kwa[key])
  2321. except Exception, e:
  2322. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2323. try:
  2324. if 'tools' in kwa:
  2325. kwa['tools'] = [x.strip() for x in kwa['tools'].split(",")]
  2326. except Exception as e:
  2327. self.raise_tcl_error("Bad tools: %s" % str(e))
  2328. try:
  2329. obj = self.collection.get_by_name(str(name))
  2330. except:
  2331. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2332. if obj is None:
  2333. self.raise_tcl_error("Object not found: %s" % name)
  2334. if not isinstance(obj, FlatCAMExcellon):
  2335. self.raise_tcl_error('Only Excellon objects can be mill drilled, got %s %s.' % (name, type(obj)))
  2336. try:
  2337. success, msg = obj.generate_milling(**kwa)
  2338. except Exception as e:
  2339. self.raise_tcl_error("Operation failed: %s" % str(e))
  2340. if not success:
  2341. self.raise_tcl_error(msg)
  2342. except Exception as unknown:
  2343. self.raise_tcl_unknown_error(unknown)
  2344. def exteriors(name=None, *args):
  2345. '''
  2346. TCL shell command - see help section
  2347. :param name: name of object
  2348. :param args: array of arguments
  2349. :return: "Ok" if completed without errors
  2350. '''
  2351. try:
  2352. a, kwa = h(*args)
  2353. types = {'outname': str}
  2354. if name is None:
  2355. self.raise_tcl_error('Argument name is missing.')
  2356. for key in kwa:
  2357. if key not in types:
  2358. self.raise_tcl_error('Unknown parameter: %s' % key)
  2359. try:
  2360. kwa[key] = types[key](kwa[key])
  2361. except Exception, e:
  2362. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2363. try:
  2364. obj = self.collection.get_by_name(str(name))
  2365. except:
  2366. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2367. if obj is None:
  2368. self.raise_tcl_error("Object not found: %s" % name)
  2369. if not isinstance(obj, Geometry):
  2370. self.raise_tcl_error('Expected Geometry, got %s %s.' % (name, type(obj)))
  2371. def geo_init(geo_obj, app_obj):
  2372. geo_obj.solid_geometry = obj_exteriors
  2373. if 'outname' in kwa:
  2374. outname = kwa['outname']
  2375. else:
  2376. outname = name + ".exteriors"
  2377. try:
  2378. obj_exteriors = obj.get_exteriors()
  2379. self.new_object('geometry', outname, geo_init)
  2380. except Exception as e:
  2381. self.raise_tcl_error("Failed: %s" % str(e))
  2382. except Exception as unknown:
  2383. self.raise_tcl_unknown_error(unknown)
  2384. def interiors(name=None, *args):
  2385. '''
  2386. TCL shell command - see help section
  2387. :param name: name of object
  2388. :param args: array of arguments
  2389. :return: "Ok" if completed without errors
  2390. '''
  2391. try:
  2392. a, kwa = h(*args)
  2393. types = {'outname': str}
  2394. for key in kwa:
  2395. if key not in types:
  2396. self.raise_tcl_error('Unknown parameter: %s' % key)
  2397. try:
  2398. kwa[key] = types[key](kwa[key])
  2399. except Exception, e:
  2400. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2401. if name is None:
  2402. self.raise_tcl_error('Argument name is missing.')
  2403. try:
  2404. obj = self.collection.get_by_name(str(name))
  2405. except:
  2406. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2407. if obj is None:
  2408. self.raise_tcl_error("Object not found: %s" % name)
  2409. if not isinstance(obj, Geometry):
  2410. self.raise_tcl_error('Expected Geometry, got %s %s.' % (name, type(obj)))
  2411. def geo_init(geo_obj, app_obj):
  2412. geo_obj.solid_geometry = obj_interiors
  2413. if 'outname' in kwa:
  2414. outname = kwa['outname']
  2415. else:
  2416. outname = name + ".interiors"
  2417. try:
  2418. obj_interiors = obj.get_interiors()
  2419. self.new_object('geometry', outname, geo_init)
  2420. except Exception as e:
  2421. self.raise_tcl_error("Failed: %s" % str(e))
  2422. except Exception as unknown:
  2423. self.raise_tcl_unknown_error(unknown)
  2424. def isolate(name=None, *args):
  2425. '''
  2426. TCL shell command - see help section
  2427. :param name: name of object
  2428. :param args: array of arguments
  2429. :return: "Ok" if completed without errors
  2430. '''
  2431. a, kwa = h(*args)
  2432. types = {'dia': float,
  2433. 'passes': int,
  2434. 'overlap': float,
  2435. 'outname': str,
  2436. 'combine': int}
  2437. for key in kwa:
  2438. if key not in types:
  2439. self.raise_tcl_error('Unknown parameter: %s' % key)
  2440. try:
  2441. kwa[key] = types[key](kwa[key])
  2442. except Exception, e:
  2443. self.raise_tcl_error("Cannot cast argument '%s' to type %s." % (key, types[key]))
  2444. try:
  2445. obj = self.collection.get_by_name(str(name))
  2446. except:
  2447. self.raise_tcl_error("Could not retrieve object: %s" % name)
  2448. if obj is None:
  2449. self.raise_tcl_error("Object not found: %s" % name)
  2450. assert isinstance(obj, FlatCAMGerber), \
  2451. "Expected a FlatCAMGerber, got %s" % type(obj)
  2452. if not isinstance(obj, FlatCAMGerber):
  2453. self.raise_tcl_error('Expected FlatCAMGerber, got %s %s.' % (name, type(obj)))
  2454. try:
  2455. obj.isolate(**kwa)
  2456. except Exception, e:
  2457. self.raise_tcl_error("Operation failed: %s" % str(e))
  2458. return 'Ok'
  2459. def cncjob(obj_name, *args):
  2460. a, kwa = h(*args)
  2461. types = {'z_cut': float,
  2462. 'z_move': float,
  2463. 'feedrate': float,
  2464. 'tooldia': float,
  2465. 'outname': str,
  2466. 'spindlespeed': int,
  2467. 'multidepth' : bool,
  2468. 'depthperpass' : float
  2469. }
  2470. for key in kwa:
  2471. if key not in types:
  2472. return 'Unknown parameter: %s' % key
  2473. kwa[key] = types[key](kwa[key])
  2474. try:
  2475. obj = self.collection.get_by_name(str(obj_name))
  2476. except:
  2477. return "Could not retrieve object: %s" % obj_name
  2478. if obj is None:
  2479. return "Object not found: %s" % obj_name
  2480. try:
  2481. obj.generatecncjob(**kwa)
  2482. except Exception, e:
  2483. return "Operation failed: %s" % str(e)
  2484. return 'Ok'
  2485. def write_gcode(obj_name, filename, preamble='', postamble=''):
  2486. """
  2487. Requires obj_name to be available. It might still be in the
  2488. making at the time this function is called, so check for
  2489. promises and send to background if there are promises.
  2490. """
  2491. # If there are promised objects, wait until all promises have been fulfilled.
  2492. if self.collection.has_promises():
  2493. def write_gcode_on_object(new_object):
  2494. self.log.debug("write_gcode_on_object(): Disconnecting %s" % write_gcode_on_object)
  2495. self.new_object_available.disconnect(write_gcode_on_object)
  2496. write_gcode(obj_name, filename, preamble, postamble)
  2497. # Try again when a new object becomes available.
  2498. self.log.debug("write_gcode(): Collection has promises. Queued for %s." % obj_name)
  2499. self.log.debug("write_gcode(): Queued function: %s" % write_gcode_on_object)
  2500. self.new_object_available.connect(write_gcode_on_object)
  2501. return
  2502. self.log.debug("write_gcode(): No promises. Continuing for %s." % obj_name)
  2503. try:
  2504. obj = self.collection.get_by_name(str(obj_name))
  2505. except:
  2506. return "Could not retrieve object: %s" % obj_name
  2507. try:
  2508. obj.export_gcode(str(filename), str(preamble), str(postamble))
  2509. except Exception, e:
  2510. return "Operation failed: %s" % str(e)
  2511. def paint_poly(obj_name, inside_pt_x, inside_pt_y, tooldia, overlap):
  2512. try:
  2513. obj = self.collection.get_by_name(str(obj_name))
  2514. except:
  2515. return "Could not retrieve object: %s" % obj_name
  2516. if obj is None:
  2517. return "Object not found: %s" % obj_name
  2518. obj.paint_poly([float(inside_pt_x), float(inside_pt_y)], float(tooldia), float(overlap))
  2519. def add_poly(obj_name, *args):
  2520. if len(args) % 2 != 0:
  2521. return "Incomplete coordinate."
  2522. points = [[float(args[2*i]), float(args[2*i+1])] for i in range(len(args)/2)]
  2523. try:
  2524. obj = self.collection.get_by_name(str(obj_name))
  2525. except:
  2526. return "Could not retrieve object: %s" % obj_name
  2527. if obj is None:
  2528. return "Object not found: %s" % obj_name
  2529. obj.add_polygon(points)
  2530. def add_rectangle(obj_name, botleft_x, botleft_y, topright_x, topright_y):
  2531. return add_poly(obj_name, botleft_x, botleft_y, botleft_x, topright_y,
  2532. topright_x, topright_y, topright_x, botleft_y)
  2533. def subtract_poly(obj_name, *args):
  2534. if len(args) % 2 != 0:
  2535. return "Incomplete coordinate."
  2536. points = [[float(args[2*i]), float(args[2*i+1])] for i in range(len(args)/2)]
  2537. try:
  2538. obj = self.collection.get_by_name(str(obj_name))
  2539. except:
  2540. return "Could not retrieve object: %s" % obj_name
  2541. if obj is None:
  2542. return "Object not found: %s" % obj_name
  2543. obj.subtract_polygon(points)
  2544. obj.plot()
  2545. return "OK."
  2546. def subtract_rectangle(obj_name, botleft_x, botleft_y, topright_x, topright_y):
  2547. return subtract_poly(obj_name, botleft_x, botleft_y, botleft_x, topright_y,
  2548. topright_x, topright_y, topright_x, botleft_y)
  2549. def add_circle(obj_name, center_x, center_y, radius):
  2550. try:
  2551. obj = self.collection.get_by_name(str(obj_name))
  2552. except:
  2553. return "Could not retrieve object: %s" % obj_name
  2554. if obj is None:
  2555. return "Object not found: %s" % obj_name
  2556. obj.add_circle([float(center_x), float(center_y)], float(radius))
  2557. def set_active(obj_name):
  2558. try:
  2559. self.collection.set_active(str(obj_name))
  2560. except Exception, e:
  2561. return "Command failed: %s" % str(e)
  2562. def delete(obj_name):
  2563. try:
  2564. #deselect all to avoid delete selected object when run delete from shell
  2565. self.collection.set_all_inactive()
  2566. self.collection.set_active(str(obj_name))
  2567. self.on_delete()
  2568. except Exception, e:
  2569. return "Command failed: %s" % str(e)
  2570. def geo_union(obj_name):
  2571. try:
  2572. obj = self.collection.get_by_name(str(obj_name))
  2573. except:
  2574. return "Could not retrieve object: %s" % obj_name
  2575. if obj is None:
  2576. return "Object not found: %s" % obj_name
  2577. obj.union()
  2578. def join_geometries(obj_name, *obj_names):
  2579. objs = []
  2580. for obj_n in obj_names:
  2581. obj = self.collection.get_by_name(str(obj_n))
  2582. if obj is None:
  2583. return "Object not found: %s" % obj_n
  2584. else:
  2585. objs.append(obj)
  2586. def initialize(obj, app):
  2587. FlatCAMGeometry.merge(objs, obj)
  2588. if objs is not None:
  2589. self.new_object("geometry", obj_name, initialize)
  2590. def join_excellons(obj_name, *obj_names):
  2591. objs = []
  2592. for obj_n in obj_names:
  2593. obj = self.collection.get_by_name(str(obj_n))
  2594. if obj is None:
  2595. return "Object not found: %s" % obj_n
  2596. else:
  2597. objs.append(obj)
  2598. def initialize(obj, app):
  2599. FlatCAMExcellon.merge(objs, obj)
  2600. if objs is not None:
  2601. self.new_object("excellon", obj_name, initialize)
  2602. def panelize(name, *args):
  2603. a, kwa = h(*args)
  2604. types = {'box': str,
  2605. 'spacing_columns': float,
  2606. 'spacing_rows': float,
  2607. 'columns': int,
  2608. 'rows': int,
  2609. 'outname': str}
  2610. for key in kwa:
  2611. if key not in types:
  2612. return 'Unknown parameter: %s' % key
  2613. kwa[key] = types[key](kwa[key])
  2614. # Get source object.
  2615. try:
  2616. obj = self.collection.get_by_name(str(name))
  2617. except:
  2618. return "Could not retrieve object: %s" % name
  2619. if obj is None:
  2620. return "Object not found: %s" % name
  2621. if 'box' in kwa:
  2622. boxname=kwa['box']
  2623. try:
  2624. box = self.collection.get_by_name(boxname)
  2625. except:
  2626. return "Could not retrieve object: %s" % name
  2627. else:
  2628. box=obj
  2629. if 'columns' not in kwa or 'rows' not in kwa:
  2630. return "ERROR: Specify -columns and -rows"
  2631. if 'outname' in kwa:
  2632. outname=kwa['outname']
  2633. else:
  2634. outname=name+'_panelized'
  2635. if 'spacing_columns' in kwa:
  2636. spacing_columns=kwa['spacing_columns']
  2637. else:
  2638. spacing_columns=5
  2639. if 'spacing_rows' in kwa:
  2640. spacing_rows=kwa['spacing_rows']
  2641. else:
  2642. spacing_rows=5
  2643. xmin, ymin, xmax, ymax = box.bounds()
  2644. lenghtx = xmax-xmin+spacing_columns
  2645. lenghty = ymax-ymin+spacing_rows
  2646. currenty=0
  2647. def initialize_local(obj_init, app):
  2648. obj_init.solid_geometry = obj.solid_geometry
  2649. obj_init.offset([float(currentx), float(currenty)]),
  2650. def initialize_local_excellon(obj_init, app):
  2651. FlatCAMExcellon.merge(obj, obj_init)
  2652. obj_init.offset([float(currentx), float(currenty)]),
  2653. def initialize_geometry(obj_init, app):
  2654. FlatCAMGeometry.merge(objs, obj_init)
  2655. def initialize_excellon(obj_init, app):
  2656. FlatCAMExcellon.merge(objs, obj_init)
  2657. objs=[]
  2658. if obj is not None:
  2659. for row in range(kwa['rows']):
  2660. currentx=0
  2661. for col in range(kwa['columns']):
  2662. local_outname=outname+".tmp."+str(col)+"."+str(row)
  2663. if isinstance(obj, FlatCAMExcellon):
  2664. new_obj=self.new_object("excellon", local_outname, initialize_local_excellon)
  2665. else:
  2666. new_obj=self.new_object("geometry", local_outname, initialize_local)
  2667. objs.append(new_obj)
  2668. currentx=currentx+lenghtx
  2669. currenty=currenty+lenghty
  2670. if isinstance(obj, FlatCAMExcellon):
  2671. self.new_object("excellon", outname, initialize_excellon)
  2672. else:
  2673. self.new_object("geometry", outname, initialize_geometry)
  2674. #deselect all to avoid delete selected object when run delete from shell
  2675. self.collection.set_all_inactive()
  2676. for delobj in objs:
  2677. self.collection.set_active(delobj.options['name'])
  2678. self.on_delete()
  2679. else:
  2680. return "ERROR: obj is None"
  2681. return "Ok"
  2682. def make_docs():
  2683. output = ''
  2684. import collections
  2685. od = collections.OrderedDict(sorted(commands.items()))
  2686. for cmd, val in od.iteritems():
  2687. #print cmd, '\n', ''.join(['~']*len(cmd))
  2688. output += cmd + ' \n' + ''.join(['~'] * len(cmd)) + '\n'
  2689. t = val['help']
  2690. usage_i = t.find('>')
  2691. if usage_i < 0:
  2692. expl = t
  2693. #print expl + '\n'
  2694. output += expl + '\n\n'
  2695. continue
  2696. expl = t[:usage_i - 1]
  2697. #print expl + '\n'
  2698. output += expl + '\n\n'
  2699. end_usage_i = t[usage_i:].find('\n')
  2700. if end_usage_i < 0:
  2701. end_usage_i = len(t[usage_i:])
  2702. #print ' ' + t[usage_i:]
  2703. #print ' No parameters.\n'
  2704. output += ' ' + t[usage_i:] + '\n No parameters.\n'
  2705. else:
  2706. extras = t[usage_i+end_usage_i+1:]
  2707. parts = [s.strip() for s in extras.split('\n')]
  2708. #print ' ' + t[usage_i:usage_i+end_usage_i]
  2709. output += ' ' + t[usage_i:usage_i+end_usage_i] + '\n'
  2710. for p in parts:
  2711. #print ' ' + p + '\n'
  2712. output += ' ' + p + '\n\n'
  2713. return output
  2714. def follow(obj_name, *args):
  2715. a, kwa = h(*args)
  2716. types = {'outname': str}
  2717. for key in kwa:
  2718. if key not in types:
  2719. return 'Unknown parameter: %s' % key
  2720. kwa[key] = types[key](kwa[key])
  2721. try:
  2722. obj = self.collection.get_by_name(str(obj_name))
  2723. except:
  2724. return "Could not retrieve object: %s" % obj_name
  2725. if obj is None:
  2726. return "Object not found: %s" % obj_name
  2727. try:
  2728. obj.follow(**kwa)
  2729. except Exception, e:
  2730. return "ERROR: %s" % str(e)
  2731. def get_sys(param):
  2732. if param in self.defaults:
  2733. return self.defaults[param]
  2734. return "ERROR: No such system parameter."
  2735. def set_sys(param, value):
  2736. # tcl string to python keywords:
  2737. tcl2py = {
  2738. "None": None,
  2739. "none": None,
  2740. "false": False,
  2741. "False": False,
  2742. "true": True,
  2743. "True": True
  2744. }
  2745. if param in self.defaults:
  2746. try:
  2747. value = tcl2py[value]
  2748. except KeyError:
  2749. pass
  2750. self.defaults[param] = value
  2751. self.propagate_defaults()
  2752. return "Ok"
  2753. return "ERROR: No such system parameter."
  2754. '''
  2755. Howto implement TCL shell commands:
  2756. All parameters passed to command should be possible to set as None and test it afterwards.
  2757. This is because we need to see error caused in tcl,
  2758. if None value as default parameter is not allowed TCL will return empty error.
  2759. Use:
  2760. def mycommand(name=None,...):
  2761. Test it like this:
  2762. if name is None:
  2763. self.raise_tcl_error('Argument name is missing.')
  2764. When error ocurre, always use raise_tcl_error, never return "sometext" on error,
  2765. otherwise we will miss it and processing will silently continue.
  2766. Method raise_tcl_error pass error into TCL interpreter, then raise python exception,
  2767. which is catched in exec_command and displayed in TCL shell console with red background.
  2768. Error in console is displayed with TCL trace.
  2769. This behavior works only within main thread,
  2770. errors with promissed tasks can be catched and detected only with log.
  2771. TODO: this problem have to be addressed somehow, maybe rewrite promissing to be blocking somehow for TCL shell.
  2772. Kamil's comment: I will rewrite existing TCL commands from time to time to follow this rules.
  2773. '''
  2774. commands = {
  2775. 'mytest': {
  2776. 'fcn': mytest,
  2777. 'help': "Test function. Only for testing."
  2778. },
  2779. 'mytest2': {
  2780. 'fcn': mytest2,
  2781. 'help': "Test function. Only for testing."
  2782. },
  2783. 'mytest3': {
  2784. 'fcn': mytest3,
  2785. 'help': "Test function. Only for testing."
  2786. },
  2787. 'mytest4': {
  2788. 'fcn': mytest4,
  2789. 'help': "Test function. Only for testing."
  2790. },
  2791. 'help': {
  2792. 'fcn': shelp,
  2793. 'help': "Shows list of commands."
  2794. },
  2795. 'import_svg': {
  2796. 'fcn': import_svg,
  2797. 'help': "Import an SVG file as a Geometry Object.\n" +
  2798. "> import_svg <filename>" +
  2799. " filename: Path to the file to import."
  2800. },
  2801. 'export_svg': {
  2802. 'fcn': export_svg,
  2803. 'help': "Export a Geometry Object as a SVG File\n" +
  2804. "> export_svg <name> <filename> [-scale_factor <0.0 (float)>]\n" +
  2805. " name: Name of the geometry object to export.\n" +
  2806. " filename: Path to the file to export.\n" +
  2807. " scale_factor: Multiplication factor used for scaling line widths during export."
  2808. },
  2809. 'open_gerber': {
  2810. 'fcn': open_gerber,
  2811. 'help': "Opens a Gerber file.\n"
  2812. "> open_gerber <filename> [-follow <0|1>] [-outname <o>]\n"
  2813. " filename: Path to file to open.\n" +
  2814. " follow: If 1, does not create polygons, just follows the gerber path.\n" +
  2815. " outname: Name of the created gerber object."
  2816. },
  2817. 'open_excellon': {
  2818. 'fcn': open_excellon,
  2819. 'help': "Opens an Excellon file.\n" +
  2820. "> open_excellon <filename> [-outname <o>]\n" +
  2821. " filename: Path to file to open.\n" +
  2822. " outname: Name of the created excellon object."
  2823. },
  2824. 'open_gcode': {
  2825. 'fcn': open_gcode,
  2826. 'help': "Opens an G-Code file.\n" +
  2827. "> open_gcode <filename> [-outname <o>]\n" +
  2828. " filename: Path to file to open.\n" +
  2829. " outname: Name of the created CNC Job object."
  2830. },
  2831. 'open_project': {
  2832. 'fcn': self.open_project,
  2833. "help": "Opens a FlatCAM project.\n" +
  2834. "> open_project <filename>\n" +
  2835. " filename: Path to file to open."
  2836. },
  2837. 'save_project': {
  2838. 'fcn': self.save_project,
  2839. 'help': "Saves the FlatCAM project to file.\n" +
  2840. "> save_project <filename>\n" +
  2841. " filename: Path to file to save."
  2842. },
  2843. 'set_active': {
  2844. 'fcn': set_active,
  2845. 'help': "Sets a FlatCAM object as active.\n" +
  2846. "> set_active <name>\n" +
  2847. " name: Name of the object."
  2848. },
  2849. 'get_names': {
  2850. 'fcn': lambda: '\n'.join(self.collection.get_names()),
  2851. 'help': "Lists the names of objects in the project.\n" +
  2852. "> get_names"
  2853. },
  2854. 'new': {
  2855. 'fcn': self.on_file_new,
  2856. 'help': "Starts a new project. Clears objects from memory.\n" +
  2857. "> new"
  2858. },
  2859. 'options': {
  2860. 'fcn': options,
  2861. 'help': "Shows the settings for an object.\n" +
  2862. "> options <name>\n" +
  2863. " name: Object name."
  2864. },
  2865. 'isolate': {
  2866. 'fcn': isolate,
  2867. 'help': "Creates isolation routing geometry for the given Gerber.\n" +
  2868. "> isolate <name> [-dia <d>] [-passes <p>] [-overlap <o>] [-combine 0|1]\n" +
  2869. " name: Name of the object.\n"
  2870. " dia: Tool diameter\n passes: # of tool width.\n" +
  2871. " overlap: Fraction of tool diameter to overlap passes." +
  2872. " combine: combine all passes into one geometry." +
  2873. " outname: Name of the resulting Geometry object."
  2874. },
  2875. 'cutout': {
  2876. 'fcn': cutout,
  2877. 'help': "Creates board cutout.\n" +
  2878. "> cutout <name> [-dia <3.0 (float)>] [-margin <0.0 (float)>] [-gapsize <0.5 (float)>] [-gaps <lr (4|tb|lr)>]\n" +
  2879. " name: Name of the object\n" +
  2880. " dia: Tool diameter\n" +
  2881. " margin: Margin over bounds\n" +
  2882. " gapsize: size of gap\n" +
  2883. " gaps: type of gaps"
  2884. },
  2885. 'geocutout': {
  2886. 'fcn': geocutout,
  2887. 'help': "Cut holding gaps from geometry.\n" +
  2888. "> geocutout <name> [-dia <3.0 (float)>] [-margin <0.0 (float)>] [-gapsize <0.5 (float)>] [-gaps <lr (8|4|tb|lr|2tb|2lr)>]\n" +
  2889. " name: Name of the geometry object\n" +
  2890. " dia: Tool diameter\n" +
  2891. " margin: Margin over bounds\n" +
  2892. " gapsize: size of gap\n" +
  2893. " gaps: type of gaps\n" +
  2894. "\n" +
  2895. " example:\n" +
  2896. "\n" +
  2897. " #isolate margin for example from fritzing arduino shield or any svg etc\n" +
  2898. " isolate BCu_margin -dia 3 -overlap 1\n" +
  2899. "\n" +
  2900. " #create exteriors from isolated object\n" +
  2901. " exteriors BCu_margin_iso -outname BCu_margin_iso_exterior\n" +
  2902. "\n" +
  2903. " #delete isolated object if you dond need id anymore\n" +
  2904. " delete BCu_margin_iso\n" +
  2905. "\n" +
  2906. " #finally cut holding gaps\n" +
  2907. " geocutout BCu_margin_iso_exterior -dia 3 -gapsize 0.6 -gaps 4\n"
  2908. },
  2909. 'mirror': {
  2910. 'fcn': mirror,
  2911. 'help': "Mirror a layer.\n" +
  2912. "> mirror <name> -axis <X|Y> [-box <nameOfBox> | -dist <number>]\n" +
  2913. " name: Name of the object (Gerber or Excellon) to mirror.\n" +
  2914. " box: Name of object which act as box (cutout for example.)\n" +
  2915. " axis: Mirror axis parallel to the X or Y axis.\n" +
  2916. " dist: Distance of the mirror axis to the X or Y axis."
  2917. },
  2918. 'aligndrillgrid': {
  2919. 'fcn': aligndrillgrid,
  2920. 'help': "Create excellon with drills for aligment grid.\n" +
  2921. "> aligndrillgrid <outname> [-dia <3.0 (float)>] -gridx <float> [-gridoffsetx <0 (float)>] -gridy <float> [-gridoffsety <0 (float)>] -columns <int> -rows <int>\n" +
  2922. " outname: Name of the object to create.\n" +
  2923. " dia: Tool diameter\n" +
  2924. " gridx: grid size in X axis\n" +
  2925. " gridoffsetx: move grid from origin\n" +
  2926. " gridy: grid size in Y axis\n" +
  2927. " gridoffsety: move grid from origin\n" +
  2928. " colums: grid holes on X axis\n" +
  2929. " rows: grid holes on Y axis\n"
  2930. },
  2931. 'aligndrill': {
  2932. 'fcn': aligndrill,
  2933. 'help': "Create excellon with drills for aligment.\n" +
  2934. "> aligndrill <name> [-dia <3.0 (float)>] -axis <X|Y> [-box <nameOfBox> -minoffset <float> [-grid <10 (float)> -gridoffset <5 (float)> [-axisoffset <0 (float)>]] | -dist <number>]\n" +
  2935. " name: Name of the object (Gerber or Excellon) to mirror.\n" +
  2936. " dia: Tool diameter\n" +
  2937. " box: Name of object which act as box (cutout for example.)\n" +
  2938. " grid: aligning to grid, for thouse, who have aligning pins inside table in grid (-5,0),(5,0),(15,0)..." +
  2939. " gridoffset: offset of grid from 0 position" +
  2940. " minoffset: min and max distance between align hole and pcb" +
  2941. " axisoffset: offset on second axis before aligment holes" +
  2942. " axis: Mirror axis parallel to the X or Y axis.\n" +
  2943. " dist: Distance of the mirror axis to the X or Y axis."
  2944. },
  2945. 'exteriors': {
  2946. 'fcn': exteriors,
  2947. 'help': "Get exteriors of polygons.\n" +
  2948. "> exteriors <name> [-outname <outname>]\n" +
  2949. " name: Name of the source Geometry object.\n" +
  2950. " outname: Name of the resulting Geometry object."
  2951. },
  2952. 'interiors': {
  2953. 'fcn': interiors,
  2954. 'help': "Get interiors of polygons.\n" +
  2955. "> interiors <name> [-outname <outname>]\n" +
  2956. " name: Name of the source Geometry object.\n" +
  2957. " outname: Name of the resulting Geometry object."
  2958. },
  2959. 'drillcncjob': {
  2960. 'fcn': drillcncjob,
  2961. 'help': "Drill CNC job.\n" +
  2962. "> drillcncjob <name> -tools <str> -drillz <float> " +
  2963. "-travelz <float> -feedrate <float> -outname <str> " +
  2964. "[-spindlespeed (int)] [-toolchange (int)] \n" +
  2965. " name: Name of the object\n" +
  2966. " tools: Comma separated indexes of tools (example: 1,3 or 2)\n" +
  2967. " drillz: Drill depth into material (example: -2.0)\n" +
  2968. " travelz: Travel distance above material (example: 2.0)\n" +
  2969. " feedrate: Drilling feed rate\n" +
  2970. " outname: Name of object to create\n" +
  2971. " spindlespeed: Speed of the spindle in rpm (example: 4000)\n" +
  2972. " toolchange: Enable tool changes (example: 1)\n"
  2973. },
  2974. 'millholes': {
  2975. 'fcn': millholes,
  2976. 'help': "Create Geometry Object for milling holes from Excellon.\n" +
  2977. "> millholes <name> -tools <str> -tooldia <float> -outname <str> \n" +
  2978. " name: Name of the Excellon Object\n" +
  2979. " tools: Comma separated indexes of tools (example: 1,3 or 2)\n" +
  2980. " tooldia: Diameter of the milling tool (example: 0.1)\n" +
  2981. " outname: Name of object to create\n"
  2982. },
  2983. 'scale': {
  2984. 'fcn': lambda name, factor: self.collection.get_by_name(str(name)).scale(float(factor)),
  2985. 'help': "Resizes the object by a factor.\n" +
  2986. "> scale <name> <factor>\n" +
  2987. " name: Name of the object\n factor: Fraction by which to scale"
  2988. },
  2989. 'offset': {
  2990. 'fcn': lambda name, x, y: self.collection.get_by_name(str(name)).offset([float(x), float(y)]),
  2991. 'help': "Changes the position of the object.\n" +
  2992. "> offset <name> <x> <y>\n" +
  2993. " name: Name of the object\n" +
  2994. " x: X-axis distance\n" +
  2995. " y: Y-axis distance"
  2996. },
  2997. 'plot': {
  2998. 'fcn': self.plot_all,
  2999. 'help': 'Updates the plot on the user interface'
  3000. },
  3001. 'cncjob': {
  3002. 'fcn': cncjob,
  3003. 'help': 'Generates a CNC Job from a Geometry Object.\n' +
  3004. '> cncjob <name> [-z_cut <c>] [-z_move <float>] [-feedrate <float>] [-tooldia <float>] [-spindlespeed <int>] [-multidepth <bool>] [-depthperpass <float>] [-outname <str>]\n' +
  3005. ' name: Name of the source object\n' +
  3006. ' z_cut: Z-axis cutting position\n' +
  3007. ' z_move: Z-axis moving position\n' +
  3008. ' feedrate: Moving speed when cutting\n' +
  3009. ' tooldia: Tool diameter to show on screen\n' +
  3010. ' spindlespeed: Speed of the spindle in rpm (example: 4000)\n' +
  3011. ' multidepth: Use or not multidepth cnccut\n'+
  3012. ' depthperpass: Height of one layer for multidepth\n'+
  3013. ' outname: Name of the output object'
  3014. },
  3015. 'write_gcode': {
  3016. 'fcn': write_gcode,
  3017. 'help': 'Saves G-code of a CNC Job object to file.\n' +
  3018. '> write_gcode <name> <filename>\n' +
  3019. ' name: Source CNC Job object\n' +
  3020. ' filename: Output filename'
  3021. },
  3022. 'paint_poly': {
  3023. 'fcn': paint_poly,
  3024. 'help': 'Creates a geometry object with toolpath to cover the inside of a polygon.\n' +
  3025. '> paint_poly <name> <inside_pt_x> <inside_pt_y> <tooldia> <overlap>\n' +
  3026. ' name: Name of the sourge geometry object.\n' +
  3027. ' inside_pt_x, inside_pt_y: Coordinates of a point inside the polygon.\n' +
  3028. ' tooldia: Diameter of the tool to be used.\n' +
  3029. ' overlap: Fraction of the tool diameter to overlap cuts.'
  3030. },
  3031. 'new_geometry': {
  3032. 'fcn': lambda name: self.new_object('geometry', str(name), lambda x, y: None),
  3033. 'help': 'Creates a new empty geometry object.\n' +
  3034. '> new_geometry <name>\n' +
  3035. ' name: New object name'
  3036. },
  3037. 'add_poly': {
  3038. 'fcn': add_poly,
  3039. 'help': 'Creates a polygon in the given Geometry object.\n' +
  3040. '> create_poly <name> <x0> <y0> <x1> <y1> <x2> <y2> [x3 y3 [...]]\n' +
  3041. ' name: Name of the geometry object to which to append the polygon.\n' +
  3042. ' xi, yi: Coordinates of points in the polygon.'
  3043. },
  3044. 'subtract_poly': {
  3045. 'fcn': subtract_poly,
  3046. 'help': 'Subtract polygon from the given Geometry object.\n' +
  3047. '> subtract_poly <name> <x0> <y0> <x1> <y1> <x2> <y2> [x3 y3 [...]]\n' +
  3048. ' name: Name of the geometry object, which will be sutracted.\n' +
  3049. ' xi, yi: Coordinates of points in the polygon.'
  3050. },
  3051. 'delete': {
  3052. 'fcn': delete,
  3053. 'help': 'Deletes the give object.\n' +
  3054. '> delete <name>\n' +
  3055. ' name: Name of the object to delete.'
  3056. },
  3057. 'geo_union': {
  3058. 'fcn': geo_union,
  3059. 'help': 'Runs a union operation (addition) on the components ' +
  3060. 'of the geometry object. For example, if it contains ' +
  3061. '2 intersecting polygons, this opperation adds them into' +
  3062. 'a single larger polygon.\n' +
  3063. '> geo_union <name>\n' +
  3064. ' name: Name of the geometry object.'
  3065. },
  3066. 'join_geometries': {
  3067. 'fcn': join_geometries,
  3068. 'help': 'Runs a merge operation (join) on the geometry ' +
  3069. 'objects.' +
  3070. '> join_geometries <out_name> <obj_name_0>....\n' +
  3071. ' out_name: Name of the new geometry object.' +
  3072. ' obj_name_0... names of the objects to join'
  3073. },
  3074. 'join_excellons': {
  3075. 'fcn': join_excellons,
  3076. 'help': 'Runs a merge operation (join) on the excellon ' +
  3077. 'objects.' +
  3078. '> join_excellons <out_name> <obj_name_0>....\n' +
  3079. ' out_name: Name of the new excellon object.' +
  3080. ' obj_name_0... names of the objects to join'
  3081. },
  3082. 'panelize': {
  3083. 'fcn': panelize,
  3084. 'help': "Simple panelize geometries.\n" +
  3085. "> panelize <name> [-box <nameOfBox>] [-spacing_columns <5 (float)>] [-spacing_rows <5 (float)>] -columns <int> -rows <int> [-outname <n>]\n" +
  3086. " name: Name of the object to panelize.\n" +
  3087. " box: Name of object which act as box (cutout for example.) for cutout boundary. Object from name is used if not specified.\n" +
  3088. " spacing_columns: spacing between columns\n"+
  3089. " spacing_rows: spacing between rows\n"+
  3090. " columns: number of columns\n"+
  3091. " rows: number of rows\n"+
  3092. " outname: Name of the new geometry object."
  3093. },
  3094. 'subtract_rect': {
  3095. 'fcn': subtract_rectangle,
  3096. 'help': 'Subtract rectange from the given Geometry object.\n' +
  3097. '> subtract_rect <name> <botleft_x> <botleft_y> <topright_x> <topright_y>\n' +
  3098. ' name: Name of the geometry object, which will be subtracted.\n' +
  3099. ' botleft_x, botleft_y: Coordinates of the bottom left corner.\n' +
  3100. ' topright_x, topright_y Coordinates of the top right corner.'
  3101. },
  3102. 'add_rect': {
  3103. 'fcn': add_rectangle,
  3104. 'help': 'Creates a rectange in the given Geometry object.\n' +
  3105. '> add_rect <name> <botleft_x> <botleft_y> <topright_x> <topright_y>\n' +
  3106. ' name: Name of the geometry object to which to append the rectangle.\n' +
  3107. ' botleft_x, botleft_y: Coordinates of the bottom left corner.\n' +
  3108. ' topright_x, topright_y Coordinates of the top right corner.'
  3109. },
  3110. 'add_circle': {
  3111. 'fcn': add_circle,
  3112. 'help': 'Creates a circle in the given Geometry object.\n' +
  3113. '> add_circle <name> <center_x> <center_y> <radius>\n' +
  3114. ' name: Name of the geometry object to which to append the circle.\n' +
  3115. ' center_x, center_y: Coordinates of the center of the circle.\n' +
  3116. ' radius: Radius of the circle.'
  3117. },
  3118. 'make_docs': {
  3119. 'fcn': make_docs,
  3120. 'help': 'Prints command rererence in reStructuredText format.'
  3121. },
  3122. 'follow': {
  3123. 'fcn': follow,
  3124. 'help': 'Creates a geometry object following gerber paths.\n' +
  3125. '> follow <name> [-outname <oname>]\n' +
  3126. ' name: Name of the gerber object.\n' +
  3127. ' outname: Name of the output geometry object.'
  3128. },
  3129. 'get_sys': {
  3130. 'fcn': get_sys,
  3131. 'help': 'Get the value of a system parameter (FlatCAM constant)\n' +
  3132. '> get_sys <sysparam>\n' +
  3133. ' sysparam: Name of the parameter.'
  3134. },
  3135. 'set_sys': {
  3136. 'fcn': set_sys,
  3137. 'help': 'Set the value of a system parameter (FlatCAM constant)\n' +
  3138. '> set_sys <sysparam> <paramvalue>\n' +
  3139. ' sysparam: Name of the parameter.\n' +
  3140. ' paramvalue: Value to set.'
  3141. }
  3142. }
  3143. #import/overwrite tcl commands as objects of TclCommand descendants
  3144. tclCommands.register_all_commands(self, commands)
  3145. # Add commands to the tcl interpreter
  3146. for cmd in commands:
  3147. self.tcl.createcommand(cmd, commands[cmd]['fcn'])
  3148. # Make the tcl puts function return instead of print to stdout
  3149. self.tcl.eval('''
  3150. rename puts original_puts
  3151. proc puts {args} {
  3152. if {[llength $args] == 1} {
  3153. return "[lindex $args 0]"
  3154. } else {
  3155. eval original_puts $args
  3156. }
  3157. }
  3158. ''')
  3159. def setup_recent_items(self):
  3160. self.log.debug("setup_recent_items()")
  3161. # TODO: Move this to constructor
  3162. icons = {
  3163. "gerber": "share/flatcam_icon16.png",
  3164. "excellon": "share/drill16.png",
  3165. "cncjob": "share/cnc16.png",
  3166. "project": "share/project16.png",
  3167. "svg": "share/geometry16.png"
  3168. }
  3169. openers = {
  3170. 'gerber': lambda fname: self.worker_task.emit({'fcn': self.open_gerber, 'params': [fname]}),
  3171. 'excellon': lambda fname: self.worker_task.emit({'fcn': self.open_excellon, 'params': [fname]}),
  3172. 'cncjob': lambda fname: self.worker_task.emit({'fcn': self.open_gcode, 'params': [fname]}),
  3173. 'project': self.open_project,
  3174. 'svg': self.import_svg
  3175. }
  3176. # Open file
  3177. try:
  3178. f = open(self.data_path + '/recent.json')
  3179. except IOError:
  3180. App.log.error("Failed to load recent item list.")
  3181. self.inform.emit("[error] Failed to load recent item list.")
  3182. return
  3183. try:
  3184. self.recent = json.load(f)
  3185. except json.scanner.JSONDecodeError:
  3186. App.log.error("Failed to parse recent item list.")
  3187. self.inform.emit("[error] Failed to parse recent item list.")
  3188. f.close()
  3189. return
  3190. f.close()
  3191. # Closure needed to create callbacks in a loop.
  3192. # Otherwise late binding occurs.
  3193. def make_callback(func, fname):
  3194. def opener():
  3195. func(fname)
  3196. return opener
  3197. # Reset menu
  3198. self.ui.recent.clear()
  3199. # Create menu items
  3200. for recent in self.recent:
  3201. filename = recent['filename'].split('/')[-1].split('\\')[-1]
  3202. try:
  3203. action = QtGui.QAction(QtGui.QIcon(icons[recent["kind"]]), filename, self)
  3204. # Attach callback
  3205. o = make_callback(openers[recent["kind"]], recent['filename'])
  3206. action.triggered.connect(o)
  3207. self.ui.recent.addAction(action)
  3208. except KeyError:
  3209. App.log.error("Unsupported file type: %s" % recent["kind"])
  3210. # self.builder.get_object('open_recent').set_submenu(recent_menu)
  3211. # self.ui.menufilerecent.set_submenu(recent_menu)
  3212. # recent_menu.show_all()
  3213. # self.ui.recent.show()
  3214. def setup_component_editor(self):
  3215. label = QtGui.QLabel("Choose an item from Project")
  3216. label.setAlignment(QtCore.Qt.AlignHCenter | QtCore.Qt.AlignVCenter)
  3217. self.ui.selected_scroll_area.setWidget(label)
  3218. def setup_obj_classes(self):
  3219. """
  3220. Sets up application specifics on the FlatCAMObj class.
  3221. :return: None
  3222. """
  3223. FlatCAMObj.app = self
  3224. FCProcess.app = self
  3225. FCProcessContainer.app = self
  3226. def version_check(self):
  3227. """
  3228. Checks for the latest version of the program. Alerts the
  3229. user if theirs is outdated. This method is meant to be run
  3230. in a separate thread.
  3231. :return: None
  3232. """
  3233. self.log.debug("version_check()")
  3234. full_url = App.version_url + \
  3235. "?s=" + str(self.defaults['serial']) + \
  3236. "&v=" + str(self.version) + \
  3237. "&os=" + str(self.os) + \
  3238. "&" + urllib.urlencode(self.defaults["stats"])
  3239. App.log.debug("Checking for updates @ %s" % full_url)
  3240. ### Get the data
  3241. try:
  3242. f = urllib.urlopen(full_url)
  3243. except:
  3244. # App.log.warning("Failed checking for latest version. Could not connect.")
  3245. self.log.warning("Failed checking for latest version. Could not connect.")
  3246. self.inform.emit("[warning] Failed checking for latest version. Could not connect.")
  3247. return
  3248. try:
  3249. data = json.load(f)
  3250. except Exception, e:
  3251. App.log.error("Could not parse information about latest version.")
  3252. self.inform.emit("[error] Could not parse information about latest version.")
  3253. App.log.debug("json.load(): %s" % str(e))
  3254. f.close()
  3255. return
  3256. f.close()
  3257. ### Latest version?
  3258. if self.version >= data["version"]:
  3259. App.log.debug("FlatCAM is up to date!")
  3260. self.inform.emit("[success] FlatCAM is up to date!")
  3261. return
  3262. App.log.debug("Newer version available.")
  3263. self.message.emit(
  3264. "Newer Version Available",
  3265. QtCore.QString("There is a newer version of FlatCAM " +
  3266. "available for download:<br><br>" +
  3267. "<B>" + data["name"] + "</b><br>" +
  3268. data["message"].replace("\n", "<br>")),
  3269. "info"
  3270. )
  3271. def enable_all_plots(self, *args):
  3272. self.plotcanvas.clear()
  3273. def worker_task(app_obj):
  3274. percentage = 0.1
  3275. try:
  3276. delta = 0.9 / len(self.collection.get_list())
  3277. except ZeroDivisionError:
  3278. self.progress.emit(0)
  3279. return
  3280. for obj in self.collection.get_list():
  3281. obj.options['plot'] = True
  3282. obj.plot()
  3283. percentage += delta
  3284. self.progress.emit(int(percentage*100))
  3285. self.progress.emit(0)
  3286. self.plots_updated.emit()
  3287. # Send to worker
  3288. # self.worker.add_task(worker_task, [self])
  3289. self.worker_task.emit({'fcn': worker_task, 'params': [self]})
  3290. def save_project(self, filename):
  3291. """
  3292. Saves the current project to the specified file.
  3293. :param filename: Name of the file in which to save.
  3294. :type filename: str
  3295. :return: None
  3296. """
  3297. self.log.debug("save_project()")
  3298. ## Capture the latest changes
  3299. # Current object
  3300. try:
  3301. self.collection.get_active().read_form()
  3302. except:
  3303. self.log.debug("[warning] There was no active object")
  3304. pass
  3305. # Project options
  3306. self.options_read_form()
  3307. # Serialize the whole project
  3308. d = {"objs": [obj.to_dict() for obj in self.collection.get_list()],
  3309. "options": self.options,
  3310. "version": self.version}
  3311. # Open file
  3312. try:
  3313. f = open(filename, 'w')
  3314. except IOError:
  3315. App.log.error("[error] Failed to open file for saving: %s", filename)
  3316. return
  3317. # Write
  3318. json.dump(d, f, default=to_dict)
  3319. # try:
  3320. # json.dump(d, f, default=to_dict)
  3321. # except Exception, e:
  3322. # print str(e)
  3323. # App.log.error("[error] File open but failed to write: %s", filename)
  3324. # f.close()
  3325. # return
  3326. f.close()
  3327. self.inform.emit("Project saved to: %s" % filename)
  3328. # def main():
  3329. #
  3330. # app = QtGui.QApplication(sys.argv)
  3331. # fc = App()
  3332. # sys.exit(app.exec_())
  3333. #
  3334. #
  3335. # if __name__ == '__main__':
  3336. # main()