Google Git
Sign in
gfiber / vendor / opensource / projectM / b82e9b0d19af7e840f567433c3273422c3aa3c4f / . / src / macos / FTGL / docs / html / classFTBBox.html
blob: 92f252daf14a58713f4c42dd16a2c563875927c3 [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: FTBBox 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>FTBBox Class Reference</h1><code>#include &lt;<a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>&gt;</code>
<p>
<hr><a name="_details"></a><h2>Detailed Description</h2>
FTBBox is a convenience class for handling bounding boxes.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00016">16</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.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="classFTBBox.html#a0">FTBBox</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#a1">FTBBox</a> (float lx, float ly, float lz, float ux, float uy, float uz)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#a1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#a2">FTBBox</a> (FT_GlyphSlot glyph)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#a2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#a3">~FTBBox</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#a3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFTBBox.html">FTBBox</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#a4">Move</a> (<a class="el" href="classFTPoint.html">FTPoint</a> distance)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move the Bounding Box by a vector. <a href="#a4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classFTBBox.html">FTBBox</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#a5">operator+=</a> (const <a class="el" href="classFTBBox.html">FTBBox</a> &amp;bbox)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#a6">SetDepth</a> (float depth)</td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#o0">lowerX</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The bounds of the box. <a href="#o0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#o1">lowerY</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The bounds of the box. <a href="#o1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#o2">lowerZ</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The bounds of the box. <a href="#o2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#o3">upperX</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The bounds of the box. <a href="#o3"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#o4">upperY</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The bounds of the box. <a href="#o4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classFTBBox.html#o5">upperZ</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The bounds of the box. <a href="#o5"></a><br><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="FTBBox::FTBBox" ></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"> FTBBox::FTBBox </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> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default constructor.
<p>
Bounding box is set to zero.
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00022">22</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="FTBBox::FTBBox" ></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"> FTBBox::FTBBox </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap> <em>lx</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap> <em>ly</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap> <em>lz</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap> <em>ux</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap> <em>uy</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap> <em>uz</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00034">34</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="FTBBox::FTBBox" ></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"> FTBBox::FTBBox </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">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><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor.
<p>
Extracts a bounding box from a freetype glyph. Uses the control box for the glyph. <code>FT_Glyph_Get_CBox()</code><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>A freetype glyph </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00049">49</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="FTBBox::~FTBBox" ></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"> FTBBox::~<a class="el" href="classFTBBox.html">FTBBox</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> [inline]</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="FTBBox_8h-source.html#l00072">72</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4" doxytag="FTBBox::Move" ></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"> <a class="el" href="classFTBBox.html">FTBBox</a>&amp; FTBBox::Move </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classFTPoint.html">FTPoint</a>&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>distance</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Move the Bounding Box by a vector.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>distance</em>&nbsp;</td><td>The distance to move the bbox in 3D space. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00081">81</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
References <a class="el" href="FTPoint_8h-source.html#l00142">FTPoint::X()</a>, <a class="el" href="FTPoint_8h-source.html#l00143">FTPoint::Y()</a>, and <a class="el" href="FTPoint_8h-source.html#l00144">FTPoint::Z()</a>.
<p>
Referenced by <a class="el" href="FTFont_8cpp-source.html#l00135">FTFont::BBox()</a>. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="FTBBox::operator+=" ></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"> <a class="el" href="classFTBBox.html">FTBBox</a>&amp; FTBBox::operator+= </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classFTBBox.html">FTBBox</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>bbox</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00092">92</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
References <a class="el" href="FTBBox_8h-source.html#l00114">lowerX</a>, <a class="el" href="FTBBox_8h-source.html#l00114">lowerY</a>, <a class="el" href="FTBBox_8h-source.html#l00114">lowerZ</a>, <a class="el" href="FTBBox_8h-source.html#l00114">upperX</a>, <a class="el" href="FTBBox_8h-source.html#l00114">upperY</a>, and <a class="el" href="FTBBox_8h-source.html#l00114">upperZ</a>. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="FTBBox::SetDepth" ></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 FTBBox::SetDepth </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>depth</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00104">104</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
Referenced by <a class="el" href="FTExtrdGlyph_8cpp-source.html#l00009">FTExtrdGlyph::FTExtrdGlyph()</a>. </td>
</tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="o0" doxytag="FTBBox::lowerX" ></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"> float <a class="el" href="classFTBBox.html#o0">FTBBox::lowerX</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The bounds of the box.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00114">114</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
Referenced by <a class="el" href="FTFont_8cpp-source.html#l00135">FTFont::BBox()</a>, and <a class="el" href="FTBBox_8h-source.html#l00092">operator+=()</a>. </td>
</tr>
</table>
<a class="anchor" name="o1" doxytag="FTBBox::lowerY" ></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"> float <a class="el" href="classFTBBox.html#o1">FTBBox::lowerY</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The bounds of the box.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00114">114</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
Referenced by <a class="el" href="FTFont_8cpp-source.html#l00135">FTFont::BBox()</a>, and <a class="el" href="FTBBox_8h-source.html#l00092">operator+=()</a>. </td>
</tr>
</table>
<a class="anchor" name="o2" doxytag="FTBBox::lowerZ" ></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"> float <a class="el" href="classFTBBox.html#o2">FTBBox::lowerZ</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The bounds of the box.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00114">114</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
Referenced by <a class="el" href="FTFont_8cpp-source.html#l00135">FTFont::BBox()</a>, and <a class="el" href="FTBBox_8h-source.html#l00092">operator+=()</a>. </td>
</tr>
</table>
<a class="anchor" name="o3" doxytag="FTBBox::upperX" ></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"> float <a class="el" href="classFTBBox.html#o3">FTBBox::upperX</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The bounds of the box.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00114">114</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
Referenced by <a class="el" href="FTFont_8cpp-source.html#l00135">FTFont::BBox()</a>, and <a class="el" href="FTBBox_8h-source.html#l00092">operator+=()</a>. </td>
</tr>
</table>
<a class="anchor" name="o4" doxytag="FTBBox::upperY" ></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"> float <a class="el" href="classFTBBox.html#o4">FTBBox::upperY</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The bounds of the box.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00114">114</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
Referenced by <a class="el" href="FTFont_8cpp-source.html#l00135">FTFont::BBox()</a>, and <a class="el" href="FTBBox_8h-source.html#l00092">operator+=()</a>. </td>
</tr>
</table>
<a class="anchor" name="o5" doxytag="FTBBox::upperZ" ></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"> float <a class="el" href="classFTBBox.html#o5">FTBBox::upperZ</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The bounds of the box.
<p>
<p>
Definition at line <a class="el" href="FTBBox_8h-source.html#l00114">114</a> of file <a class="el" href="FTBBox_8h-source.html">FTBBox.h</a>.
<p>
Referenced by <a class="el" href="FTFont_8cpp-source.html#l00135">FTFont::BBox()</a>, and <a class="el" href="FTBBox_8h-source.html#l00092">operator+=()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FTBBox_8h-source.html">FTBBox.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Dec 5 22:24:06 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>