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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
|
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>openvrml::frustum class Reference</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<link rel="icon" href="../vrml-16">
<link rel="start" href="http://openvrml.org/index" title="OpenVRML Home">
<link rel="prev" href="http://openvrml.org/discussion" title="Discussion">
<link rel="contents" href="index" title="Documentation Main Page">
<link rel="index" href="functions" title="OpenVRML Compound Members">
<link rel="appendix" href="conformance" title="Conformance Test Results">
<style type="text/css">
@import url("doxygen.css");
@import url("http://openvrml.org/openvrml.css");
.body td {
background-color: transparent;
}
div.qindex {
background-color: transparent;
border: none;
}
a.qindex {
text-decoration: inherit;
color: inherit
}
a.qindex:visited {
text-decoration: inherit;
font-weight: inherit;
color: inherit
}
a.qindex:hover {
text-decoration: inherit;
background-color: transparent;
}
a.qindexHL {
text-decoration: inherit;
font-weight: inherit;
background-color: transparent;
color: inherit;
}
a.qindexHL:hover {
text-decoration: inherit;
background-color: transparent;
color: inherit;
}
a.qindexHL:visited {
text-decoration: inherit;
background-color: transparent;
color: inherit;
}
a.el {
text-decoration: inherit;
font-weight: inherit
}
a.elRef {
font-weight: inherit
}
a.code {
text-decoration: inherit;
font-weight: inherit;
color: inherit;
}
a.codeRef {
font-weight: normal;
color: inherit;
}
a:hover {
text-decoration: inherit;
background-color: inherit;
}
h1 {
line-height: 1.2em;
}
div.qindex {
font-size: smaller;
}
div.qindex .qindex:link, div.qindex .qindex:visited {
font-weight: inherit;
}
div.qindex .qindexHL:link, div.qindex .qindexHL:visited {
font-weight: bold;
}
td.memItemLeft, td.memItemRight, .mdRow td {
font-family: "Bitstream Vera Sans Mono",
"LucidaTypewriter",
"Lucida Console",
monospace;
}
td.memItemLeft, td.memItemRight, td.mdescLeft, td.mdescRight {
background-color: rgb(95%, 95%, 95%);
}
.mdRow {
background-color: rgb(95%, 95%, 95%);
}
.mdTable {
background-color: rgb(95%, 95%, 95%);
}
.mdRow td {
background-color: rgb(95%, 95%, 95%);
}
.mdRow td code {
font-family: sans-serif;
font-style: italic;
}
</style>
</head>
<body>
<table class="sitenav">
<tr>
<th><a href="http://openvrml.org/index" title="Home">Home</a></th>
<th><a href="http://openvrml.org/download" title="Download">Download</a></th>
<th><a href="http://openvrml.org/screenshots/index" title="Screen shots">Screen shots</a></th>
<th><a href="http://openvrml.org/discussion" title="Mailing lists and IRC">Discussion</a></th>
<th>Documentation</th>
</tr>
</table>
<div class="body">
<!-- Generated by Doxygen 1.3.4-20031112 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<h1>openvrml::frustum Class Reference</h1>A view frustum.
<a href="#_details">More...</a>
<p>
<a href="classopenvrml_1_1frustum-members.html">List of all members.</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> </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#a0">frustum</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a default frustum. <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#a1">frustum</a> (float <a class="el" href="classopenvrml_1_1frustum.html#o0">fovy</a>, float aspect, double near, double far)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and initialize a frustum. <a href="#a1"></a><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o0" doxytag="openvrml::frustum::fovy" ></a>
float </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o0">fovy</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Vertical field of view. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o1" doxytag="openvrml::frustum::fovx" ></a>
float </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o1">fovx</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Horizontal field of view. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o2" doxytag="openvrml::frustum::z_near" ></a>
double </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o2">z_near</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Distance to the near clipping plane. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o3" doxytag="openvrml::frustum::z_far" ></a>
double </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o3">z_far</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Distance to the far clipping plane. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o4">left_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Left (looking down -z) side clip plane. <a href="#o4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o5" doxytag="openvrml::frustum::right_plane" ></a>
float </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o5">right_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Right clipping plane. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o6" doxytag="openvrml::frustum::top_plane" ></a>
float </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o6">top_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Top clipping plane. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="o7" doxytag="openvrml::frustum::bot_plane" ></a>
float </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#o7">bot_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bottom clipping plane. <br><br></td></tr>
<tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classopenvrml_1_1frustum.html#d0">update</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the plane equations. <a href="#d0"></a><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A view frustum.
<p>
A frustum is more or less a truncated pyramid. This class represents frustums with their wide end facing down the -z axis, and their (theoretical) tip at the origin. A frustum is a convenient representation of the volume of virtual space visible through the on-screen window when using a perspective projection.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classopenvrml_1_1node.html#a67">node::render</a> <p>
<a class="el" href="classopenvrml_1_1viewer.html">viewer</a> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="openvrml::frustum::frustum" ></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"> openvrml::frustum::frustum </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </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>
Construct a default frustum.
<p>
fovy, fovx, near and far all get set to -1. </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="openvrml::frustum::frustum" ></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"> openvrml::frustum::frustum </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">float </td>
<td class="mdname" nowrap> <em>fovy</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float </td>
<td class="mdname" nowrap> <em>aspect</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>near</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>far</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct and initialize a frustum.
<p>
The field of view should be less than 180 degrees. Extreme aspect ratios are unlikely to work well. The near and far plane distances are always positive (think distance, not position). anear must be less than afar. This is supposed to look like gluPerspective.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>fovy</em> </td><td>vertical field of view in degrees. </td></tr>
<tr><td valign=top><em>aspect</em> </td><td>ratio of view width to height (not the ratio of the horizontal to vertial field-of-views). </td></tr>
<tr><td valign=top><em>near</em> </td><td>distance to near clip plane. </td></tr>
<tr><td valign=top><em>far</em> </td><td>distance to far clip plane. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d0" doxytag="openvrml::frustum::update" ></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 openvrml::frustum::update </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> [private]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Update the plane equations.
<p>
The plane equations are derived from the other members. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o4" doxytag="openvrml::frustum::left_plane" ></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="classopenvrml_1_1frustum.html#o4">openvrml::frustum::left_plane</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Left (looking down -z) side clip plane.
<p>
Format is (a,b,c,d) where (a,b,c) is the plane normal and d is the plane offset. For the momement the eyepoint is always the origin, so d is going to be 0. </td>
</tr>
</table>
</div>
<address class="footer"><a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=7151&type=3" width="125" height="37" border="0" alt="SourceForge.net Logo" align="right"></a><a href="http://sourceforge.net/tracker/?func=add&group_id=7151&atid=107151">Report error</a><br>Generated Sun Nov 16 20:22:39 2003 by Doxygen 1.3.4-20031112</address>
</body>
</html>
|