fonttools/Documentation/robofabDocs/robofab.pens.filterPen.html
Erik van Blokland 3646055ea2 initial import
git-svn-id: http://svn.robofab.com/trunk@1 b5fa9d6c-a76f-4ffd-b3cb-f825fc41095c
2008-01-07 17:40:34 +00:00

118 lines
7.5 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module robofab.pens.filterPen</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="robofab.html"><font color="#ffffff">robofab</font></a>.<a href="robofab.pens.html"><font color="#ffffff">pens</font></a>.filterPen</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/code/projects/robofab/Lib/robofab/pens/filterPen.py">/code/projects/robofab/Lib/robofab/pens/filterPen.py</a></font></td></tr></table>
<p><tt>A&nbsp;couple&nbsp;of&nbsp;point&nbsp;pens&nbsp;to&nbsp;filter&nbsp;contours&nbsp;in&nbsp;various&nbsp;ways.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="math.html">math</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="fontTools.pens.basePen.html#AbstractPen">fontTools.pens.basePen.AbstractPen</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="robofab.pens.filterPen.html#ThresholdPen">ThresholdPen</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="fontTools.pens.basePen.html#BasePen">fontTools.pens.basePen.BasePen</a>(<a href="fontTools.pens.basePen.html#AbstractPen">fontTools.pens.basePen.AbstractPen</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="robofab.pens.filterPen.html#FlattenPen">FlattenPen</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FlattenPen">class <strong>FlattenPen</strong></a>(<a href="fontTools.pens.basePen.html#BasePen">fontTools.pens.basePen.BasePen</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Process&nbsp;the&nbsp;contours&nbsp;into&nbsp;a&nbsp;series&nbsp;of&nbsp;straight&nbsp;lines&nbsp;by&nbsp;flattening&nbsp;the&nbsp;curves.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="robofab.pens.filterPen.html#FlattenPen">FlattenPen</a></dd>
<dd><a href="fontTools.pens.basePen.html#BasePen">fontTools.pens.basePen.BasePen</a></dd>
<dd><a href="fontTools.pens.basePen.html#AbstractPen">fontTools.pens.basePen.AbstractPen</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FlattenPen-__init__"><strong>__init__</strong></a>(self, otherPen, approximateSegmentLength<font color="#909090">=5</font>, segmentLines<font color="#909090">=False</font>, filterDoubles<font color="#909090">=True</font>)</dt></dl>
<dl><dt><a name="FlattenPen-addComponent"><strong>addComponent</strong></a>(self, glyphName, transformation)</dt></dl>
<hr>
Methods inherited from <a href="fontTools.pens.basePen.html#BasePen">fontTools.pens.basePen.BasePen</a>:<br>
<dl><dt><a name="FlattenPen-closePath"><strong>closePath</strong></a>(self)</dt></dl>
<dl><dt><a name="FlattenPen-curveTo"><strong>curveTo</strong></a>(self, *points)</dt></dl>
<dl><dt><a name="FlattenPen-endPath"><strong>endPath</strong></a>(self)</dt></dl>
<dl><dt><a name="FlattenPen-lineTo"><strong>lineTo</strong></a>(self, pt)</dt></dl>
<dl><dt><a name="FlattenPen-moveTo"><strong>moveTo</strong></a>(self, pt)</dt></dl>
<dl><dt><a name="FlattenPen-qCurveTo"><strong>qCurveTo</strong></a>(self, *points)</dt></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="ThresholdPen">class <strong>ThresholdPen</strong></a>(<a href="fontTools.pens.basePen.html#AbstractPen">fontTools.pens.basePen.AbstractPen</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Removes&nbsp;segments&nbsp;shorter&nbsp;in&nbsp;length&nbsp;than&nbsp;the&nbsp;threshold&nbsp;value.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="ThresholdPen-__init__"><strong>__init__</strong></a>(self, otherPen, threshold<font color="#909090">=10</font>)</dt></dl>
<dl><dt><a name="ThresholdPen-addComponent"><strong>addComponent</strong></a>(self, glyphName, transformation)</dt></dl>
<dl><dt><a name="ThresholdPen-closePath"><strong>closePath</strong></a>(self)</dt></dl>
<dl><dt><a name="ThresholdPen-curveTo"><strong>curveTo</strong></a>(self, pt1, pt2, pt3)</dt></dl>
<dl><dt><a name="ThresholdPen-endPath"><strong>endPath</strong></a>(self)</dt></dl>
<dl><dt><a name="ThresholdPen-lineTo"><strong>lineTo</strong></a>(self, pt, smooth<font color="#909090">=False</font>)</dt></dl>
<dl><dt><a name="ThresholdPen-moveTo"><strong>moveTo</strong></a>(self, pt)</dt></dl>
<dl><dt><a name="ThresholdPen-qCurveTo"><strong>qCurveTo</strong></a>(self, *points)</dt></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-distance"><strong>distance</strong></a>(pt1, pt2)</dt></dl>
<dl><dt><a name="-flattenGlyph"><strong>flattenGlyph</strong></a>(aGlyph, threshold<font color="#909090">=10</font>, segmentLines<font color="#909090">=True</font>)</dt><dd><tt>Replace&nbsp;curves&nbsp;with&nbsp;series&nbsp;of&nbsp;straight&nbsp;l&nbsp;ines.</tt></dd></dl>
<dl><dt><a name="-halftoneGlyph"><strong>halftoneGlyph</strong></a>(aGlyph, invert<font color="#909090">=False</font>)</dt><dd><tt>Convert&nbsp;the&nbsp;glyph&nbsp;into&nbsp;some&nbsp;sort&nbsp;of&nbsp;halftoning&nbsp;pattern.<br>
Measure&nbsp;a&nbsp;bunch&nbsp;of&nbsp;inside/outside&nbsp;points&nbsp;to&nbsp;simulate&nbsp;grayscale&nbsp;levels.<br>
Slow.</tt></dd></dl>
<dl><dt><a name="-spikeGlyph"><strong>spikeGlyph</strong></a>(aGlyph, segmentLength<font color="#909090">=20</font>, spikeLength<font color="#909090">=40</font>, patternFunc<font color="#909090">=None</font>)</dt><dd><tt>Add&nbsp;narly&nbsp;spikes&nbsp;or&nbsp;dents&nbsp;to&nbsp;the&nbsp;glyph.<br>
patternFunc&nbsp;is&nbsp;an&nbsp;optional&nbsp;function&nbsp;which&nbsp;recalculates&nbsp;the&nbsp;offset.</tt></dd></dl>
<dl><dt><a name="-thresholdGlyph"><strong>thresholdGlyph</strong></a>(aGlyph, threshold<font color="#909090">=10</font>)</dt></dl>
</td></tr></table>
</body></html>