Google Git
Sign in
gfiber / vendor / opensource / projectM / b82e9b0d19af7e840f567433c3273422c3aa3c4f / . / src / macos / FTGL / docs / html / classFTVectoriser.html
blob: 15d43f003105a48752d8a7032cdbd91e6a5b6a50 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>FTGL: FTVectoriser class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
<h1>FTVectoriser Class Reference</h1><code>#include &lt;<a class="el" href="FTVectoriser_8h-source.html">FTVectoriser.h</a>&gt;</code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
FTVectoriser class is a helper class that converts font outlines into point data.
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classFTExtrdGlyph.html">FTExtrdGlyph</a> <p>
<a class="el" href="classFTOutlineGlyph.html">FTOutlineGlyph</a> <p>
<a class="el" href="classFTPolyGlyph.html">FTPolyGlyph</a> <p>
<a class="el" href="classFTContour.html">FTContour</a> <p>
<a class="el" href="classFTPoint.html">FTPoint</a> </dd></dl>
<p>
<p>
Definition at line <a class="el" href="FTVectoriser_8h-source.html#l00178">178</a> of file <a class="el" href="FTVectoriser_8h-source.html">FTVectoriser.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a0">FTVectoriser</a> (const FT_GlyphSlot glyph)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a1">~FTVectoriser</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#a1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a2">MakeMesh</a> (<a class="el" href="FTGL_8h.html#a4">FTGL_DOUBLE</a> zNormal=<a class="el" href="FTVectoriser_8h.html#a0">FTGL_FRONT_FACING</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build an <a class="el" href="classFTMesh.html">FTMesh</a> from the vector outline data. <a href="#a2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classFTMesh.html">FTMesh</a> *const &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a3">GetMesh</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current mesh. <a href="#a3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a4">PointCount</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the total count of points in this outline. <a href="#a4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a5">ContourCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the count of contours in this outline. <a href="#a5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classFTContour.html">FTContour</a> *const &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a6">Contour</a> (unsigned int index) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a contour at index. <a href="#a6"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a7">ContourSize</a> (int c) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of points in a specific contour in this outline. <a href="#a7"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTVectoriser.html#a8">ContourFlag</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the flag for the tesselation rule for this outline. <a href="#a8"></a><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="FTVectoriser::FTVectoriser" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FTVectoriser::FTVectoriser </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const FT_GlyphSlot&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>glyph</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>glyph</em>&nbsp;</td><td>The freetype glyph to be processed </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="FTVectoriser_8cpp-source.html#l00101">101</a> of file <a class="el" href="FTVectoriser_8cpp-source.html">FTVectoriser.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="FTVectoriser::~FTVectoriser" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FTVectoriser::~<a class="el" href="classFTVectoriser.html">FTVectoriser</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor.
<p>
<p>
Definition at line <a class="el" href="FTVectoriser_8cpp-source.html#l00120">120</a> of file <a class="el" href="FTVectoriser_8cpp-source.html">FTVectoriser.cpp</a>.
<p>
References <a class="el" href="FTVectoriser_8h-source.html#l00218">ContourCount()</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6" doxytag="FTVectoriser::Contour" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classFTContour.html">FTContour</a> *const FTVectoriser::Contour </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Return a contour at index.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the number of contours </dd></dl>
<p>
Definition at line <a class="el" href="FTVectoriser_8cpp-source.html#l00169">169</a> of file <a class="el" href="FTVectoriser_8cpp-source.html">FTVectoriser.cpp</a>.
<p>
References <a class="el" href="FTVectoriser_8h-source.html#l00218">ContourCount()</a>.
<p>
Referenced by <a class="el" href="FTExtrdGlyph_8cpp-source.html#l00009">FTExtrdGlyph::FTExtrdGlyph()</a>, and <a class="el" href="FTOutlineGlyph_8cpp-source.html#l00005">FTOutlineGlyph::FTOutlineGlyph()</a>. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="FTVectoriser::ContourCount" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t FTVectoriser::ContourCount </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the count of contours in this outline.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the number of contours </dd></dl>
<p>
Definition at line <a class="el" href="FTVectoriser_8h-source.html#l00218">218</a> of file <a class="el" href="FTVectoriser_8h-source.html">FTVectoriser.h</a>.
<p>
Referenced by <a class="el" href="FTVectoriser_8cpp-source.html#l00169">Contour()</a>, <a class="el" href="FTExtrdGlyph_8cpp-source.html#l00009">FTExtrdGlyph::FTExtrdGlyph()</a>, <a class="el" href="FTOutlineGlyph_8cpp-source.html#l00005">FTOutlineGlyph::FTOutlineGlyph()</a>, <a class="el" href="FTPolyGlyph_8cpp-source.html#l00005">FTPolyGlyph::FTPolyGlyph()</a>, <a class="el" href="FTVectoriser_8cpp-source.html#l00175">MakeMesh()</a>, <a class="el" href="FTVectoriser_8cpp-source.html#l00157">PointCount()</a>, and <a class="el" href="FTVectoriser_8cpp-source.html#l00120">~FTVectoriser()</a>. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="FTVectoriser::ContourFlag" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int FTVectoriser::ContourFlag </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the flag for the tesselation rule for this outline.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The contour flag </dd></dl>
<p>
Definition at line <a class="el" href="FTVectoriser_8h-source.html#l00240">240</a> of file <a class="el" href="FTVectoriser_8h-source.html">FTVectoriser.h</a>.
<p>
Referenced by <a class="el" href="FTExtrdGlyph_8cpp-source.html#l00009">FTExtrdGlyph::FTExtrdGlyph()</a>. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="FTVectoriser::ContourSize" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t FTVectoriser::ContourSize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>c</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the number of points in a specific contour in this outline.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>c</em>&nbsp;</td><td>The contour index </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the number of points in contour[c] </dd></dl>
<p>
Definition at line <a class="el" href="FTVectoriser_8h-source.html#l00233">233</a> of file <a class="el" href="FTVectoriser_8h-source.html">FTVectoriser.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="FTVectoriser::GetMesh" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const <a class="el" href="classFTMesh.html">FTMesh</a>* const FTVectoriser::GetMesh </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the current mesh.
<p>
<p>
Definition at line <a class="el" href="FTVectoriser_8h-source.html#l00204">204</a> of file <a class="el" href="FTVectoriser_8h-source.html">FTVectoriser.h</a>.
<p>
Referenced by <a class="el" href="FTExtrdGlyph_8cpp-source.html#l00009">FTExtrdGlyph::FTExtrdGlyph()</a>, and <a class="el" href="FTPolyGlyph_8cpp-source.html#l00005">FTPolyGlyph::FTPolyGlyph()</a>. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="FTVectoriser::MakeMesh" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void FTVectoriser::MakeMesh </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="FTGL_8h.html#a4">FTGL_DOUBLE</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>zNormal</em> = <a class="el" href="FTVectoriser_8h.html#a0">FTGL_FRONT_FACING</a> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Build an <a class="el" href="classFTMesh.html">FTMesh</a> from the vector outline data.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>zNormal</em>&nbsp;</td><td>The direction of the z axis of the normal for this mesh </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="FTVectoriser_8cpp-source.html#l00175">175</a> of file <a class="el" href="FTVectoriser_8cpp-source.html">FTVectoriser.cpp</a>.
<p>
References <a class="el" href="FTVectoriser_8h-source.html#l00218">ContourCount()</a>, <a class="el" href="FTGL_8h-source.html#l00005">FTGL_DOUBLE</a>, <a class="el" href="FTVectoriser_8cpp-source.html#l00039">ftglBegin()</a>, <a class="el" href="FTVectoriser_8cpp-source.html#l00032">ftglCombine()</a>, <a class="el" href="FTVectoriser_8cpp-source.html#l00045">ftglEnd()</a>, <a class="el" href="FTVectoriser_8cpp-source.html#l00019">ftglError()</a>, <a class="el" href="FTVectoriser_8cpp-source.html#l00025">ftglVertex()</a>, <a class="el" href="FTContour_8h-source.html#l00044">FTContour::Point()</a>, and <a class="el" href="FTContour_8h-source.html#l00051">FTContour::PointCount()</a>.
<p>
Referenced by <a class="el" href="FTExtrdGlyph_8cpp-source.html#l00009">FTExtrdGlyph::FTExtrdGlyph()</a>, and <a class="el" href="FTPolyGlyph_8cpp-source.html#l00005">FTPolyGlyph::FTPolyGlyph()</a>. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="FTVectoriser::PointCount" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t FTVectoriser::PointCount </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the total count of points in this outline.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>the number of points </dd></dl>
<p>
Definition at line <a class="el" href="FTVectoriser_8cpp-source.html#l00157">157</a> of file <a class="el" href="FTVectoriser_8cpp-source.html">FTVectoriser.cpp</a>.
<p>
References <a class="el" href="FTVectoriser_8h-source.html#l00218">ContourCount()</a>, and <a class="el" href="FTContour_8h-source.html#l00051">FTContour::PointCount()</a>.
<p>
Referenced by <a class="el" href="FTExtrdGlyph_8cpp-source.html#l00009">FTExtrdGlyph::FTExtrdGlyph()</a>, <a class="el" href="FTOutlineGlyph_8cpp-source.html#l00005">FTOutlineGlyph::FTOutlineGlyph()</a>, and <a class="el" href="FTPolyGlyph_8cpp-source.html#l00005">FTPolyGlyph::FTPolyGlyph()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="FTVectoriser_8h-source.html">FTVectoriser.h</a><li><a class="el" href="FTVectoriser_8cpp-source.html">FTVectoriser.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Dec 5 22:24:07 2004 for FTGL by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.6 </small></address>
</body>
</html>