diff --git a/FlatCAM.py b/FlatCAM.py index 98bb3e22..457aa374 100644 --- a/FlatCAM.py +++ b/FlatCAM.py @@ -5,7 +5,12 @@ ############################################################ import threading -from gi.repository import Gtk, Gdk, GLib, GObject + +# TODO: Bundle together. This is just for debugging. +from gi.repository import Gtk +from gi.repository import Gdk +from gi.repository import GLib +from gi.repository import GObject import simplejson as json from matplotlib.figure import Figure @@ -534,7 +539,7 @@ class App: def __init__(self): """ - Starts the application. + Starts the application. Takes no parameters. :return: app :rtype: App @@ -2291,6 +2296,7 @@ class App: assert isinstance(gerber_obj, FlatCAMGerber) GLib.idle_add(lambda: app_obj.set_progress_bar(0.2, "Parsing ...")) gerber_obj.parse_file(filename) + GLib.idle_add(lambda: app_obj.set_progress_bar(0.5, "Creating Geometry ...")) gerber_obj.create_geometry() GLib.idle_add(lambda: app_obj.set_progress_bar(0.6, "Plotting ...")) diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..b3934d10 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Juan Pablo Caram + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/README b/README index 224d08ba..e3db5742 100644 --- a/README +++ b/README @@ -1,4 +1,19 @@ -Requirements: -1) GTK+ 3 -2) Shapely -3) PyObjects (Python GI API) \ No newline at end of file +FlatCAM: 2D Post-processinf for Manufacturing +============================================= + +(c) 2014 Juan Pablo Caram + +FlatCAM is a program for preparing CNC jobs for making PCBs on a CNC router. +Among other things, it can take a Gerber file generated by your favorite PCB +CAD program, and create G-Code for Isolation routing. But there's more. See +the features list below. + +* Powerful user interface for visualization. +* Viewers for: Gerber, Excellon, G-Code. +* Create isolation routing geometry from Gerber. +* Create optimized G-Code from geometry. +* Double sided PCB tools. +* Clearing copper areas. +* Measuring tool (planned). +* PCB cutout tool. +* Table flattening tool. \ No newline at end of file diff --git a/camlib.py b/camlib.py index 87f4ea0a..f263bf26 100644 --- a/camlib.py +++ b/camlib.py @@ -22,7 +22,8 @@ from shapely.geometry.base import BaseGeometry from descartes.patch import PolygonPatch import simplejson as json -from matplotlib.pyplot import plot +# TODO: Commented for FlatCAM packaging with cx_freeze +#from matplotlib.pyplot import plot class Geometry: def __init__(self): @@ -210,7 +211,12 @@ class Gerber (Geometry): *buffering* (or thickening) the ``paths`` with the aperture. These are generated from ``paths`` in ``buffer_paths()``. - **USAGE** + **USAGE**:: + + g = Gerber() + g.parse_file(filename) + g.create_geometry() + do_something(s.solid_geometry) """ @@ -330,8 +336,12 @@ class Gerber (Geometry): * *Circular (C)*: size (float) * *Rectangle (R)*: width (float), height (float) - * *Obround (O)*: width (float), height (float). NOTE: This can - be parsed, but it is not supported further yet. + * *Obround (O)*: width (float), height (float). + + :param gline: Line of Gerber code known to have an aperture definition. + :type gline: str + :return: Identifier of the aperture. + :rtype: str """ indexstar = gline.find("*") indexc = gline.find("C,") @@ -465,7 +475,23 @@ class Gerber (Geometry): rectangle = shply_box(minx, miny, maxx, maxy) self.flash_geometry.append(rectangle) continue - #TODO: Add support for type='O' + if aperture['type'] == 'O': # Obround + loc = flash['loc'] + width = aperture['width'] + height = aperture['height'] + if width > height: + p1 = Point(loc[0] + 0.5*(width-height), loc[1]) + p2 = Point(loc[0] - 0.5*(width-height), loc[1]) + c1 = p1.buffer(height*0.5) + c2 = p2.buffer(height*0.5) + else: + p1 = Point(loc[0], loc[1] + 0.5*(height-width)) + p2 = Point(loc[0], loc[1] - 0.5*(height-width)) + c1 = p1.buffer(width*0.5) + c2 = p2.buffer(width*0.5) + obround = cascaded_union([c1, c2]).convex_hull + self.flash_geometry.append(obround) + continue print "WARNING: Aperture type %s not implemented" % (aperture['type']) def create_geometry(self): @@ -480,9 +506,13 @@ class Gerber (Geometry): """ # if len(self.buffered_paths) == 0: # self.buffer_paths() + print "... buffer_paths()" self.buffer_paths() + print "... fix_regions()" self.fix_regions() + print "... do_flashes()" self.do_flashes() + print "... cascaded_union()" self.solid_geometry = cascaded_union( self.buffered_paths + [poly['polygon'] for poly in self.regions] + @@ -495,7 +525,7 @@ class Gerber (Geometry): can optionally have rounded corners of radius equal to margin. :param margin: Distance to enlarge the rectangular bounding - box in both positive and negative, x and y axes. + box in both positive and negative, x and y axes. :type margin: float :param rounded: Wether or not to have rounded corners. :type rounded: bool diff --git a/doc/build/.doctrees/environment.pickle b/doc/build/.doctrees/environment.pickle index 71d6ddaf..67d7187d 100644 Binary files a/doc/build/.doctrees/environment.pickle and b/doc/build/.doctrees/environment.pickle differ diff --git a/doc/build/.doctrees/index.doctree b/doc/build/.doctrees/index.doctree index 9acf5957..c379cf24 100644 Binary files a/doc/build/.doctrees/index.doctree and b/doc/build/.doctrees/index.doctree differ diff --git a/doc/build/_sources/index.txt b/doc/build/_sources/index.txt index 4b57240f..62096bdb 100644 --- a/doc/build/_sources/index.txt +++ b/doc/build/_sources/index.txt @@ -13,7 +13,7 @@ Contents: .. toctree:: :maxdepth: 2 -.. automodule:: cirkuix +.. automodule:: FlatCAM .. autoclass:: App :members: @@ -30,19 +30,19 @@ Contents: .. autoclass:: CNCjob :members: -.. autoclass:: CirkuixObj +.. autoclass:: FlatCAMObj :members: -.. autoclass:: CirkuixGerber +.. autoclass:: FlatCAMGerber :members: -.. autoclass:: CirkuixExcellon +.. autoclass:: FlatCAMExcellon :members: -.. autoclass:: CirkuixCNCjob +.. autoclass:: FlatCAMCNCjob :members: -.. autoclass:: CirkuixGeometry +.. autoclass:: FlatCAMGeometry :members: diff --git a/doc/build/genindex.html b/doc/build/genindex.html index 04802a57..025eb7e2 100644 --- a/doc/build/genindex.html +++ b/doc/build/genindex.html @@ -138,17 +138,17 @@ @@ -158,17 +158,17 @@
-
adjust_axes() (cirkuix.App method) +
adjust_axes() (FlatCAM.App method)
-
aperture_parse() (cirkuix.Gerber method) +
aperture_parse() (FlatCAM.Gerber method)
-
App (class in cirkuix) +
App (class in FlatCAM)
@@ -178,49 +178,31 @@
-
bounds() (cirkuix.Geometry method) +
bounds() (FlatCAM.Geometry method)
-
build_list() (cirkuix.App method) +
build_list() (FlatCAM.App method)
-
build_ui() (cirkuix.CirkuixObj method) +
build_ui() (FlatCAM.FlatCAMObj method)
@@ -230,17 +212,17 @@
-
cirkuix (module) +
clear_plots() (FlatCAM.App method)
-
CirkuixCNCjob (class in cirkuix) +
clear_polygon() (FlatCAM.Geometry method)
-
CirkuixExcellon (class in cirkuix) -
- - -
CirkuixGeometry (class in cirkuix) -
- - -
CirkuixGerber (class in cirkuix) -
- - -
CirkuixObj (class in cirkuix) +
CNCjob (class in FlatCAM)
-
clear_plots() (cirkuix.App method) +
convert_units() (FlatCAM.FlatCAMGerber method)
- -
clear_polygon() (cirkuix.Geometry method) +
+ +
(FlatCAM.Geometry method)
+
-
CNCjob (class in cirkuix) -
- - -
convert_units() (cirkuix.Geometry method) -
- - -
create_geometry() (cirkuix.Gerber method) +
create_geometry() (FlatCAM.Gerber method)
@@ -250,7 +232,7 @@
-
deserialize() (cirkuix.CirkuixObj method) +
deserialize() (FlatCAM.FlatCAMObj method)
-
digits (cirkuix.Gerber attribute) +
digits (FlatCAM.Gerber attribute)
-
do_flashes() (cirkuix.Gerber method) +
do_flashes() (FlatCAM.Gerber method)
@@ -260,25 +242,49 @@
-
Excellon (class in cirkuix) +
Excellon (class in FlatCAM)
@@ -288,45 +294,49 @@
-
file_chooser_action() (cirkuix.App method) +
file_chooser_action() (FlatCAM.App method)
-
file_chooser_save_action() (cirkuix.App method) +
file_chooser_save_action() (FlatCAM.App method)
-
fix_regions() (cirkuix.Gerber method) +
fix_regions() (FlatCAM.Gerber method) +
+ + +
FlatCAM (module) +
+ + +
FlatCAMCNCjob (class in FlatCAM) +
+ + +
FlatCAMExcellon (class in FlatCAM)
-
fraction (cirkuix.Gerber attribute) +
FlatCAMGeometry (class in FlatCAM)
-
from_dict() (cirkuix.Geometry method) +
FlatCAMGerber (class in FlatCAM) +
+ + +
FlatCAMObj (class in FlatCAM) +
+ + +
fraction (FlatCAM.Gerber attribute) +
+ + +
from_dict() (FlatCAM.Geometry method)
@@ -336,13 +346,13 @@
-
gcode_parse() (cirkuix.CNCjob method) +
gcode_parse() (FlatCAM.CNCjob method)
-
generate_from_excellon() (cirkuix.CNCjob method) +
generate_from_excellon() (FlatCAM.CNCjob method)
-
generate_from_excellon_by_tool() (cirkuix.CNCjob method) +
generate_from_excellon_by_tool() (FlatCAM.CNCjob method)
-
generate_from_geometry() (cirkuix.CNCjob method) +
generate_from_geometry() (FlatCAM.CNCjob method)
-
Geometry (class in cirkuix) +
Geometry (class in FlatCAM) +
+ + +
Gerber (class in FlatCAM)
-
Gerber (class in cirkuix) +
get_bounding_box() (FlatCAM.Gerber method)
-
get_current() (cirkuix.App method) +
get_current() (FlatCAM.App method)
-
get_empty_area() (cirkuix.Geometry method) +
get_empty_area() (FlatCAM.Geometry method)
-
get_eval() (cirkuix.App method) +
get_eval() (FlatCAM.App method)
-
get_radio_value() (cirkuix.App method) +
get_radio_value() (FlatCAM.App method)
@@ -352,7 +362,7 @@
-
info() (cirkuix.App method) +
info() (FlatCAM.App method)
-
isolation_geometry() (cirkuix.Geometry method) +
isolation_geometry() (FlatCAM.Geometry method)
@@ -362,7 +372,7 @@
-
load_defaults() (cirkuix.App method) +
load_defaults() (FlatCAM.App method)
@@ -372,193 +382,213 @@
-
new_object() (cirkuix.App method) +
new_object() (FlatCAM.App method)
@@ -568,45 +598,43 @@
-
on_activate_name() (cirkuix.App method) +
on_activate_name() (FlatCAM.App method)
-
on_canvas_configure() (cirkuix.App method) +
on_canvas_configure() (FlatCAM.App method)
-
on_clear_plots() (cirkuix.App method) +
on_clear_plots() (FlatCAM.App method)
-
on_click_over_plot() (cirkuix.App method) +
on_click_over_plot() (FlatCAM.App method)
-
on_closewindow() (cirkuix.App method) +
on_closewindow() (FlatCAM.App method)
-
on_cncjob_exportgcode() (cirkuix.App method) +
on_cncjob_exportgcode() (FlatCAM.App method)
-
on_delete() (cirkuix.App method) +
on_create_aligndrill() (FlatCAM.App method)
-
on_entry_eval_activate() (cirkuix.App method) +
on_create_mirror() (FlatCAM.App method)
-
on_eval_update() (cirkuix.App method) +
on_delete() (FlatCAM.App method)
-
on_excellon_tool_choose() (cirkuix.App method) +
on_entry_eval_activate() (FlatCAM.App method)
-
on_file_new() (cirkuix.App method) +
on_eval_update() (FlatCAM.App method)
-
on_file_openproject() (cirkuix.App method) +
on_excellon_tool_choose() (FlatCAM.App method)
-
on_file_savedefaults() (cirkuix.App method) +
on_file_new() (FlatCAM.App method)
-
on_file_saveproject() (cirkuix.App method) +
on_file_openproject() (FlatCAM.App method)
-
on_file_saveprojectas() (cirkuix.App method) +
on_file_savedefaults() (FlatCAM.App method)
-
on_file_saveprojectcopy() (cirkuix.App method) +
on_file_saveproject() (FlatCAM.App method)
-
on_fileopenexcellon() (cirkuix.App method) +
on_file_saveprojectas() (FlatCAM.App method)
-
on_fileopengcode() (cirkuix.App method) +
on_file_saveprojectcopy() (FlatCAM.App method)
-
on_fileopengerber() (cirkuix.App method) +
on_fileopenexcellon() (FlatCAM.App method)
-
on_filequit() (cirkuix.App method) +
on_fileopengcode() (FlatCAM.App method)
-
on_generate_cncjob() (cirkuix.App method) +
on_fileopengerber() (FlatCAM.App method)
-
on_generate_excellon_cncjob() (cirkuix.App method) +
on_filequit() (FlatCAM.App method)
-
on_generate_gerber_bounding_box() (cirkuix.App method) +
on_generate_cncjob() (FlatCAM.App method)
-
on_generate_isolation() (cirkuix.App method) +
on_generate_excellon_cncjob() (FlatCAM.App method) +
+ + +
on_generate_gerber_bounding_box() (FlatCAM.App method) +
+ + +
on_generate_isolation() (FlatCAM.App method)
-
on_generate_paintarea() (cirkuix.App method) +
on_generate_paintarea() (FlatCAM.App method)
-
on_gerber_generate_cutout() (cirkuix.App method) +
on_gerber_generate_cutout() (FlatCAM.App method)
-
on_gerber_generate_noncopper() (cirkuix.App method) +
on_gerber_generate_noncopper() (FlatCAM.App method)
-
on_key_over_plot() (cirkuix.App method) +
on_key_over_plot() (FlatCAM.App method)
-
on_mouse_move_over_plot() (cirkuix.App method) +
on_mouse_move_over_plot() (FlatCAM.App method)
-
on_options_app2object() (cirkuix.App method) +
on_options_app2object() (FlatCAM.App method)
-
on_options_app2project() (cirkuix.App method) +
on_options_app2project() (FlatCAM.App method)
-
on_options_combo_change() (cirkuix.App method) +
on_options_combo_change() (FlatCAM.App method)
-
on_options_object2app() (cirkuix.App method) +
on_options_object2app() (FlatCAM.App method)
-
on_options_object2project() (cirkuix.App method) +
on_options_object2project() (FlatCAM.App method)
-
on_options_project2app() (cirkuix.App method) +
on_options_project2app() (FlatCAM.App method)
-
on_options_project2object() (cirkuix.App method) +
on_options_project2object() (FlatCAM.App method)
-
on_options_update() (cirkuix.App method) +
on_options_update() (FlatCAM.App method)
-
on_replot() (cirkuix.App method) +
on_replot() (FlatCAM.App method)
-
on_row_activated() (cirkuix.App method) +
on_row_activated() (FlatCAM.App method)
-
on_scale_object() (cirkuix.App method) +
on_scale_object() (FlatCAM.App method)
-
on_tree_selection_changed() (cirkuix.App method) +
on_toggle_pointbox() (FlatCAM.App method)
-
on_update_plot() (cirkuix.App method) +
on_toggle_units() (FlatCAM.App method)
-
on_zoom_fit() (cirkuix.App method) +
on_tools_doublesided() (FlatCAM.App method)
-
on_zoom_in() (cirkuix.App method) +
on_tree_selection_changed() (FlatCAM.App method)
-
on_zoom_out() (cirkuix.App method) +
on_update_plot() (FlatCAM.App method)
-
open_project() (cirkuix.App method) +
on_zoom_fit() (FlatCAM.App method)
-
options2form() (cirkuix.App method) +
on_zoom_in() (FlatCAM.App method) +
+ + +
on_zoom_out() (FlatCAM.App method) +
+ + +
open_project() (FlatCAM.App method) +
+ + +
options2form() (FlatCAM.App method)
@@ -616,19 +644,19 @@
-
parse_file() (cirkuix.Gerber method) +
parse_file() (FlatCAM.Gerber method)
-
parse_lines() (cirkuix.Excellon method) +
parse_lines() (FlatCAM.Excellon method)
-
(cirkuix.Gerber method) +
(FlatCAM.Gerber method)
-
plot() (cirkuix.CirkuixObj method) +
plot() (FlatCAM.FlatCAMObj method)
-
- -
(cirkuix.CNCjob method) -
- -
-
plot2() (cirkuix.CNCjob method) +
plot2() (FlatCAM.CNCjob method)
-
plot_all() (cirkuix.App method) +
plot_all() (FlatCAM.App method)
-
polygon2gcode() (cirkuix.CNCjob method) +
polygon2gcode() (FlatCAM.CNCjob method)
-
pre_parse() (cirkuix.CNCjob method) +
populate_objects_combo() (FlatCAM.App method) +
+ + +
pre_parse() (FlatCAM.CNCjob method)
@@ -638,73 +666,73 @@
-
read_form() (cirkuix.App method) +
read_form() (FlatCAM.App method)
-
(cirkuix.CirkuixObj method) +
(FlatCAM.FlatCAMObj method)
-
read_form_item() (cirkuix.App method) +
read_form_item() (FlatCAM.App method)
@@ -714,13 +742,13 @@
-
save_project() (cirkuix.App method) +
save_project() (FlatCAM.App method)
-
scale() (cirkuix.CNCjob method) +
scale() (FlatCAM.CNCjob method)
-
(cirkuix.Excellon method) +
(FlatCAM.Excellon method)
-
(cirkuix.Geometry method) +
(FlatCAM.Geometry method)
-
(cirkuix.Gerber method) +
(FlatCAM.Gerber method)
-
serialize() (cirkuix.CirkuixObj method) +
serialize() (FlatCAM.FlatCAMObj method)
-
set_form_item() (cirkuix.App method) +
set_form_item() (FlatCAM.App method)
-
(cirkuix.CirkuixObj method) +
(FlatCAM.FlatCAMObj method)
-
set_list_selection() (cirkuix.App method) +
set_list_selection() (FlatCAM.App method)
-
set_progress_bar() (cirkuix.App method) +
set_progress_bar() (FlatCAM.App method)
-
setup_axes() (cirkuix.CirkuixObj method) +
setup_axes() (FlatCAM.FlatCAMObj method)
-
setup_component_editor() (cirkuix.App method) +
setup_component_editor() (FlatCAM.App method)
-
setup_obj_classes() (cirkuix.App method) +
setup_obj_classes() (FlatCAM.App method)
-
setup_plot() (cirkuix.App method) +
setup_plot() (FlatCAM.App method)
-
setup_project_list() (cirkuix.App method) +
setup_project_list() (FlatCAM.App method)
-
size() (cirkuix.Geometry method) +
size() (FlatCAM.Geometry method)
@@ -730,7 +758,7 @@
-
to_dict() (cirkuix.Geometry method) +
to_dict() (FlatCAM.Geometry method)
-
to_form() (cirkuix.CirkuixObj method) +
to_form() (FlatCAM.FlatCAMObj method)
diff --git a/doc/build/index.html b/doc/build/index.html index 626ce560..e9890027 100644 --- a/doc/build/index.html +++ b/doc/build/index.html @@ -120,13 +120,13 @@ -
-
-class cirkuix.App
+
+
+class FlatCAM.App

The main application class. The constructor starts the GUI.

-
-adjust_axes(xmin, ymin, xmax, ymax)
+
+adjust_axes(xmin, ymin, xmax, ymax)

Adjusts axes of all plots while maintaining the use of the whole canvas and an aspect ratio to 1:1 between x and y axes. The parameters are an original request that will be modified to fit these restrictions.

@@ -150,8 +150,8 @@ request that will be modified to fit these restrictions.

-
-build_list()
+
+build_list()

Clears and re-populates the list of objects in currently in the project.

-
zoom() (cirkuix.App method) +
zoom() (FlatCAM.App method)
@@ -165,8 +165,8 @@ in the project.

-
-clear_plots()
+
+clear_plots()

Clears self.axes and self.figure.

@@ -179,8 +179,8 @@ in the project.

-
-file_chooser_action(on_success)
+
+file_chooser_action(on_success)

Opens the file chooser and runs on_success on a separate thread upon completion of valid file choice.

@@ -199,8 +199,8 @@ appropriate precautions when accessing shared resources.
-
-file_chooser_save_action(on_success)
+
+file_chooser_save_action(on_success)

Opens the file chooser and runs on_success upon completion of valid file choice.

@@ -217,24 +217,24 @@ gets run immediately in the same thread.
-
-get_current()
-

Returns the currently selected CirkuixObj in the application.

+
+get_current()
+

Returns the currently selected FlatCAMObj in the application.

- + - +
Returns:Currently selected CirkuixObj in the application.
Returns:Currently selected FlatCAMObj in the application.
Return type:CirkuixObj or None
Return type:FlatCAMObj or None
-
-get_eval(widget_name)
+
+get_eval(widget_name)

Runs eval() on the on the text entry of name ‘widget_name’ and returns the results.

@@ -250,8 +250,8 @@ and returns the results.

-
-get_radio_value(radio_set)
+
+get_radio_value(radio_set)

Returns the radio_set[key] of the radiobutton whose name is key is active.

@@ -267,8 +267,8 @@ whose name is key is active.

-
-info(text)
+
+info(text)

Show text on the status bar.

@@ -283,8 +283,8 @@ whose name is key is active.

-
-load_defaults()
+
+load_defaults()

Loads the aplication’s default settings from defaults.json into self.defaults.

@@ -298,9 +298,9 @@ whose name is key is active.

-
-new_object(kind, name, initialize)
-

Creates a new specalized CirkuixObj and attaches it to the application, +

+new_object(kind, name, initialize)
+

Creates a new specalized FlatCAMObj and attaches it to the application, this is, updates the GUI accordingly, any other records and plots it.

@@ -327,8 +327,8 @@ called with 2 parameters: the new object and the App instance.
-
-on_activate_name(entry)
+
+on_activate_name(entry)

Hitting ‘Enter’ after changing the name of an item updates the item dictionary and re-builds the item list.

@@ -344,8 +344,8 @@ updates the item dictionary and re-builds the item list.

-
-on_canvas_configure(widget, event)
+
+on_canvas_configure(widget, event)

Called whenever the canvas changes size. The axes are updated such as to use the whole canvas.

@@ -366,8 +366,8 @@ as to use the whole canvas.

-
-on_clear_plots(widget)
+
+on_clear_plots(widget)

Callback for toolbar button. Clears all plots.

@@ -382,26 +382,31 @@ as to use the whole canvas.

-
-on_click_over_plot(event)
+
+on_click_over_plot(event)

Callback for the mouse click event over the plot. This event is generated by the Matplotlib backend and has been registered in self.__init__(). For details, see: http://matplotlib.org/users/event_handling.html

+

Default actions are:

+
    +
  • Copy coordinates to clipboard. Ex.: (65.5473, -13.2679)
    • +
- + - +
Parameters:event –
Parameters:event – Contains information about the event, like which button +was clicked, the pixel coordinates and the axes coordinates.
Returns:
Returns:None
-
-on_closewindow(param)
+
+on_closewindow(param)

Callback for closing the main window.

@@ -416,8 +421,8 @@ For details, see: -
-on_cncjob_exportgcode(widget)
+
+on_cncjob_exportgcode(widget)

Called from button on CNCjob form to save the G-Code from the object.

@@ -432,9 +437,43 @@ For details, see: -
-on_delete(widget)
-

Delete the currently selected CirkuixObj.

+
+on_create_aligndrill(widget)
+

Creates alignment holes Excellon object. Creates mirror duplicates +of the specified holes around the specified axis.

+
+++ + + + + + +
Parameters:widget – Ignored.
Returns:None
+
+ +
+
+on_create_mirror(widget)
+

Creates a mirror image of a Gerber object to be used as a bottom +copper layer.

+ +++ + + + + + +
Parameters:widget – Ignored.
Returns:None
+
+ +
+
+on_delete(widget)
+

Delete the currently selected FlatCAMObj.

@@ -448,8 +487,8 @@ For details, see: -
-on_entry_eval_activate(widget)
+
+on_entry_eval_activate(widget)

Called when an entry is activated (eg. by hitting enter) if set to do so. Its text is eval()’d and set to the returned value. The current object is updated.

@@ -466,8 +505,8 @@ The current object is updated.

-
-on_eval_update(widget)
+
+on_eval_update(widget)

Modifies the content of a Gtk.Entry by running eval() on its contents and puting it back as a string.

@@ -484,8 +523,8 @@ string.

-
-on_excellon_tool_choose(widget)
+
+on_excellon_tool_choose(widget)

Callback for button on Excellon form to open up a window for selecting tools.

@@ -501,8 +540,8 @@ selecting tools.

-
-on_file_new(param)
+
+on_file_new(param)

Callback for menu item File->New. Returns the application to its startup state.

@@ -518,8 +557,8 @@ startup state.

-
-on_file_openproject(param)
+
+on_file_openproject(param)

Callback for menu item File->Open Project. Opens a file chooser and calls self.open_project() after successful selection of a filename.

@@ -535,8 +574,8 @@ startup state.

-
-on_file_savedefaults(param)
+
+on_file_savedefaults(param)

Callback for menu item File->Save Defaults. Saves application default options self.defaults to defaults.json.

@@ -552,8 +591,8 @@ startup state.

-
-on_file_saveproject(param)
+
+on_file_saveproject(param)

Callback for menu item File->Save Project. Saves the project to self.project_filename or calls self.on_file_saveprojectas() if set to None. The project is saved by calling self.save_project().

@@ -570,8 +609,8 @@ if set to None. The project is saved by calling
-
-on_file_saveprojectas(param)
+
+on_file_saveprojectas(param)

Callback for menu item File->Save Project As... Opens a file chooser and saves the project to the given file via self.save_project().

@@ -588,8 +627,8 @@ chooser and saves the project to the given file via
-
-on_file_saveprojectcopy(param)
+
+on_file_saveprojectcopy(param)

Callback for menu item File->Save Project Copy... Opens a file chooser and saves the project to the given file via self.save_project. It does not update self.project_filename so @@ -607,10 +646,10 @@ subsequent save requests are done on the previous known filename.

-
-on_fileopenexcellon(param)
+
+on_fileopenexcellon(param)

Callback for menu item File->Open Excellon. Defines a function that is then passed -to self.file_chooser_action(). It requests the creation of a CirkuixExcellon object +to self.file_chooser_action(). It requests the creation of a FlatCAMExcellon object and updates the progress bar throughout the process.

@@ -625,10 +664,10 @@ and updates the progress bar throughout the process.

-
-on_fileopengcode(param)
+
+on_fileopengcode(param)

Callback for menu item File->Open G-Code. Defines a function that is then passed -to self.file_chooser_action(). It requests the creation of a CirkuixCNCjob object +to self.file_chooser_action(). It requests the creation of a FlatCAMCNCjob object and updates the progress bar throughout the process.

@@ -643,10 +682,10 @@ and updates the progress bar throughout the process.

-
-on_fileopengerber(param)
+
+on_fileopengerber(param)

Callback for menu item File->Open Gerber. Defines a function that is then passed -to self.file_chooser_action(). It requests the creation of a CirkuixGerber object +to self.file_chooser_action(). It requests the creation of a FlatCAMGerber object and updates the progress bar throughout the process.

@@ -661,8 +700,8 @@ and updates the progress bar throughout the process.

-
-on_filequit(param)
+
+on_filequit(param)

Callback for menu item File->Quit. Closes the application.

@@ -677,8 +716,8 @@ and updates the progress bar throughout the process.

-
-on_generate_cncjob(widget)
+
+on_generate_cncjob(widget)

Callback for button on geometry form to generate CNC job.

@@ -693,8 +732,8 @@ and updates the progress bar throughout the process.

-
-on_generate_excellon_cncjob(widget)
+
+on_generate_excellon_cncjob(widget)

Callback for button active/click on Excellon form to create a CNC Job for the Excellon file.

@@ -710,10 +749,10 @@ create a CNC Job for the Excellon file.

-
-on_generate_gerber_bounding_box(widget)
+
+on_generate_gerber_bounding_box(widget)

Callback for request from the Gerber form to generate a bounding box for the -geometry in the object. Creates a CirkuixGeometry with the bounding box.

+geometry in the object. Creates a FlatCAMGeometry with the bounding box.

@@ -727,8 +766,8 @@ geometry in the object. Creates a CirkuixGeometry with the bounding box.

-
-on_generate_isolation(widget)
+
+on_generate_isolation(widget)

Callback for button on Gerber form to create isolation routing geometry.

@@ -743,13 +782,13 @@ geometry in the object. Creates a CirkuixGeometry with the bounding box.

-
-on_generate_paintarea(widget)
+
+on_generate_paintarea(widget)

Callback for button on geometry form. Subscribes to the “Click on plot” event and continues after the click. Finds the polygon containing the clicked point and runs clear_poly() on it, resulting -in a new CirkuixGeometry object.

+in a new FlatCAMGeometry object.

@@ -763,8 +802,8 @@ in a new CirkuixGeometry object.

-
-on_gerber_generate_cutout(widget)
+
+on_gerber_generate_cutout(widget)

Callback for button on Gerber form to create geometry with lines for cutting off the board.

@@ -780,8 +819,8 @@ for cutting off the board.

-
-on_gerber_generate_noncopper(widget)
+
+on_gerber_generate_noncopper(widget)

Callback for button on Gerber form to create a geometry object with polygons covering the area without copper or negative of the Gerber.

@@ -798,8 +837,8 @@ Gerber.

-
-on_key_over_plot(event)
+
+on_key_over_plot(event)

Callback for the key pressed event when the canvas is focused. Keyboard shortcuts are handled here. So far, these are the shortcuts:

@@ -837,8 +876,8 @@ shortcuts are handled here. So far, these are the shortcuts:

-
-on_mouse_move_over_plot(event)
+
+on_mouse_move_over_plot(event)

Callback for the mouse motion event over the plot. This event is generated by the Matplotlib backend and has been registered in self.__init__(). For details, see: http://matplotlib.org/users/event_handling.html

@@ -855,8 +894,8 @@ For details, see: -
-on_options_app2object(param)
+
+on_options_app2object(param)

Callback for Options->Transfer Options->App=>Object. Copies options from application defaults to the currently selected object.

@@ -872,8 +911,8 @@ from application defaults to the currently selected object.

-
-on_options_app2project(param)
+
+on_options_app2project(param)

Callback for Options->Transfer Options->App=>Project. Copies options from application defaults to project defaults.

@@ -889,8 +928,8 @@ from application defaults to project defaults.

-
-on_options_combo_change(widget)
+
+on_options_combo_change(widget)

Called when the combo box to choose between application defaults and project option changes value. The corresponding variables are copied to the UI.

@@ -907,8 +946,8 @@ copied to the UI.

-
-on_options_object2app(param)
+
+on_options_object2app(param)

Callback for Options->Transfer Options->Object=>App. Copies options from the currently selected object to application defaults.

@@ -924,8 +963,8 @@ from the currently selected object to application defaults.

-
-on_options_object2project(param)
+
+on_options_object2project(param)

Callback for Options->Transfer Options->Object=>Project. Copies options from the currently selected object to project defaults.

@@ -941,8 +980,8 @@ from the currently selected object to project defaults.

-
-on_options_project2app(param)
+
+on_options_project2app(param)

Callback for Options->Transfer Options->Project=>App. Copies options from project defaults to application defaults.

@@ -958,8 +997,8 @@ from project defaults to application defaults.

-
-on_options_project2object(param)
+
+on_options_project2object(param)

Callback for Options->Transfer Options->Project=>Object. Copies options from project defaults to the currently selected object.

@@ -975,8 +1014,8 @@ from project defaults to the currently selected object.

-
-on_options_update(widget)
+
+on_options_update(widget)

Called whenever a value in the options/defaults form changes. All values are updated. Can be inhibited by setting self.options_update_ignore = True, which may be necessary when updating the UI from code and not by the user.

@@ -993,8 +1032,8 @@ which may be necessary when updating the UI from code and not by the user.

-
-on_replot(widget)
+
+on_replot(widget)

Callback for toolbar button. Re-plots all objects.

@@ -1009,8 +1048,8 @@ which may be necessary when updating the UI from code and not by the user.

-
-on_row_activated(widget, path, col)
+
+on_row_activated(widget, path, col)

Callback for selection activation (Enter or double-click) on the Project list. Switches the notebook page to the object properties form. Calls self.notebook.set_current_page(1).

@@ -1033,8 +1072,8 @@ Switches the notebook page to the object properties form. Calls
-
-on_scale_object(widget)
+
+on_scale_object(widget)

Callback for request to change an objects geometry scale. The object is re-scaled and replotted.

@@ -1050,10 +1089,63 @@ is re-scaled and replotted.

-
-on_tree_selection_changed(selection)
+
+on_toggle_pointbox(widget)
+

Callback for radio selection change between point and box in the +Double-sided PCB tool. Updates the UI accordingly.

+
+++ + + + + + +
Parameters:widget – Ignored.
Returns:None
+
+ +
+
+on_toggle_units(widget)
+

Callback for the Units radio-button change in the Options tab. +Changes the application’s default units or the current project’s units. +If changing the project’s units, the change propagates to all of +the objects in the project.

+ +++ + + + + + +
Parameters:widget – Ignored.
Returns:None
+
+ +
+
+on_tools_doublesided(param)
+

Callback for menu item Tools->Double Sided PCB Tool. Launches the +tool placing its UI in the “Tool” tab in the notebook.

+ +++ + + + + + +
Parameters:param – Ignored.
Returns:None
+
+ +
+
+on_tree_selection_changed(selection)

Callback for selection change in the project list. This changes -the currently selected CirkuixObj.

+the currently selected FlatCAMObj.

@@ -1067,8 +1159,8 @@ the currently selected CirkuixObj.

-
-on_update_plot(widget)
+
+on_update_plot(widget)

Callback for button on form for all kinds of objects. Re-plots the current object only.

@@ -1084,8 +1176,8 @@ Re-plots the current object only.

-
-on_zoom_fit(event)
+
+on_zoom_fit(event)

Callback for zoom-out request. This can be either from the corresponding toolbar button or the ‘1’ key when the canvas is focused. Calls self.adjust_axes() with axes limits from the geometry bounds of all objects.

@@ -1102,8 +1194,8 @@ with axes limits from the geometry bounds of all objects.

-
-on_zoom_in(event)
+
+on_zoom_in(event)

Callback for zoom-in request. This can be either from the corresponding toolbar button or the ‘3’ key when the canvas is focused. Calls self.zoom().

@@ -1119,8 +1211,8 @@ toolbar button or the ‘3’ key when the canvas is focused. Calls
-
-on_zoom_out(event)
+
+on_zoom_out(event)

Callback for zoom-out request. This can be either from the corresponding toolbar button or the ‘2’ key when the canvas is focused. Calls self.zoom().

@@ -1136,8 +1228,8 @@ toolbar button or the ‘2’ key when the canvas is focused. Calls
-
-open_project(filename)
+
+open_project(filename)

Loads a project from the specified file.

@@ -1152,8 +1244,8 @@ toolbar button or the ‘2’ key when the canvas is focused. Calls
-
-options2form()
+
+options2form()

Sets the ‘Project Options’ or ‘Application Defaults’ form with values from self.options or self.defaults.

@@ -1169,8 +1261,8 @@ toolbar button or the ‘2’ key when the canvas is focused. Calls
-
-plot_all()
+
+plot_all()

Re-generates all plots from all objects.

@@ -1183,8 +1275,24 @@ toolbar button or the ‘2’ key when the canvas is focused. Calls
-
-read_form()
+
+populate_objects_combo(combo)
+

Populates a Gtk.Comboboxtext with the list of the object in the project.

+
+++ + + + + + +
Parameters:combo (str or Gtk.ComboBoxText) – Name or instance of the comboboxtext.
Returns:None
+
+ +
+
+read_form()

Reads the options form into self.defaults/self.options.

@@ -1199,8 +1307,8 @@ toolbar button or the ‘2’ key when the canvas is focused. Calls
-
-read_form_item(name, dest)
+
+read_form_item(name, dest)

Reads the value of a form item in the defaults/options form and saves it to the corresponding dictionary.

@@ -1222,8 +1330,8 @@ saves it to the corresponding dictionary.

-
-save_project(filename)
+
+save_project(filename)

Saves the current project to the specified file.

@@ -1238,8 +1346,8 @@ saves it to the corresponding dictionary.

-
-set_form_item(name, value)
+
+set_form_item(name, value)

Sets a form item ‘name’ in the GUI with the given ‘value’. The syntax of form names in the GUI is <kind>_app_<name>, where kind is one of: rb (radio button), cb (check button), entry_eval or entry_text (entry), combo (combo box). name is @@ -1262,8 +1370,8 @@ whatever name it’s been given. For self.defaults, name is a key in the dic

-
-set_list_selection(name)
+
+set_list_selection(name)

Marks a given object as selected in the list ob objects in the GUI. This selection will in turn trigger self.on_tree_selection_changed().

@@ -1280,8 +1388,8 @@ in the GUI. This selection will in turn trigger
-
-set_progress_bar(percentage, text='')
+
+set_progress_bar(percentage, text='')

Sets the application’s progress bar to a given fraction and text.

@@ -1301,8 +1409,8 @@ in the GUI. This selection will in turn trigger
-
-setup_component_editor()
+
+setup_component_editor()

Initial configuration of the component editor. Creates a page titled “Selection” on the notebook on the left side of the main window.

@@ -1317,9 +1425,9 @@ side of the main window.

-
-setup_obj_classes()
-

Sets up application specifics on the CirkuixObj class.

+
+setup_obj_classes()
+

Sets up application specifics on the FlatCAMObj class.

@@ -1331,8 +1439,8 @@ side of the main window.

-
-setup_plot()
+
+setup_plot()

Sets up the main plotting area by creating a Matplotlib figure in self.canvas, adding axes and configuring them. These axes should not be ploted on and are just there to @@ -1350,8 +1458,8 @@ display the axes ticks and grid.

-
-setup_project_list()
+
+setup_project_list()

Sets up list or Tree where whatever has been loaded or created is displayed.

@@ -1365,8 +1473,8 @@ displayed.

-
-zoom(factor, center=None)
+
+zoom(factor, center=None)

Zooms the plot by factor around a given center point. Takes care of re-drawing.

@@ -1389,27 +1497,28 @@ center point. Takes care of re-drawing.

-
-class cirkuix.Geometry
+
+class FlatCAM.Geometry
-
-bounds()
+
+bounds()

Returns coordinates of rectangular bounds of geometry: (xmin, ymin, xmax, ymax).

-
-clear_polygon(polygon, tooldia, overlap=0.15)
+
+clear_polygon(polygon, tooldia, overlap=0.15)

Creates geometry inside a polygon for a tool to cover the whole area.

-
-convert_units(units)
+
+convert_units(units)

Converts the units of the object to units by scaling all -the geometry appropriately.

+the geometry appropriately. This call scale(). Don’t call +it again in descendents.

@@ -1425,30 +1534,30 @@ the geometry appropriately.

-
-from_dict(d)
+
+from_dict(d)

Sets object’s attributes from a dictionary. Attributes to include are listed in self.ser_attrs.

-
-get_empty_area(boundary=None)
+
+get_empty_area(boundary=None)

Returns the complement of self.solid_geometry within the given boundary polygon. If not specified, it defaults to the rectangular bounding box of self.solid_geometry.

-
-isolation_geometry(offset)
+
+isolation_geometry(offset)

Creates contours around geometry at a given offset distance.

-
-scale(factor)
+
+scale(factor)

Scales all of the object’s geometry by a given factor. Override this method. :param factor: Number by which to scale. @@ -1458,15 +1567,15 @@ this method.

-
-size()
+
+size()

Returns (width, height) of rectangular bounds of geometry.

-
-to_dict()
+
+to_dict()

Returns a respresentation of the object as a dictionary. Attributes to include are listed in self.ser_attrs.

@@ -1484,8 +1593,8 @@ Attributes to include are listed in -
-class cirkuix.Gerber(Geometry)
+
+class FlatCAM.Gerber(Geometry)

ATTRIBUTES

  • apertures (dict): The keys are names/identifiers of each aperture. @@ -1588,71 +1697,116 @@ from flashes. These a buffering (or thickening) the paths with the aperture. These are generated from paths in buffer_paths().
+

USAGE:

+
g = Gerber()
+g.parse_file(filename)
+g.create_geometry()
+do_something(s.solid_geometry)
+
+
-
-aperture_parse(gline)
+
+aperture_parse(gline)

Parse gerber aperture definition into dictionary of apertures. The following kinds and their attributes are supported:

  • Circular (C): size (float)
  • Rectangle (R): width (float), height (float)
    • -
  • Obround (O): width (float), height (float). NOTE: This can -be parsed, but it is not supported further yet.
    • +
  • Obround (O): width (float), height (float).
+
+++ + + + + + + + +
Parameters:gline (str) – Line of Gerber code known to have an aperture definition.
Returns:Identifier of the aperture.
Return type:str
-
-create_geometry()
+
+create_geometry()

Geometry from a Gerber file is made up entirely of polygons. Every stroke (linear or circular) has an aperture which gives it thickness. Additionally, aperture strokes have non-zero area, -and regions naturally do as well. -:rtype : None -@return: None

+and regions naturally do as well.

+

:rtype : None +:return: None

-
-digits = None
+
+digits = None

Number of integer digits in Gerber numbers. Used during parsing.

-
-do_flashes()
+
+do_flashes()

Creates geometry for Gerber flashes (aperture on a single point).

-
-fix_regions()
+
+fix_regions()

Overwrites the region polygons with fixed versions if found to be invalid (according to Shapely).

-
-fraction = None
+
+fraction = None

Number of fraction digits in Gerber numbers. Used during parsing.

-
-parse_file(filename)
+
+get_bounding_box(margin=0.0, rounded=False)
+

Creates and returns a rectangular polygon bounding at a distance of +margin from the object’s solid_geometry. If margin > 0, the polygon +can optionally have rounded corners of radius equal to margin.

+ +++ + + + + + + + +
Parameters:
    +
  • margin (float) – Distance to enlarge the rectangular bounding +box in both positive and negative, x and y axes.
    • +
  • rounded (bool) – Wether or not to have rounded corners.
    • +
+
Returns:

The bounding box.

+
Return type:

Shapely.Polygon

+
+
+ +
+
+parse_file(filename)

Calls Gerber.parse_lines() with array of lines read from the given file.

-
-parse_lines(glines)
+
+parse_lines(glines)

Main Gerber parser.

-
-scale(factor)
+
+scale(factor)

Scales the objects’ geometry on the XY plane by a given factor. These are:

    @@ -1671,8 +1825,8 @@ are re-created with self.create_g
-
-class cirkuix.Excellon
+
+class FlatCAM.Excellon

ATTRIBUTES

  • tools (dict): The key is the tool name and the value is @@ -1699,27 +1853,35 @@ the size (diameter).
    • -
    -parse_lines(elines)
    +
    +parse_lines(elines)

    Main Excellon parser.

    -
    -scale(factor)
    +
    +scale(factor)

    Scales geometry on the XY plane in the object by a given factor. -Tool sizes, feedrates an Z-plane dimensions are untouched. -:param factor: Number by which to scale the object. -:type factor: float -:return: None -:rtype: NOne

    +Tool sizes, feedrates an Z-plane dimensions are untouched.

    + +++ + + + + + + + +
    Parameters:factor (float) – Number by which to scale the object.
    Returns:None
    Return type:NOne
-
-class cirkuix.CNCjob(units='in', kind='generic', z_move=0.1, feedrate=3.0, z_cut=-0.002, tooldia=0.0)
+
+class FlatCAM.CNCjob(units='in', kind='generic', z_move=0.1, feedrate=3.0, z_cut=-0.002, tooldia=0.0)

Represents work to be done by a CNC machine.

ATTRIBUTES

    @@ -1746,24 +1908,24 @@ Tool sizes, feedrates an Z-plane dimensions are untouched.
    -
    -gcode_parse()
    +
    +gcode_parse()

    G-Code parser (from self.gcode). Generates dictionary with single-segment LineString’s and “kind” indicating cut or travel, fast or feedrate speed.

    -
    -generate_from_excellon(exobj)
    +
    +generate_from_excellon(exobj)

    Generates G-code for drilling from Excellon object. self.gcode becomes a list, each element is a different job for each tool in the excellon code.

    -
    -generate_from_excellon_by_tool(exobj, tools='all')
    +
    +generate_from_excellon_by_tool(exobj, tools='all')

    Creates gcode for this object from an Excellon object for the specified tools. @param exobj: Excellon object to process @@ -1774,62 +1936,69 @@ for the specified tools.

    -
    -generate_from_geometry(geometry, append=True, tooldia=None)
    +
    +generate_from_geometry(geometry, append=True, tooldia=None)

    Generates G-Code from a Geometry object.

    -
    -plot(tooldia=None, dpi=75, margin=0.1, color={'C': ['#5E6CFF', '#4650BD'], 'T': ['#F0E24D', '#B5AB3A']}, alpha={'C': 1.0, 'T': 0.3})
    -

    Creates a Matplotlib figure with a plot of the -G-code job.

    -
    - -
    -
    -plot2(axes, tooldia=None, dpi=75, margin=0.1, color={'C': ['#5E6CFF', '#4650BD'], 'T': ['#F0E24D', '#B5AB3A']}, alpha={'C': 1.0, 'T': 0.3})
    +
    +plot2(axes, tooldia=None, dpi=75, margin=0.1, color={'C': ['#5E6CFF', '#4650BD'], 'T': ['#F0E24D', '#B5AB3A']}, alpha={'C': 1.0, 'T': 0.3})

    Plots the G-code job onto the given axes.

    -
    -polygon2gcode(polygon)
    +
    +polygon2gcode(polygon)

    Creates G-Code for the exterior and all interior paths -of a polygon. -@param polygon: A Shapely.Polygon -@type polygon: Shapely.Polygon

    +of a polygon.

    + +++ + + + +
    Parameters:polygon (Shapely.Polygon) – A Shapely.Polygon
    -
    -pre_parse(gtext)
    +
    +pre_parse(gtext)

    gtext is a single string with g-code

    -
    -scale(factor)
    +
    +scale(factor)

    Scales all the geometry on the XY plane in the object by the given factor. Tool sizes, feedrates, or Z-axis dimensions are -not altered. -:param factor: Number by which to scale the object. -:type factor: float -:return: None -:rtype: None

    +not altered.

    + +++ + + + + + + + +
    Parameters:factor (float) – Number by which to scale the object.
    Returns:None
    Return type:None
-
-class cirkuix.CirkuixObj(name)
-

Base type of objects handled in Cirkuix. These become interactive +

+class FlatCAM.FlatCAMObj(name)
+

Base type of objects handled in FlatCAM. These become interactive in the GUI, can be plotted, and their options can be modified by the user in their respective forms.

-
-build_ui()
+
+build_ui()

Sets up the UI/form for this object.

@@ -1844,24 +2013,24 @@ by the user in their respective forms.

-
-deserialize(obj_dict)
+
+deserialize(obj_dict)

Re-builds an object from its serialized version. -@param obj_dict: Dictionary representing a CirkuixObj +@param obj_dict: Dictionary representing a FlatCAMObj @type obj_dict: dict @return None

-
-plot(figure)
+
+plot(figure)

Extend this method! Sets up axes if needed and clears them. Descendants must do the actual plotting.

-
-read_form()
+
+read_form()

Reads form into self.options.

@@ -1876,8 +2045,8 @@ clears them. Descendants must do the actual plotting.

-
-serialize()
+
+serialize()

Returns a representation of the object as a dictionary so it can be later exported as JSON. Override this method. @return: Dictionary representing the object @@ -1885,8 +2054,8 @@ it can be later exported as JSON. Override this method.

-
-set_form_item(option)
+
+set_form_item(option)

Copies the specified options to the UI form.

@@ -1901,8 +2070,8 @@ it can be later exported as JSON. Override this method.
-
-setup_axes(figure)
+
+setup_axes(figure)

1) Creates axes if they don’t exist. 2) Clears axes. 3) Attaches them to figure if not part of the figure. 4) Sets transparent background. 5) Sets 1:1 scale aspect ratio.

@@ -1921,8 +2090,8 @@ background. 5) Sets 1:1 scale aspect ratio.

-
-to_form()
+
+to_form()

Copies options to the UI form.

@@ -1937,26 +2106,45 @@ background. 5) Sets 1:1 scale aspect ratio.

-
-class cirkuix.CirkuixGerber(name)
+
+class FlatCAM.FlatCAMGerber(name)

Represents Gerber code.

+
+
+convert_units(units)
+

Converts the units of the object by scaling dimensions in all geometry +and options.

+
+++ + + + + + + + +
Parameters:units (str) – Units to which to convert the object: “IN” or “MM”.
Returns:None
Return type:None
+
+
-
-class cirkuix.CirkuixExcellon(name)
+
+class FlatCAM.FlatCAMExcellon(name)

Represents Excellon code.

-
-class cirkuix.CirkuixCNCjob(name, units='in', kind='generic', z_move=0.1, feedrate=3.0, z_cut=-0.002, tooldia=0.0)
+
+class FlatCAM.FlatCAMCNCjob(name, units='in', kind='generic', z_move=0.1, feedrate=3.0, z_cut=-0.002, tooldia=0.0)

Represents G-Code.

-
-class cirkuix.CirkuixGeometry(name)
+
+class FlatCAM.FlatCAMGeometry(name)

Geometric object not associated with a specific format.

diff --git a/doc/build/objects.inv b/doc/build/objects.inv index 08979611..15a3de41 100644 Binary files a/doc/build/objects.inv and b/doc/build/objects.inv differ diff --git a/doc/build/py-modindex.html b/doc/build/py-modindex.html index 0983483a..b3c249f8 100644 --- a/doc/build/py-modindex.html +++ b/doc/build/py-modindex.html @@ -122,17 +122,17 @@

Python Module Index

- c + f
- +
 
- c
+ f
- cirkuix + FlatCAM
diff --git a/doc/build/searchindex.js b/doc/build/searchindex.js index ba90a90e..45839dcb 100644 --- a/doc/build/searchindex.js +++ b/doc/build/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{represent:0,all:0,code:0,replot:0,focus:0,cirkuixgerb:0,follow:0,on_key_over_plot:0,whose:0,get_ev:0,on_options_upd:0,flash:0,gerber:0,buffer_path:0,on_click_over_plot:0,plot_al:0,set_current_pag:0,digit:0,everi:0,string:0,far:0,mous:0,"5e6cff":0,obround:0,untouch:0,gui:0,list:0,item:0,adjust:0,specal:0,get_radio_valu:0,create_geometri:0,natur:0,dimens:0,zero:0,pass:0,further:0,click:0,append:0,index:0,neg:0,current:0,delet:0,version:0,"new":0,method:0,whatev:0,widget:0,cirkuixobj:0,gener:0,load_default:0,matplotlib:0,adjust_ax:0,path:0,becom:0,modifi:0,toolbar:0,box:0,convert:0,on_file_saveprojectcopi:0,action:0,chang:0,on_activate_nam:0,on_options_object2app:0,diamet:0,via:0,app:0,on_fileopengerb:0,filenam:0,ymin:0,unit:0,plot:0,from:0,describ:0,doubl:0,chooser:0,setup_component_editor:0,call:0,save:0,type:0,more:0,on_delet:0,combo:0,on_gerber_generate_cutout:0,parse_fil:0,known:0,must:0,on_file_openproject:0,none:0,ser_attr:0,work:0,gtext:0,can:0,drill:0,z_move:0,overrid:0,polygon2gcod:0,give:0,process:0,share:0,stroke:0,minimum:0,xmin:0,serial:0,z_cut:0,alwai:0,surfac:0,fix_region:0,circular:0,parse_lin:0,resourc:0,after:0,befor:0,notebook:0,mai:0,setup_obj_class:0,associ:0,entry_text:0,correspond:0,element:0,callback:0,"switch":0,maintain:0,enter:0,on_replot:0,on_file_saveprojecta:0,travel:0,elin:0,comma:0,keyboard:0,on_excellon_tool_choos:0,paramet:0,fit:0,save_project:0,chosen:0,fix:0,gtk:0,set_list_select:0,window:0,on_options_app2object:0,main:[],alter:0,non:0,"float":0,"return":0,thei:0,handl:0,rectangl:0,f0e24d:0,build_list:0,project_filenam:0,choic:0,name:0,separ:0,solid_geometri:0,each:0,found:0,updat:0,button:0,read_form:0,b5ab3a:0,on_closewindow:0,continu:0,cirkuixcncjob:0,event:0,out:0,on_tree_selection_chang:0,on_eval_upd:0,generate_from_excellon_by_tool:0,content:0,geom:0,clear_polygon:0,linear:0,insid:0,loc:0,precaut:0,given:0,base:0,dictionari:0,org:0,care:0,generate_from_geometri:0,thread:0,motion:0,turn:0,plane:0,geometri:0,treeselect:0,onto:0,origin:0,copper:0,on_zoom_in:0,arrai:0,file_chooser_act:0,restrict:0,done:0,overwrit:0,thick:0,open:0,size:0,differ:0,width:0,data:0,interact:0,attach:0,editor:0,option:0,tool:0,copi:0,specifi:0,get_empty_area:0,generate_from_excellon:0,part:0,pars:0,number:0,kind:0,whenev:0,tree:0,entry_ev:0,project:0,str:0,build_ui:0,initi:0,ani:0,do_flash:0,have:0,need:0,inform:0,rout:0,note:0,also:0,on_options_object2project:0,build:0,which:0,event_handl:0,interior:0,on_success:0,singl:0,buffer:0,object:0,pair:0,alpha:0,segment:0,"class":0,don:0,clear:0,later:0,cover:0,on_mouse_move_over_plot:0,axi:0,thicken:0,show:0,text:[0,1],apertur:0,syntax:0,radio:0,find:0,on_scale_object:0,new_object:0,slow:0,ratio:0,menu:0,configur:0,activ:0,state:0,should:0,dict:0,factor:0,over:0,on_options_combo_chang:0,hit:0,get:0,on_entry_eval_activ:0,on_options_app2project:0,bar:0,to_dict:0,xmax:0,contain:0,where:0,dpi:0,set:0,startup:0,on_cncjob_exportgcod:0,maximum:0,"4650bd":0,see:0,result:0,close:0,contour:0,statu:0,extend:0,boundari:0,figur:0,between:0,progress:0,attribut:0,accord:0,kei:0,complement:0,isol:0,job:0,entir:0,here:0,popul:0,feedrat:0,rtype:0,region:0,setup_project_list:0,instanc:0,whole:0,col:0,obj_dict:0,load:0,cncjob:0,point:0,color:0,height:0,shortcut:0,respect:0,throughout:0,backend:0,quit:0,convert_unit:0,addition:0,been:0,mark:0,compon:0,json:0,trigger:0,valu:0,open_project:0,subscrib:0,immedi:0,radio_set:0,gcode:0,search:0,on_file_savedefault:0,coordin:0,on_options_project2object:0,func:0,present:0,inhibit:0,therefor:0,properti:0,rectangular:0,dest:0,defin:0,"while":0,setup_ax:0,margin:0,howev:[],them:0,exterior:0,on_fileopengcod:0,"__init__":0,around:0,format:0,same:0,respresent:0,html:0,descend:0,complet:0,http:0,widget_nam:0,upon:0,user:0,canva:0,typic:[],appropri:0,off:0,center:0,cirkuixexcellon:0,entri:0,knd:[],well:0,"_app_":0,without:0,on_file_new:0,thi:[],choos:0,on_generate_paintarea:0,self:0,left:0,distanc:0,identifi:0,just:0,isolation_geometri:0,rest:0,shape:0,aspect:0,linestr:0,speed:0,yet:0,cut:0,param:0,add:0,valid:0,board:0,subsequ:0,modul:0,pre_pars:0,take:0,applic:0,gcode_pars:0,transpar:0,read:0,on_file_saveproject:0,grid:0,background:0,press:0,bit:[],on_gerber_generate_noncopp:0,specif:0,success:0,zoom:0,integ:0,from_dict:0,necessari:0,either:0,exobj:0,on_clear_plot:0,page:0,depend:0,clear_plot:0,on_generate_isol:0,some:1,back:0,percentag:0,on_zoom_fit:0,setup_component_view:[],radiobutton:0,"export":0,plot2:0,on_generate_excellon_cncjob:0,scale:0,definit:0,overlap:0,on_update_plot:0,attac:[],flash_geometri:0,cnc:0,onli:0,machin:0,previou:0,run:0,plote:0,offset:0,about:0,actual:0,file_chooser_save_act:0,options2form:0,on_generate_cncjob:0,side:0,constructor:0,options_update_ignor:0,on_fileopenexcellon:0,setup_plot:0,regist:0,within:0,encod:0,bound:0,excellon:0,pute:0,accordingli:0,ymax:0,area:0,transfer:0,support:0,fast:0,start:0,clear_poli:0,get_curr:0,includ:0,fraction:0,on_canvas_configur:0,select:0,"function":0,creation:0,form:0,on_zoom_out:0,cirkuixgeometri:0,set_progress_bar:0,line:0,"true":0,info:0,made:0,on_generate_gerber_bounding_box:0,"default":0,access:0,displai:0,tooldia:0,record:0,limit:0,buffered_path:0,creat:0,request:0,dure:0,parser:0,aperture_pars:0,repres:0,"char":[],set_form_item:0,on_row_activ:0,exist:0,file:[],doe:0,check:0,tick:0,aplic:0,polygon:0,titl:0,to_form:0,when:0,detail:0,invalid:0,field:0,other:0,gline:0,ignor:0,on_options_project2app:0,read_form_item:0,deseri:0,variabl:0,draw:0,initil:[],eval:0,geometr:0,on_filequit:0},objtypes:{"0":"py:module","1":"py:method","2":"py:class","3":"py:attribute"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},filenames:["index","camlib"],titles:["Welcome to Cirkuix’s documentation!","This is the main file for camlib"],objects:{"":{cirkuix:[0,0,0,"-"]},"cirkuix.Gerber":{digits:[0,3,1,""],parse_lines:[0,1,1,""],scale:[0,1,1,""],aperture_parse:[0,1,1,""],create_geometry:[0,1,1,""],fix_regions:[0,1,1,""],fraction:[0,3,1,""],parse_file:[0,1,1,""],do_flashes:[0,1,1,""]},"cirkuix.CNCjob":{plot:[0,1,1,""],gcode_parse:[0,1,1,""],polygon2gcode:[0,1,1,""],generate_from_excellon_by_tool:[0,1,1,""],pre_parse:[0,1,1,""],generate_from_excellon:[0,1,1,""],scale:[0,1,1,""],generate_from_geometry:[0,1,1,""],plot2:[0,1,1,""]},"cirkuix.App":{on_options_object2app:[0,1,1,""],setup_plot:[0,1,1,""],file_chooser_action:[0,1,1,""],on_canvas_configure:[0,1,1,""],on_zoom_in:[0,1,1,""],on_delete:[0,1,1,""],on_closewindow:[0,1,1,""],get_current:[0,1,1,""],on_row_activated:[0,1,1,""],on_fileopengerber:[0,1,1,""],on_zoom_fit:[0,1,1,""],on_entry_eval_activate:[0,1,1,""],adjust_axes:[0,1,1,""],clear_plots:[0,1,1,""],set_form_item:[0,1,1,""],on_generate_excellon_cncjob:[0,1,1,""],read_form:[0,1,1,""],on_generate_isolation:[0,1,1,""],on_key_over_plot:[0,1,1,""],on_options_project2app:[0,1,1,""],on_gerber_generate_noncopper:[0,1,1,""],on_scale_object:[0,1,1,""],new_object:[0,1,1,""],on_activate_name:[0,1,1,""],save_project:[0,1,1,""],on_options_update:[0,1,1,""],on_update_plot:[0,1,1,""],get_eval:[0,1,1,""],on_options_object2project:[0,1,1,""],setup_component_editor:[0,1,1,""],on_click_over_plot:[0,1,1,""],open_project:[0,1,1,""],on_zoom_out:[0,1,1,""],load_defaults:[0,1,1,""],on_options_app2object:[0,1,1,""],read_form_item:[0,1,1,""],on_clear_plots:[0,1,1,""],on_tree_selection_changed:[0,1,1,""],on_options_combo_change:[0,1,1,""],on_file_saveproject:[0,1,1,""],setup_project_list:[0,1,1,""],on_gerber_generate_cutout:[0,1,1,""],on_options_project2object:[0,1,1,""],on_eval_update:[0,1,1,""],get_radio_value:[0,1,1,""],build_list:[0,1,1,""],set_progress_bar:[0,1,1,""],on_file_saveprojectas:[0,1,1,""],info:[0,1,1,""],on_file_openproject:[0,1,1,""],on_options_app2project:[0,1,1,""],plot_all:[0,1,1,""],on_file_saveprojectcopy:[0,1,1,""],file_chooser_save_action:[0,1,1,""],options2form:[0,1,1,""],on_generate_cncjob:[0,1,1,""],zoom:[0,1,1,""],on_file_savedefaults:[0,1,1,""],on_mouse_move_over_plot:[0,1,1,""],on_fileopengcode:[0,1,1,""],on_generate_gerber_bounding_box:[0,1,1,""],on_file_new:[0,1,1,""],setup_obj_classes:[0,1,1,""],on_generate_paintarea:[0,1,1,""],on_replot:[0,1,1,""],on_filequit:[0,1,1,""],on_cncjob_exportgcode:[0,1,1,""],on_excellon_tool_choose:[0,1,1,""],set_list_selection:[0,1,1,""],on_fileopenexcellon:[0,1,1,""]},cirkuix:{CNCjob:[0,2,1,""],CirkuixGeometry:[0,2,1,""],CirkuixExcellon:[0,2,1,""],Geometry:[0,2,1,""],CirkuixGerber:[0,2,1,""],App:[0,2,1,""],Gerber:[0,2,1,""],CirkuixObj:[0,2,1,""],CirkuixCNCjob:[0,2,1,""],Excellon:[0,2,1,""]},"cirkuix.Excellon":{parse_lines:[0,1,1,""],scale:[0,1,1,""]},"cirkuix.Geometry":{convert_units:[0,1,1,""],scale:[0,1,1,""],bounds:[0,1,1,""],get_empty_area:[0,1,1,""],isolation_geometry:[0,1,1,""],from_dict:[0,1,1,""],to_dict:[0,1,1,""],clear_polygon:[0,1,1,""],size:[0,1,1,""]},"cirkuix.CirkuixObj":{read_form:[0,1,1,""],plot:[0,1,1,""],to_form:[0,1,1,""],deserialize:[0,1,1,""],build_ui:[0,1,1,""],serialize:[0,1,1,""],setup_axes:[0,1,1,""],set_form_item:[0,1,1,""]}},titleterms:{document:0,welcom:0,thi:1,indic:0,cirkuix:0,camlib:1,file:1,tabl:0,main:1}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{represent:0,all:0,code:0,replot:0,focus:0,cirkuixgerb:[],follow:0,on_key_over_plot:0,whose:0,get_ev:0,on_options_upd:0,flash:0,gerber:0,flash_geometri:0,text:[0,1],plot_al:0,set_current_pag:0,digit:0,everi:0,string:0,far:0,mous:0,"5e6cff":0,obround:0,untouch:0,button:0,list:0,item:0,adjust:0,specal:0,round:0,get_radio_valu:0,create_geometri:0,natur:0,dimens:0,zero:0,pass:0,further:[],click:0,append:0,index:0,neg:0,current:0,delet:0,version:0,"new":0,method:0,whatev:0,widget:0,cirkuixobj:[],flatcamgeometri:0,gener:0,onli:0,matplotlib:0,adjust_ax:0,on_create_aligndril:0,path:0,becom:0,modifi:0,valu:0,box:0,convert:0,new_object:0,on_file_saveprojectcopi:0,action:0,chang:0,on_activate_nam:0,on_options_object2app:0,diamet:0,via:0,app:0,on_fileopengerb:0,filenam:0,ymin:0,unit:0,plot:0,from:0,describ:0,doubl:0,chooser:0,setup_component_editor:0,call:0,type:0,more:0,on_delet:0,factor:0,on_toggle_unit:0,on_gerber_generate_cutout:0,parse_fil:0,known:0,hole:0,must:0,on_file_openproject:0,none:0,ser_attr:0,work:0,gtext:0,can:0,drill:0,z_move:0,overrid:0,polygon2gcod:0,give:0,process:0,share:0,stroke:0,minimum:0,tab:0,xmin:0,serial:0,z_cut:0,alwai:0,surfac:0,fix_region:0,fals:0,updat:0,b5ab3a:0,resourc:0,after:0,befor:0,plane:0,mai:0,setup_obj_class:0,data:0,subsequ:0,read:0,onto:0,correspond:0,element:0,inform:0,"switch":0,maintain:0,enter:0,on_replot:0,on_file_saveprojecta:0,travel:0,elin:0,comma:0,keyboard:0,on_excellon_tool_choos:0,paramet:0,fit:0,respresent:0,chosen:0,fix:0,gtk:0,set_list_select:0,window:0,pcb:0,on_options_app2object:0,main:[],pixel:0,non:0,within:0,"return":0,thei:0,handl:0,rectangl:0,f0e24d:0,build_list:0,project_filenam:0,choic:0,name:0,separ:0,solid_geometri:0,each:0,found:0,circular:0,gui:0,read_form:0,parse_lin:0,on_closewindow:0,continu:0,cirkuixcncjob:[],event:0,out:0,on_tree_selection_chang:0,on_eval_upd:0,generate_from_excellon_by_tool:0,content:0,geom:0,clear_polygon:0,flatcamcncjob:0,alter:0,linear:0,insid:0,precaut:0,differ:0,flatcamexcellon:0,base:0,dictionari:0,org:0,care:0,generate_from_geometri:0,thread:0,launch:0,success:0,motion:0,turn:0,notebook:0,place:0,geometri:0,treeselect:0,entry_text:0,user:0,origin:0,copper:0,on_zoom_in:0,arrai:0,file_chooser_act:0,restrict:0,done:0,fast:0,thick:0,open:0,size:0,given:0,start:0,associ:0,interact:0,flatcamobj:0,attach:0,includ:0,option:0,tool:0,copi:0,specifi:0,get_empty_area:0,generate_from_excellon:0,part:0,pars:0,number:0,get_bounding_box:0,kind:0,whenev:0,tree:0,entry_ev:0,project:0,str:0,entri:0,posit:0,ani:0,do_flash:0,have:0,need:0,callback:0,rout:0,note:0,also:0,on_options_object2project:0,build:0,which:0,event_handl:0,interior:0,on_success:0,singl:0,buffer:0,object:0,pair:0,alpha:0,segment:0,"class":0,don:0,clear:0,later:0,cover:0,on_mouse_move_over_plot:0,populate_objects_combo:0,axi:0,thicken:0,show:0,on_click_over_plot:0,apertur:0,radiu:0,syntax:0,radio:0,corner:0,find:0,on_scale_object:0,load_default:0,slow:0,ratio:0,menu:0,configur:0,activ:0,state:0,should:0,comboboxtext:0,clipboard:0,dict:0,combo:0,over:0,on_options_combo_chang:0,hit:0,get:0,made:0,bar:0,on_create_mirror:0,to_dict:0,xmax:0,contain:0,where:0,dpi:0,set:0,startup:0,on_cncjob_exportgcod:0,displai:0,"4650bd":0,see:0,result:0,close:0,contour:0,statu:0,kei:0,boundari:0,figur:0,between:0,progress:0,attribut:0,accord:0,extend:0,complement:0,isol:0,job:0,entir:0,here:0,popul:0,both:0,feedrat:0,rtype:0,region:0,setup_project_list:0,instanc:0,whole:0,col:0,obj_dict:0,load:0,cncjob:0,point:0,color:0,height:0,param:0,respect:0,throughout:0,duplic:0,quit:0,do_someth:0,creat:0,addition:0,been:0,mark:0,compon:0,json:0,trigger:0,toolbar:0,open_project:0,subscrib:0,immedi:0,radio_set:0,gcode:0,imag:0,search:0,on_file_savedefault:0,coordin:0,on_options_project2object:0,func:0,present:0,inhibit:0,therefor:0,align:0,properti:0,rectangular:0,defin:0,"while":0,setup_ax:0,margin:0,howev:[],propag:0,layer:0,them:0,equal:0,exterior:0,on_fileopengcod:0,"__init__":0,gcode_pars:0,transpar:0,same:0,save_project:0,html:0,descend:0,complet:0,http:0,widget_nam:0,upon:0,pute:0,initi:0,canva:0,typic:[],appropri:0,off:0,center:0,cirkuixexcellon:[],build_ui:0,knd:[],well:0,"_app_":0,without:0,on_file_new:0,thi:[],choos:0,on_generate_paintarea:0,self:0,left:0,distanc:0,identifi:0,just:0,isolation_geometri:0,"true":0,flatcamgerb:0,rest:0,shape:0,aspect:0,linestr:0,speed:0,yet:[],wether:0,cut:0,on_tools_doublesid:0,shortcut:0,add:0,other:0,board:0,save:0,modul:0,pre_pars:0,take:0,applic:0,around:0,format:0,dest:0,on_file_saveproject:0,grid:0,background:0,press:0,bit:[],on_gerber_generate_noncopp:0,like:0,specif:0,zoom:0,integ:0,from_dict:0,necessari:0,either:0,exobj:0,on_clear_plot:0,page:0,depend:0,clear_plot:0,on_generate_isol:0,some:1,back:0,percentag:0,on_zoom_fit:0,setup_component_view:[],radiobutton:0,"export":0,mirror:0,plot2:0,on_generate_excellon_cncjob:0,scale:0,bottom:0,definit:0,overlap:0,on_update_plot:0,attac:[],buffer_path:0,cnc:0,backend:0,machin:0,previou:0,run:0,flatcam:0,usag:0,plote:0,offset:0,on_toggle_pointbox:0,about:0,actual:0,file_chooser_save_act:0,options2form:0,on_generate_cncjob:0,side:0,constructor:0,options_update_ignor:0,on_fileopenexcellon:0,setup_plot:0,regist:0,"float":0,encod:0,bound:0,excellon:0,loc:0,accordingli:0,ymax:0,area:0,transfer:0,support:0,overwrit:0,width:0,clear_poli:0,get_curr:0,editor:0,fraction:0,on_canvas_configur:0,select:0,"function":0,creation:0,form:0,on_zoom_out:0,cirkuixgeometri:[],set_progress_bar:0,line:0,on_entry_eval_activ:0,info:0,on_options_app2project:0,on_generate_gerber_bounding_box:0,"default":0,access:0,maximum:0,tooldia:0,record:0,limit:0,enlarg:0,buffered_path:0,convert_unit:0,request:0,dure:0,parser:0,aperture_pars:0,repres:0,"char":[],set_form_item:0,on_row_activ:0,exist:0,file:[],doe:0,check:0,again:0,tick:0,aplic:0,polygon:0,titl:0,to_form:0,when:0,detail:0,invalid:0,field:0,valid:0,bool:0,gline:0,geometr:0,on_options_project2app:0,read_form_item:0,deseri:0,variabl:0,draw:0,initil:[],eval:0,ignor:0,on_filequit:0},objtypes:{"0":"py:module","1":"py:method","2":"py:class","3":"py:attribute"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"]},filenames:["index","camlib"],titles:["Welcome to Cirkuix’s documentation!","This is the main file for camlib"],objects:{"":{FlatCAM:[0,0,0,"-"]},FlatCAM:{CNCjob:[0,2,1,""],FlatCAMGeometry:[0,2,1,""],Geometry:[0,2,1,""],App:[0,2,1,""],FlatCAMObj:[0,2,1,""],Gerber:[0,2,1,""],FlatCAMExcellon:[0,2,1,""],FlatCAMGerber:[0,2,1,""],Excellon:[0,2,1,""],FlatCAMCNCjob:[0,2,1,""]},"FlatCAM.FlatCAMGerber":{convert_units:[0,1,1,""]},"FlatCAM.Geometry":{convert_units:[0,1,1,""],scale:[0,1,1,""],to_dict:[0,1,1,""],bounds:[0,1,1,""],get_empty_area:[0,1,1,""],isolation_geometry:[0,1,1,""],from_dict:[0,1,1,""],clear_polygon:[0,1,1,""],size:[0,1,1,""]},"FlatCAM.App":{on_options_object2app:[0,1,1,""],setup_plot:[0,1,1,""],on_tree_selection_changed:[0,1,1,""],on_canvas_configure:[0,1,1,""],on_zoom_in:[0,1,1,""],on_delete:[0,1,1,""],on_toggle_units:[0,1,1,""],on_closewindow:[0,1,1,""],on_click_over_plot:[0,1,1,""],on_row_activated:[0,1,1,""],on_fileopengerber:[0,1,1,""],file_chooser_action:[0,1,1,""],on_zoom_out:[0,1,1,""],on_zoom_fit:[0,1,1,""],clear_plots:[0,1,1,""],on_file_savedefaults:[0,1,1,""],on_generate_excellon_cncjob:[0,1,1,""],set_form_item:[0,1,1,""],plot_all:[0,1,1,""],read_form:[0,1,1,""],on_generate_isolation:[0,1,1,""],on_key_over_plot:[0,1,1,""],on_options_project2app:[0,1,1,""],on_gerber_generate_noncopper:[0,1,1,""],on_scale_object:[0,1,1,""],new_object:[0,1,1,""],on_activate_name:[0,1,1,""],get_eval:[0,1,1,""],on_update_plot:[0,1,1,""],save_project:[0,1,1,""],on_options_object2project:[0,1,1,""],setup_component_editor:[0,1,1,""],get_current:[0,1,1,""],open_project:[0,1,1,""],on_options_update:[0,1,1,""],on_file_new:[0,1,1,""],on_options_app2object:[0,1,1,""],read_form_item:[0,1,1,""],on_entry_eval_activate:[0,1,1,""],on_tools_doublesided:[0,1,1,""],on_options_combo_change:[0,1,1,""],setup_obj_classes:[0,1,1,""],on_file_saveproject:[0,1,1,""],setup_project_list:[0,1,1,""],on_generate_gerber_bounding_box:[0,1,1,""],on_options_project2object:[0,1,1,""],on_eval_update:[0,1,1,""],on_replot:[0,1,1,""],build_list:[0,1,1,""],on_toggle_pointbox:[0,1,1,""],set_progress_bar:[0,1,1,""],on_file_saveprojectas:[0,1,1,""],info:[0,1,1,""],on_file_openproject:[0,1,1,""],on_options_app2project:[0,1,1,""],adjust_axes:[0,1,1,""],on_file_saveprojectcopy:[0,1,1,""],on_create_mirror:[0,1,1,""],file_chooser_save_action:[0,1,1,""],on_excellon_tool_choose:[0,1,1,""],on_generate_cncjob:[0,1,1,""],zoom:[0,1,1,""],on_clear_plots:[0,1,1,""],on_mouse_move_over_plot:[0,1,1,""],on_fileopengcode:[0,1,1,""],on_gerber_generate_cutout:[0,1,1,""],load_defaults:[0,1,1,""],populate_objects_combo:[0,1,1,""],on_create_aligndrill:[0,1,1,""],on_generate_paintarea:[0,1,1,""],get_radio_value:[0,1,1,""],on_filequit:[0,1,1,""],on_cncjob_exportgcode:[0,1,1,""],options2form:[0,1,1,""],set_list_selection:[0,1,1,""],on_fileopenexcellon:[0,1,1,""]},"FlatCAM.CNCjob":{gcode_parse:[0,1,1,""],polygon2gcode:[0,1,1,""],generate_from_excellon_by_tool:[0,1,1,""],pre_parse:[0,1,1,""],generate_from_excellon:[0,1,1,""],scale:[0,1,1,""],generate_from_geometry:[0,1,1,""],plot2:[0,1,1,""]},"FlatCAM.Excellon":{parse_lines:[0,1,1,""],scale:[0,1,1,""]},"FlatCAM.FlatCAMObj":{read_form:[0,1,1,""],plot:[0,1,1,""],serialize:[0,1,1,""],deserialize:[0,1,1,""],build_ui:[0,1,1,""],to_form:[0,1,1,""],setup_axes:[0,1,1,""],set_form_item:[0,1,1,""]},"FlatCAM.Gerber":{digits:[0,3,1,""],aperture_parse:[0,1,1,""],scale:[0,1,1,""],parse_lines:[0,1,1,""],create_geometry:[0,1,1,""],fix_regions:[0,1,1,""],fraction:[0,3,1,""],parse_file:[0,1,1,""],get_bounding_box:[0,1,1,""],do_flashes:[0,1,1,""]}},titleterms:{file:1,main:1,welcom:0,indic:0,cirkuix:0,camlib:1,thi:1,tabl:0,document:0}}) \ No newline at end of file diff --git a/doc/source/camlib.rst b/doc/source/camlib.rst deleted file mode 100644 index 32e60205..00000000 --- a/doc/source/camlib.rst +++ /dev/null @@ -1,4 +0,0 @@ -This is the main file for camlib -================================= - -Some text. \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 4b57240f..9a9ed4f3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,7 +5,7 @@ -Welcome to Cirkuix's documentation! +Welcome to FlatCAM's documentation! =================================== Contents: @@ -13,7 +13,7 @@ Contents: .. toctree:: :maxdepth: 2 -.. automodule:: cirkuix +.. automodule:: FlatCAM .. autoclass:: App :members: @@ -30,19 +30,19 @@ Contents: .. autoclass:: CNCjob :members: -.. autoclass:: CirkuixObj +.. autoclass:: FlatCAMObj :members: -.. autoclass:: CirkuixGerber +.. autoclass:: FlatCAMGerber :members: -.. autoclass:: CirkuixExcellon +.. autoclass:: FlatCAMExcellon :members: -.. autoclass:: CirkuixCNCjob +.. autoclass:: FlatCAMCNCjob :members: -.. autoclass:: CirkuixGeometry +.. autoclass:: FlatCAMGeometry :members: