1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
|
<!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>Ipelib: IpeAngle Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="functions.html">Class Members</a></div>
<h1>IpeAngle Class Reference<br>
<small>
[<a class="el" href="group__geo.html">Ipe Geometry</a>]</small>
</h1><!-- doxytag: class="IpeAngle" -->A double that's an angle.
<a href="#_details">More...</a>
<p>
<a href="class_ipe_angle-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="class_ipe_angle.html#a0">IpeAngle</a> ()
<li><a class="el" href="class_ipe_angle.html#a1">IpeAngle</a> (double alpha)
<li><a class="el" href="class_ipe_angle.html#a2">operator double</a> () const
<li><a class="anchor" name="a3"></a><!-- doxytag: member="IpeAngle::Degrees" ref="a3" args="() const " -->
double <b>Degrees</b> () const
<li><a class="el" href="class_ipe_angle.html">IpeAngle</a> <a class="el" href="class_ipe_angle.html#a4">Normalize</a> (double lowlimit)
<li>bool <a class="el" href="class_ipe_angle.html#a5">LiesBetween</a> (<a class="el" href="class_ipe_angle.html">IpeAngle</a> small, <a class="el" href="class_ipe_angle.html">IpeAngle</a> large) const
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="class_ipe_angle.html">IpeAngle</a> <a class="el" href="class_ipe_angle.html#e0">Degrees</a> (double alpha)
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A double that's an angle.
<p>
An IpeAngle is really nothing more than a double. Having a separate type is sometimes useful, for instance in the <a class="el" href="class_ipe_vector.html">IpeVector</a> constructor, and this class serves as the right place for a few utility functions. It also makes it clear whether a value is in radians or in degrees.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="IpeAngle::IpeAngle" ref="a0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">IpeAngle::IpeAngle </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, explicit]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct uninitialized angle.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1"></a><!-- doxytag: member="IpeAngle::IpeAngle" ref="a1" args="(double alpha)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">IpeAngle::IpeAngle </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname1" valign="top" nowrap> <em>alpha</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct an angle (in radians).
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0"></a><!-- doxytag: member="IpeAngle::Degrees" ref="e0" args="(double alpha)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">static <a class="el" href="class_ipe_angle.html">IpeAngle</a> IpeAngle::Degrees </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname1" valign="top" nowrap> <em>alpha</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct an angle in degrees.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="IpeAngle::operator double" ref="a2" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">IpeAngle::operator double </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return value (in radians).
<p>
</td>
</tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="IpeAngle::Normalize" ref="a4" args="(double lowlimit)" --><p>
<table class="mdTable" 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="class_ipe_angle.html">IpeAngle</a> IpeAngle::Normalize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname1" valign="top" nowrap> <em>lowlimit</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Normalize the value to the range lowlimit .. lowlimit + 2 pi.
<p>
This IpeAngle object is modified, a copy is returned. </td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="IpeAngle::LiesBetween" ref="a5" args="(IpeAngle small, IpeAngle large) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool IpeAngle::LiesBetween </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_angle.html">IpeAngle</a> </td>
<td class="mdname" nowrap> <em>small</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="class_ipe_angle.html">IpeAngle</a> </td>
<td class="mdname" nowrap> <em>large</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
When considering the positively oriented circle arc from angle <em>small</em> to <em>large</em>, does it cover this angle? </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipegeo.h<li>ipegeo.cpp</ul>
<hr>
</body></html>
|