doc updates (developer info)

This commit is contained in:
stefan schippers 2024-03-11 18:39:07 +01:00
parent fdebbb3a6c
commit 19bbbe449a
1 changed files with 23 additions and 2 deletions

View File

@ -297,6 +297,7 @@ device="tantalium capacitor"<br>
<h3>WIRE OBJECT</h3>
<p>
Example: <kbd>N 890 -130 890 -110 {lab=ANALOG_GND}</kbd><br>
Format: <kbd>N x1 y1 x2 y2 {attributes}</kbd><br>
The net 'N' tag is followed by the end point coordinates x1,y1 - x2,y2.
(stored and read as double precision numbers) and a property string, used in this case to name the net.
In most cases you don't need to specify attributes for nets (one exception is the <kbd>bus</kbd> attribute)
@ -310,33 +311,53 @@ device="tantalium capacitor"<br>
<h3>LINE OBJECT</h3>
<p>
Example: <kbd>L 4 -50 20 50 20 {This is a line on layer 4}</kbd><br>
Format: <kbd>L layer x1 y1 x2 y2 {attributes}</kbd><br>
The line 'L' tag is followed by an integer specifying the graphic layer
followed by the x1,y1 - x2,y2 coordinates of the line and a property string.
</p>
<h3>RECTANGLE OBJECT</h3>
<p>
Example: <kbd>B 5 -62.5 -2.5 -57.5 2.5 {name=IN dir=in pinnumber=1}</kbd><br>
Format: <kbd>B layer x1 y1 x2 y2 {attributes}</kbd><br>
The 'Box' 'B' tag is followed by an integer specifying the graphic layer followed
by the x1,y1 - x2,y2 coordinates of the rectangle
and a final property string. This example defines a symbol pin.
and a final property string. This example defines a symbol pin.<br>
A <kbd>fill=true</kbd> attribute may be given get a patterned fill (this is the default for rectangles).<br>
A <kbd>fill=false</kbd> attribute may be given to avoid a fill pattern.<br>
A <kbd>fill=full</kbd> attribute may be given to get a full solid fill.<br>
Example: <kbd>B 4 100 -300 400 100 {fill=false}</kbd><br>
</p>
<h3>OPEN / CLOSED POLYGON OBJECT</h3>
<p>
Example: <kbd>P 3 5 2450 -210 2460 -170 2500 -170 2510 -210 2450 -210 {}</kbd><br>
Format: <kbd> P layer npoints px1 py1 px2 py2 .... {attributes}</kbd><br>
the Polygon 'P' tag is followed by an integer specifying the layer number,
followed by the number of points (integer),
the x,y coordinates of the polygon points and the property string (empty in this example).
If the last point is coincident to the first point a closed polygon is drawn.
A 'fill=true' arribute may be given to fill a closed polygon, in this case a polygon line looks like:<br>
A <kbd>fill=true</kbd> attribute may be given to fill a closed polygon, in this case a polygon line looks like:<br>
<kbd>P 3 5 2450 -210 2460 -170 2500 -170 2510 -210 2450 -210 {fill=true}</kbd><br>
A <kbd>fill=full</kbd> attribute will paint the polygon with a solid full color (instead of a patterned fill).<br>
A <kbd>bezier=true</kbd> attribute will transform the polygon into a bezier curve. See
<a href="commands.html">the editor commands page on polygons.</a>
</p>
<h3>ARC OBJECT</h3>
<p>
Example: <kbd>A 3 450 -210 120 45 225 {}</kbd><br>
Format: <kbd>A x y r a b {attributes}</kbd><br>
The Arc 'A' tag is followed by an integer specifying the layer number, followed by the arc x, y center coordinates,
the arc radius, the start angle (measured counterclockwise from the three o'clock direction), the arc sweep angle
(measured counterclockwise from the start angle) and the property string (empty in this example).
Angles are measured in degrees.<br>
Arcs can be filled or not:<br>
A <kbd>fill=true</kbd> attribute may be given get a patterned fill.<br>
A <kbd>fill=false</kbd> attribute may be given to avoid a fill pattern. This is the default<br>
A <kbd>fill=full</kbd> attribute may be given to get a full solid fill.<br>
Circles are just arcs with a sweep angle of 360 degrees.<br>
Example: <kbd>A 4 100 -40 40 0 360 {fill=full}</kbd><br>
<img src="developer_info_07.png">
</p>
<h3>COMPONENT INSTANCE</h3>