<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>OpenVRML: 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("tabs.css");
@import url("http://openvrml.org/openvrml.css");
table {
width: 100%;
}
h2 {
border-bottom-style: solid;
border-bottom-width: 1px;
}
/*
* Doxygen as of 1.5.4-20071217 uses the class "navpath" instead of "nav".
* For now, we'll do both.
*/
div.nav,
div.navpath {
background-color: transparent;
text-align: left;
margin-top: 1em;
margin-bottom: 1em;
border-color: black;
border-left: none;
border-right: none;
padding-top: 0.5em;
padding-bottom: 0.5em;
}
div.nav :link, div.nav :visited,
div.navpath :link, div.navpath :visited {
border-width: 1px;
border-style: solid;
border-color: silver;
padding: 2px;
}
div.nav :link:hover, div.nav :visited:hover,
div.navpath :link:hover, div.navpath :visited:hover {
border-style: outset;
border-color: gray;
}
div.nav :active,
div.navpath :active {
border-style: inset;
border-color: gray;
}
.body td {
background-color: transparent;
}
.el {
text-decoration: inherit;
font-weight: inherit
}
.elRef {
font-weight: inherit
}
.code:link, .code:visited {
text-decoration: inherit;
font-weight: inherit;
color: inherit;
}
.codeRef:link {
font-weight: normal;
color: inherit;
}
:visited {
color: silver;
}
:link:hover {
color: inherit;
text-decoration: inherit;
background-color: transparent;
}
h1 {
line-height: 1.2em;
}
td.memItemLeft, td.memItemRight,
td.memTemplParams, td.memTemplItemLeft, td.memTemplItemRight,
.memtemplate, .memname td {
font-family: Consolas, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Lucida Console", LucidaTypewriter, monospace;
}
td.memItemLeft, td.memItemRight, td.mdescLeft, td.mdescRight {
background-color: rgb(95%, 95%, 95%);
border-color: rgb(65%, 65%, 65%);
border-width: 1px;
font-size: smaller;
}
.memItemLeft {
margin-top: 0.5em;
border-top-style: solid;
}
.mdescLeft {
border-bottom-style: solid;
}
.memItemRight {
border-top-style: solid;
margin-top: 0.5em;
}
.mdescRight {
border-bottom-style: solid;
}
.mdescRight {
font-style: italic;
}
.mdTable {
background-color: rgb(95%, 95%, 95%);
}
.memproto td code {
font-family: inherit;
font-style: italic;
}
td.pass {
background-color: rgb(50%, 100%, 50%);
}
td.fail {
background-color: rgb(100%, 50%, 50%);
}
td.invalid {
background-color: rgb(75%, 75%, 75%);
}
.memitem {
padding: 0;
}
.memitem table {
width: auto;
}
.memproto, .memdoc {
border-width: 1px;
border-color: rgb(65%, 65%, 65%);
}
.memproto {
background-color: rgb(90%, 90%, 90%);
font-weight: inherit;
font-size: smaller;
border-top-style: solid;
border-left-style: solid;
border-right-style: solid;
-webkit-border-top-left-radius: 0.6em;
-webkit-border-top-right-radius: 0.6em;
-moz-border-radius-topleft: 0.6em;
-moz-border-radius-topright: 0.6em;
}
.memdoc {
background-color: rgb(95%, 95%, 95%);
padding: 2px 5px;
border-style: solid;
-webkit-border-bottom-left-radius: 0.6em;
-webkit-border-bottom-right-radius: 0.6em;
-moz-border-radius-bottomleft: 0.6em;
-moz-border-radius-bottomright: 0.6em;
}
.memname {
font-weight: inherit;
}
div.tabs {
background-image: url("tab_b-openvrml.png");
}
div.tabs span {
background-image: url("tab_l-openvrml.png");
}
div.tabs a {
background-image: url("tab_r-openvrml.png");
border-bottom: 1px solid #a5a5a5;
}
div.tabs a:link, div.tabs a:visited, div.tabs a:active, div.tabs a:hover {
color: black;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
.note {
border: 1px solid rgb(65%, 65%, 65%);
background-color: rgb(95%, 95%, 95%);
margin-left: 10%;
margin-right: 10%;
}
</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.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceopenvrml.html">openvrml</a>::<a class="el" href="classopenvrml_1_1frustum.html">frustum</a>
</div>
</div>
<div class="contents">
<h1>openvrml::frustum Class Reference</h1><!-- doxytag: class="openvrml::frustum" -->A view <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a>.
<a href="#_details">More...</a>
<p>
<code>#include <openvrml/frustum.h></code>
<p>
<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#10948b9ae629b8a830e8872fdbae34af">frustum</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a default <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a>. <a href="#10948b9ae629b8a830e8872fdbae34af"></a><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#a4d146e0e7f42ed82febbbe8bcc94215">frustum</a> (float <a class="el" href="classopenvrml_1_1frustum.html#f1e6d613ed797039868382b23d0284d3">fovy</a>, float aspect, double <a class="el" href="classopenvrml_1_1frustum.html#7605bf3394dddd8bd162cf0b5140dce5">z_near</a>, double <a class="el" href="classopenvrml_1_1frustum.html#d8bec0a3fc46a68521164612df6158df">z_far</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and initialize a <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a>. <a href="#a4d146e0e7f42ed82febbbe8bcc94215"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></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#f1e6d613ed797039868382b23d0284d3">fovy</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Vertical field of view. <a href="#f1e6d613ed797039868382b23d0284d3"></a><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#4c30e73cca854212594cd84014ea2c1b">fovx</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Horizontal field of view. <a href="#4c30e73cca854212594cd84014ea2c1b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1frustum.html#7605bf3394dddd8bd162cf0b5140dce5">z_near</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Distance to the near clipping plane. <a href="#7605bf3394dddd8bd162cf0b5140dce5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1frustum.html#d8bec0a3fc46a68521164612df6158df">z_far</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Distance to the far clipping plane. <a href="#d8bec0a3fc46a68521164612df6158df"></a><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#ecc59150d7ddc8a36c24584041b78436">left_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Left (looking down -z) side clip plane. <a href="#ecc59150d7ddc8a36c24584041b78436"></a><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#2071e282d933c88dfd4e4840a4948b75">right_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Right clipping plane. <a href="#2071e282d933c88dfd4e4840a4948b75"></a><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#2f0d5958b3c8bbdac7c2094247911554">top_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Top clipping plane. <a href="#2f0d5958b3c8bbdac7c2094247911554"></a><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#eb278f41979fc9982e521f6a4ddd0806">bot_plane</a> [4]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bottom clipping plane. <a href="#eb278f41979fc9982e521f6a4ddd0806"></a><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#20ecd7698a4f2211c6ea6b0c3bc117fd">update</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the plane equations. <a href="#20ecd7698a4f2211c6ea6b0c3bc117fd"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A view <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a>.
<p>
A <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a> 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 <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a> is a convenient representation of the volume of virtual space visible through the on-screen window when using a perspective projection.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classopenvrml_1_1appearance__node.html#212d8a63fbed345ba3f7f8dc6915f9ce" title="Insert appearance when rendering.">openvrml::appearance_node::render_appearance</a> <p>
<a class="el" href="classopenvrml_1_1child__node.html#b78a4e0d358beee24974b11dbcb02623" title="Render the node.">openvrml::child_node::render_child</a> <p>
<a class="el" href="classopenvrml_1_1geometry__node.html#b2a310aedde6d2aadd4531efb5748788" title="Insert geometry into a viewer.">openvrml::geometry_node::render_geometry</a> <p>
<a class="el" href="classopenvrml_1_1viewer.html" title="Map the scene graph to the underlying graphics library.">openvrml::viewer</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="10948b9ae629b8a830e8872fdbae34af"></a><!-- doxytag: member="openvrml::frustum::frustum" ref="10948b9ae629b8a830e8872fdbae34af" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">openvrml::frustum::frustum </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a default <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a>.
<p>
fovy, fovx, near and far all get set to -1.
</div>
</div><p>
<a class="anchor" name="a4d146e0e7f42ed82febbbe8bcc94215"></a><!-- doxytag: member="openvrml::frustum::frustum" ref="a4d146e0e7f42ed82febbbe8bcc94215" args="(float fovy, float aspect, double z_near, double z_far)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">openvrml::frustum::frustum </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>fovy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>aspect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>z_near</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>z_far</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct and initialize a <a class="el" href="classopenvrml_1_1frustum.html" title="A view frustum.">frustum</a>.
<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"><tt>[in]</tt> </td><td valign="top"><em>fovy</em> </td><td>vertical field of view in degrees. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><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"><tt>[in]</tt> </td><td valign="top"><em>z_near</em> </td><td>distance to near clip plane. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>z_far</em> </td><td>distance to far clip plane. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="20ecd7698a4f2211c6ea6b0c3bc117fd"></a><!-- doxytag: member="openvrml::frustum::update" ref="20ecd7698a4f2211c6ea6b0c3bc117fd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void openvrml::frustum::update </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the plane equations.
<p>
The plane equations are derived from the other members.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f1e6d613ed797039868382b23d0284d3"></a><!-- doxytag: member="openvrml::frustum::fovy" ref="f1e6d613ed797039868382b23d0284d3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#f1e6d613ed797039868382b23d0284d3">openvrml::frustum::fovy</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Vertical field of view.
<p>
</div>
</div><p>
<a class="anchor" name="4c30e73cca854212594cd84014ea2c1b"></a><!-- doxytag: member="openvrml::frustum::fovx" ref="4c30e73cca854212594cd84014ea2c1b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#4c30e73cca854212594cd84014ea2c1b">openvrml::frustum::fovx</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Horizontal field of view.
<p>
</div>
</div><p>
<a class="anchor" name="7605bf3394dddd8bd162cf0b5140dce5"></a><!-- doxytag: member="openvrml::frustum::z_near" ref="7605bf3394dddd8bd162cf0b5140dce5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#7605bf3394dddd8bd162cf0b5140dce5">openvrml::frustum::z_near</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Distance to the near clipping plane.
<p>
</div>
</div><p>
<a class="anchor" name="d8bec0a3fc46a68521164612df6158df"></a><!-- doxytag: member="openvrml::frustum::z_far" ref="d8bec0a3fc46a68521164612df6158df" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#d8bec0a3fc46a68521164612df6158df">openvrml::frustum::z_far</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Distance to the far clipping plane.
<p>
</div>
</div><p>
<a class="anchor" name="ecc59150d7ddc8a36c24584041b78436"></a><!-- doxytag: member="openvrml::frustum::left_plane" ref="ecc59150d7ddc8a36c24584041b78436" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#ecc59150d7ddc8a36c24584041b78436">openvrml::frustum::left_plane</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<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.
</div>
</div><p>
<a class="anchor" name="2071e282d933c88dfd4e4840a4948b75"></a><!-- doxytag: member="openvrml::frustum::right_plane" ref="2071e282d933c88dfd4e4840a4948b75" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#2071e282d933c88dfd4e4840a4948b75">openvrml::frustum::right_plane</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Right clipping plane.
<p>
</div>
</div><p>
<a class="anchor" name="2f0d5958b3c8bbdac7c2094247911554"></a><!-- doxytag: member="openvrml::frustum::top_plane" ref="2f0d5958b3c8bbdac7c2094247911554" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#2f0d5958b3c8bbdac7c2094247911554">openvrml::frustum::top_plane</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Top clipping plane.
<p>
</div>
</div><p>
<a class="anchor" name="eb278f41979fc9982e521f6a4ddd0806"></a><!-- doxytag: member="openvrml::frustum::bot_plane" ref="eb278f41979fc9982e521f6a4ddd0806" args="[4]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classopenvrml_1_1frustum.html#eb278f41979fc9982e521f6a4ddd0806">openvrml::frustum::bot_plane</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bottom clipping plane.
<p>
</div>
</div><p>
</div>
</div>
<address class="footer"><span class="images"><a href="http://web3d.org/x3d/"><img src="x3d-white-on-black.png" width="43" height="32" border="0" alt="X3D"></a><a href="http://opengl.org"><img src="OGL_sm_wht.png" width="68" height="32" border="0" alt="OpenGL"></a><a href="http://sourceforge.net/projects/openvrml"><img src="http://sourceforge.net/sflogo.php?group_id=7151&type=11" width="120" height="30" border="0" alt="SourceForge.net"></a></span><a href="https://sourceforge.net/apps/trac/openvrml/newticket">Report error</a><br>Generated Thu Aug 13 02:49:20 2009 by Doxygen 1.5.8</address>
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script type="text/javascript">_uacct = "UA-446379-2"; urchinTracker();</script>
<!-- Piwik -->
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://sourceforge.net/apps/piwik/openvrml/" : "http://sourceforge.net/apps/piwik/openvrml/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
</script>
<object><noscript><p><img src="http://sourceforge.net/apps/piwik/openvrml/piwik.php?idsite=1" alt="piwik"/></p></noscript></object>
<!-- End Piwik Tag -->
</body>
</html>
