jaseg/gerbonara
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add some documentation

Browse source
This commit is contained in:
jaseg 2022-02-01 22:08:54 +01:00
parent c3ca4f95bd
commit 7473e471dc
28 changed files with 788 additions and 941 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/object-api.rst Normal file
View file

@ -0,0 +1,30 @@
Graphic Objects
===============
Graphic objects are the lego blocks a gerbonara :py:class:`gerbonara.rs274x.GerberFile` or
:py:class:`gerbonara.excellon.ExcellonFile` is built from. They are stored in the file's
:py:attr:`gerbonara.rs274x.GerberFile.objects` list. You can directly manipulate that list from code.
There are four graphic object types: :py:class:`gerbonara.graphic_objects.Flash`,
:py:class:`gerbonara.graphic_objects.Line`, :py:class:`gerbonara.graphic_objects.Arc`, and
:py:class:`gerbonara.graphic_objects.Region` . All of them are derived from
:py:class:`gerbonara.graphic_objects.GraphicObject`.
.. autoclass:: gerbonara.graphic_objects.GraphicObject
:members:
.. autoclass:: gerbonara.graphic_objects.Flash
:members:
.. autoclass:: gerbonara.graphic_objects.Line
:members:
.. autoclass:: gerbonara.graphic_objects.Arc
:members:
.. autoclass:: gerbonara.graphic_objects.Region
:members:
.. _pcb-tools: https://github.com/opiopan/pcb-tools-extension
.. _gerbolyze: https://github.com/jaseg/gerbolyze
.. _svg-flatten: https://github.com/jaseg/gerbolyze/tree/main/svg-flatten