summaryrefslogtreecommitdiff
path: root/docs/graphic-primitive-api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/graphic-primitive-api.rst')
-rw-r--r--docs/graphic-primitive-api.rst27
1 files changed, 19 insertions, 8 deletions
diff --git a/docs/graphic-primitive-api.rst b/docs/graphic-primitive-api.rst
index d506e87..ff22b76 100644
--- a/docs/graphic-primitive-api.rst
+++ b/docs/graphic-primitive-api.rst
@@ -1,17 +1,22 @@
Graphic Primitives
==================
-.. autoclass:: gerbonara.graphic_primitives.GraphicPrimitive
- :members:
+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`.
-.. autoclass:: gerbonara.graphic_primitives.Circle
- :members:
+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.Obround
+.. autoclass:: gerbonara.graphic_primitives.GraphicPrimitive
:members:
-.. autoclass:: gerbonara.graphic_primitives.ArcPoly
- :members:
+The five types of Graphic Primitives
+------------------------------------
+
+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: