More doc!

This commit is contained in:
jaseg 2022-02-03 01:02:45 +01:00
parent 18b9da8660
commit ac66fd9d6b
9 changed files with 381 additions and 312 deletions

View file

@ -4,9 +4,6 @@ Aperture Macros
.. autoclass:: gerbonara.aperture_macros.parse.ApertureMacro
:members:
.. autoclass:: gerbonara.aperture_macros.parse.GenericMacros
:members:
.. autoclass:: gerbonara.aperture_macros.expression.Expression
:members:

View file

@ -1,17 +1,22 @@
Graphic Primitives
==================
Graphic prmitives are the core of Gerbonara's rendering interface. Individual graphic objects such as a Gerber
:py:class:`.Region` as well as entire layers such as a :py:class:`.GerberFile` can be rendered into a list of graphic
primitives. This rendering step resolves aperture definitions, calculates out aperture macros, converts units into a
given target unit, and maps complex shapes to a small number of subclasses of :py:class:`.GraphicPrimitive`.
All graphic primitives have a :py:attr:`~.GraphicPrimitive.polarity_dark` attribute. Its meaning is identical with
:py:attr:`.GraphicObject.polarity_dark`.
.. autoclass:: gerbonara.graphic_primitives.GraphicPrimitive
:members:
.. autoclass:: gerbonara.graphic_primitives.Circle
:members:
The five types of Graphic Primitives
------------------------------------
.. autoclass:: gerbonara.graphic_primitives.Obround
:members:
.. autoclass:: gerbonara.graphic_primitives.ArcPoly
:members:
Stroked lines
~~~~~~~~~~~~~
.. autoclass:: gerbonara.graphic_primitives.Line
:members:
@ -19,9 +24,15 @@ Graphic Primitives
.. autoclass:: gerbonara.graphic_primitives.Arc
:members:
Filled shapes
~~~~~~~~~~~~~
.. autoclass:: gerbonara.graphic_primitives.Circle
:members:
.. autoclass:: gerbonara.graphic_primitives.Rectangle
:members:
.. autoclass:: gerbonara.graphic_primitives.RegularPolygon
.. autoclass:: gerbonara.graphic_primitives.ArcPoly
:members: