<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FTGL: FTLayout.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FTGL <span id="projectnumber">2.1.3~rc5</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>FTLayout.h</h1> </div>
</div>
<div class="contents">
<a href="FTLayout_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * FTGL - OpenGL font library</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (c) 2001-2004 Henry Maddocks <ftgl@opengl.geek.nz></span>
<a name="l00005"></a>00005 <span class="comment"> * Copyright (c) 2008 Sam Hocevar <sam@zoy.org></span>
<a name="l00006"></a>00006 <span class="comment"> * Copyright (c) 2008 Sean Morrison <learner@brlcad.org></span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00009"></a>00009 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00010"></a>00010 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00011"></a>00011 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00012"></a>00012 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00013"></a>00013 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00014"></a>00014 <span class="comment"> * the following conditions:</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00017"></a>00017 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00020"></a>00020 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00021"></a>00021 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00022"></a>00022 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY</span>
<a name="l00023"></a>00023 <span class="comment"> * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,</span>
<a name="l00024"></a>00024 <span class="comment"> * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE</span>
<a name="l00025"></a>00025 <span class="comment"> * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00026"></a>00026 <span class="comment"> */</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef __ftgl__</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor"># warning This header is deprecated. Please use <FTGL/ftgl.h> from now.</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor"># include <FTGL/ftgl.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#endif</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef __FTLayout__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __FTLayout__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">class </span>FTLayoutImpl;
<a name="l00040"></a>00040
<a name="l00052"></a><a class="code" href="classFTLayout.html">00052</a> <span class="keyword">class </span><a class="code" href="ftgl_8h.html#ae472b08d77a4ead09abe74fe37220270">FTGL_EXPORT</a> <a class="code" href="classFTLayout.html" title="FTLayout is the interface for layout managers that render text.">FTLayout</a>
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 <span class="keyword">protected</span>:
<a name="l00055"></a>00055 <a class="code" href="classFTLayout.html" title="FTLayout is the interface for layout managers that render text.">FTLayout</a>();
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">private</span>:
<a name="l00064"></a>00064 <a class="code" href="classFTLayout.html" title="FTLayout is the interface for layout managers that render text.">FTLayout</a>(FTLayoutImpl *pImpl);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">/* Allow our internal subclasses to access the private constructor */</span>
<a name="l00067"></a><a class="code" href="classFTLayout.html#ae27eaa779922d14c8eb0f476456c7099">00067</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classFTSimpleLayout.html" title="FTSimpleLayout is a specialisation of FTLayout for simple text boxes.">FTSimpleLayout</a>;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">public</span>:
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <a class="code" href="classFTLayout.html#aee0787f8975a809261fb49813f0baac4" title="Destructor.">~FTLayout</a>();
<a name="l00074"></a>00074
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <a class="code" href="classFTBBox.html" title="FTBBox is a convenience class for handling bounding boxes.">FTBBox</a> <a class="code" href="classFTSimpleLayout.html#a132c938c66912fe0b2360152349f887c" title="Get the bounding box for a formatted string.">BBox</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>, <span class="keyword">const</span> <span class="keywordtype">int</span> len = -1,
<a name="l00086"></a>00086 <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a> position = <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a>()) = 0;
<a name="l00087"></a>00087
<a name="l00098"></a>00098 <span class="keyword">virtual</span> <a class="code" href="classFTBBox.html" title="FTBBox is a convenience class for handling bounding boxes.">FTBBox</a> <a class="code" href="classFTSimpleLayout.html#a132c938c66912fe0b2360152349f887c" title="Get the bounding box for a formatted string.">BBox</a>(<span class="keyword">const</span> <span class="keywordtype">wchar_t</span>* <span class="keywordtype">string</span>, <span class="keyword">const</span> <span class="keywordtype">int</span> len = -1,
<a name="l00099"></a>00099 <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a> position = <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a>()) = 0;
<a name="l00100"></a>00100
<a name="l00111"></a>00111 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFTSimpleLayout.html#afc122918b71e571155ca714eeb5c4888" title="Render a string of characters.">Render</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span>, <span class="keyword">const</span> <span class="keywordtype">int</span> len = -1,
<a name="l00112"></a>00112 <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a> position = <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a>(),
<a name="l00113"></a>00113 <span class="keywordtype">int</span> renderMode = <a class="code" href="namespaceFTGL.html#a9916822cb1247bd2e1aae26f7bfec74ea2966ccc38996af16a67387177a8c6a62">FTGL::RENDER_ALL</a>) = 0;
<a name="l00114"></a>00114
<a name="l00125"></a>00125 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFTSimpleLayout.html#afc122918b71e571155ca714eeb5c4888" title="Render a string of characters.">Render</a>(<span class="keyword">const</span> <span class="keywordtype">wchar_t</span> *<span class="keywordtype">string</span>, <span class="keyword">const</span> <span class="keywordtype">int</span> len = -1,
<a name="l00126"></a>00126 <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a> position = <a class="code" href="classFTPoint.html" title="FTPoint class is a basic 3-dimensional point or vector.">FTPoint</a>(),
<a name="l00127"></a>00127 <span class="keywordtype">int</span> renderMode = <a class="code" href="namespaceFTGL.html#a9916822cb1247bd2e1aae26f7bfec74ea2966ccc38996af16a67387177a8c6a62">FTGL::RENDER_ALL</a>) = 0;
<a name="l00128"></a>00128
<a name="l00134"></a>00134 <span class="keyword">virtual</span> FT_Error <a class="code" href="classFTLayout.html#a83cf3e7565bf9d9d2aec6d0614d1e6fc" title="Queries the Layout for errors.">Error</a>() <span class="keyword">const</span>;
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keyword">private</span>:
<a name="l00140"></a>00140 FTLayoutImpl *impl;
<a name="l00141"></a>00141 };
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="preprocessor">#endif //__cplusplus</span>
<a name="l00144"></a>00144 <span class="preprocessor"></span>
<a name="l00145"></a>00145 <a class="code" href="ftgl_8h.html#a1543f6485dcd3ef6db0a10396071a6f6">FTGL_BEGIN_C_DECLS</a>
<a name="l00146"></a>00146
<a name="l00150"></a>00150 <span class="keyword">struct </span>_FTGLlayout;
<a name="l00151"></a><a class="code" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">00151</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>_FTGLlayout <a class="code" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a>;
<a name="l00152"></a>00152
<a name="l00158"></a>00158 <a class="code" href="ftgl_8h.html#ae472b08d77a4ead09abe74fe37220270">FTGL_EXPORT</a> <span class="keywordtype">void</span> <a class="code" href="FTLayout_8h.html#a8a825731fa3f4740fac3549984cf8b6d" title="Destroy an FTGL layout object.">ftglDestroyLayout</a>(<a class="code" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a>* layout);
<a name="l00159"></a>00159
<a name="l00168"></a>00168 <a class="code" href="ftgl_8h.html#ae472b08d77a4ead09abe74fe37220270">FTGL_EXPORT</a> <span class="keywordtype">void</span> <a class="code" href="FTLayout_8h.html#a39fe0c68f82e72915d980d201cf5fede" title="Get the bounding box for a string.">ftglGetLayoutBBox</a>(<a class="code" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> *layout, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">string</span>,
<a name="l00169"></a>00169 <span class="keywordtype">float</span> bounds[6]);
<a name="l00170"></a>00170
<a name="l00178"></a>00178 <a class="code" href="ftgl_8h.html#ae472b08d77a4ead09abe74fe37220270">FTGL_EXPORT</a> <span class="keywordtype">void</span> <a class="code" href="FTLayout_8h.html#a6e5301b487c422a361fdd469136d9536" title="Render a string of characters.">ftglRenderLayout</a>(<a class="code" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a> *layout, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">string</span>,
<a name="l00179"></a>00179 <span class="keywordtype">int</span> mode);
<a name="l00180"></a>00180
<a name="l00187"></a>00187 <a class="code" href="ftgl_8h.html#ae472b08d77a4ead09abe74fe37220270">FTGL_EXPORT</a> FT_Error <a class="code" href="FTLayout_8h.html#a5f9f222eb0bf9997076e3ac7da8e7f71" title="Query a layout for errors.">ftglGetLayoutError</a>(<a class="code" href="FTLayout_8h.html#a0aeec097978c2d2c070cf463b6d2a00f">FTGLlayout</a>* layout);
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <a class="code" href="ftgl_8h.html#aba8b33a81b5c655eb7c4b358419a17d5">FTGL_END_C_DECLS</a>
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="preprocessor">#endif </span><span class="comment">/* __FTLayout__ */</span>
<a name="l00192"></a>00192
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Feb 9 2011 for FTGL by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
