source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1PlaneBoundedVolume.html @ 657

Revision 657, 16.2 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::PlaneBoundedVolume class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::PlaneBoundedVolume Class Reference</h1>Represents a convex volume bounded by planes. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1PlaneBoundedVolume-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::vector&lt; <a class="el" href="classOgre_1_1Plane.html">Plane</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumew0">PlaneList</a></td></tr>
19
20<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumea0">PlaneBoundedVolume</a> ()</td></tr>
22
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumea1">PlaneBoundedVolume</a> (<a class="el" href="classOgre_1_1Plane.html#Ogre_1_1Planew3">Plane::Side</a> theOutside)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, determines which side is deemed to be 'outside'.  <a href="#Ogre_1_1PlaneBoundedVolumea1"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumea2">intersects</a> (const <a class="el" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a> &amp;box) const </td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Intersection test with AABB.  <a href="#Ogre_1_1PlaneBoundedVolumea2"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumea3">intersects</a> (const <a class="el" href="classOgre_1_1Sphere.html">Sphere</a> &amp;sphere) const </td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Intersection test with <a class="el" href="classOgre_1_1Sphere.html">Sphere</a>.  <a href="#Ogre_1_1PlaneBoundedVolumea3"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>std::pair&lt; bool, <a class="el" href="namespaceOgre.html#a420">Real</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumea4">intersects</a> (const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;ray)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Intersection test with a <a class="el" href="classOgre_1_1Ray.html">Ray</a>.  <a href="#Ogre_1_1PlaneBoundedVolumea4"></a><br><br></td></tr>
35<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a410">PlaneList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumeo0">planes</a></td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Publicly accessible plane list, you can modify this direct.  <a href="#Ogre_1_1PlaneBoundedVolumeo0"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Plane.html#Ogre_1_1Planew3">Plane::Side</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumeo1">outside</a></td></tr>
40
41</table>
42<hr><a name="_details"></a><h2>Detailed Description</h2>
43Represents a convex volume bounded by planes.
44<p>
45
46<p>
47Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00039">39</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.<hr><h2>Member Typedef Documentation</h2>
48<a class="anchor" name="Ogre_1_1PlaneBoundedVolumew0" doxytag="Ogre::PlaneBoundedVolume::PlaneList" ></a><p>
49<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
50  <tr>
51    <td class="mdRow">
52      <table cellpadding="0" cellspacing="0" border="0">
53        <tr>
54          <td class="md" nowrap valign="top"> typedef std::vector&lt;<a class="el" href="classOgre_1_1Plane.html">Plane</a>&gt; <a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumew0">Ogre::PlaneBoundedVolume::PlaneList</a>
55      </table>
56    </td>
57  </tr>
58</table>
59<table cellspacing=5 cellpadding=0 border=0>
60  <tr>
61    <td>
62      &nbsp;
63    </td>
64    <td>
65
66<p>
67
68<p>
69Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00042">42</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.    </td>
70  </tr>
71</table>
72<hr><h2>Constructor &amp; Destructor Documentation</h2>
73<a class="anchor" name="Ogre_1_1PlaneBoundedVolumea0" doxytag="Ogre::PlaneBoundedVolume::PlaneBoundedVolume" ></a><p>
74<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
75  <tr>
76    <td class="mdRow">
77      <table cellpadding="0" cellspacing="0" border="0">
78        <tr>
79          <td class="md" nowrap valign="top"> Ogre::PlaneBoundedVolume::PlaneBoundedVolume </td>
80          <td class="md" valign="top">(&nbsp;</td>
81          <td class="mdname1" valign="top" nowrap>          </td>
82          <td class="md" valign="top">&nbsp;)&nbsp;</td>
83          <td class="md" nowrap></td>
84        </tr>
85
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing=5 cellpadding=0 border=0>
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98
99<p>
100Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00047">47</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.    </td>
101  </tr>
102</table>
103<a class="anchor" name="Ogre_1_1PlaneBoundedVolumea1" doxytag="Ogre::PlaneBoundedVolume::PlaneBoundedVolume" ></a><p>
104<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
105  <tr>
106    <td class="mdRow">
107      <table cellpadding="0" cellspacing="0" border="0">
108        <tr>
109          <td class="md" nowrap valign="top"> Ogre::PlaneBoundedVolume::PlaneBoundedVolume </td>
110          <td class="md" valign="top">(&nbsp;</td>
111          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Plane.html#Ogre_1_1Planew3">Plane::Side</a>&nbsp;</td>
112          <td class="mdname1" valign="top" nowrap> <em>theOutside</em>          </td>
113          <td class="md" valign="top">&nbsp;)&nbsp;</td>
114          <td class="md" nowrap></td>
115        </tr>
116
117      </table>
118    </td>
119  </tr>
120</table>
121<table cellspacing=5 cellpadding=0 border=0>
122  <tr>
123    <td>
124      &nbsp;
125    </td>
126    <td>
127
128<p>
129Constructor, determines which side is deemed to be 'outside'.
130<p>
131
132<p>
133Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00049">49</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.    </td>
134  </tr>
135</table>
136<hr><h2>Member Function Documentation</h2>
137<a class="anchor" name="Ogre_1_1PlaneBoundedVolumea4" doxytag="Ogre::PlaneBoundedVolume::intersects" ></a><p>
138<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
139  <tr>
140    <td class="mdRow">
141      <table cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td class="md" nowrap valign="top"> std::pair&lt;bool, <a class="el" href="namespaceOgre.html#a420">Real</a>&gt; Ogre::PlaneBoundedVolume::intersects </td>
144          <td class="md" valign="top">(&nbsp;</td>
145          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Ray.html">Ray</a> &amp;&nbsp;</td>
146          <td class="mdname1" valign="top" nowrap> <em>ray</em>          </td>
147          <td class="md" valign="top">&nbsp;)&nbsp;</td>
148          <td class="md" nowrap></td>
149        </tr>
150
151      </table>
152    </td>
153  </tr>
154</table>
155<table cellspacing=5 cellpadding=0 border=0>
156  <tr>
157    <td>
158      &nbsp;
159    </td>
160    <td>
161
162<p>
163Intersection test with a <a class="el" href="classOgre_1_1Ray.html">Ray</a>.
164<p>
165<dl compact><dt><b>Returns:</b></dt><dd>std::pair of hit (bool) and distance </dd></dl>
166<dl compact><dt><b>Remarks:</b></dt><dd>May return false positives but will never miss an intersection. </dd></dl>
167
168<p>
169Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00118">118</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.    </td>
170  </tr>
171</table>
172<a class="anchor" name="Ogre_1_1PlaneBoundedVolumea3" doxytag="Ogre::PlaneBoundedVolume::intersects" ></a><p>
173<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
174  <tr>
175    <td class="mdRow">
176      <table cellpadding="0" cellspacing="0" border="0">
177        <tr>
178          <td class="md" nowrap valign="top"> bool Ogre::PlaneBoundedVolume::intersects </td>
179          <td class="md" valign="top">(&nbsp;</td>
180          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1Sphere.html">Sphere</a> &amp;&nbsp;</td>
181          <td class="mdname1" valign="top" nowrap> <em>sphere</em>          </td>
182          <td class="md" valign="top">&nbsp;)&nbsp;</td>
183          <td class="md" nowrap> const</td>
184        </tr>
185
186      </table>
187    </td>
188  </tr>
189</table>
190<table cellspacing=5 cellpadding=0 border=0>
191  <tr>
192    <td>
193      &nbsp;
194    </td>
195    <td>
196
197<p>
198Intersection test with <a class="el" href="classOgre_1_1Sphere.html">Sphere</a>.
199<p>
200<dl compact><dt><b>Remarks:</b></dt><dd>May return false positives but will never miss an intersection. </dd></dl>
201
202<p>
203Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00093">93</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.
204<p>
205References <a class="el" href="OgreSphere_8h-source.html#l00064">Ogre::Sphere::getCenter()</a>, <a class="el" href="classOgre_1_1Plane.html#Ogre_1_1Planea6">Ogre::Plane::getDistance()</a>, <a class="el" href="OgreSphere_8h-source.html#l00058">Ogre::Sphere::getRadius()</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00111">Ogre::Real</a>.    </td>
206  </tr>
207</table>
208<a class="anchor" name="Ogre_1_1PlaneBoundedVolumea2" doxytag="Ogre::PlaneBoundedVolume::intersects" ></a><p>
209<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
210  <tr>
211    <td class="mdRow">
212      <table cellpadding="0" cellspacing="0" border="0">
213        <tr>
214          <td class="md" nowrap valign="top"> bool Ogre::PlaneBoundedVolume::intersects </td>
215          <td class="md" valign="top">(&nbsp;</td>
216          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a> &amp;&nbsp;</td>
217          <td class="mdname1" valign="top" nowrap> <em>box</em>          </td>
218          <td class="md" valign="top">&nbsp;)&nbsp;</td>
219          <td class="md" nowrap> const</td>
220        </tr>
221
222      </table>
223    </td>
224  </tr>
225</table>
226<table cellspacing=5 cellpadding=0 border=0>
227  <tr>
228    <td>
229      &nbsp;
230    </td>
231    <td>
232
233<p>
234Intersection test with AABB.
235<p>
236<dl compact><dt><b>Remarks:</b></dt><dd>May return false positives but will never miss an intersection. </dd></dl>
237
238<p>
239Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00055">55</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.
240<p>
241References <a class="el" href="OgreAxisAlignedBox_8h-source.html#l00195">Ogre::AxisAlignedBox::getAllCorners()</a>, <a class="el" href="classOgre_1_1Plane.html#Ogre_1_1Planea5">Ogre::Plane::getSide()</a>, and <a class="el" href="OgreAxisAlignedBox_8h-source.html#l00311">Ogre::AxisAlignedBox::isNull()</a>.    </td>
242  </tr>
243</table>
244<hr><h2>Member Data Documentation</h2>
245<a class="anchor" name="Ogre_1_1PlaneBoundedVolumeo1" doxytag="Ogre::PlaneBoundedVolume::outside" ></a><p>
246<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
247  <tr>
248    <td class="mdRow">
249      <table cellpadding="0" cellspacing="0" border="0">
250        <tr>
251          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Plane.html#Ogre_1_1Planew3">Plane::Side</a> <a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumeo1">Ogre::PlaneBoundedVolume::outside</a>
252      </table>
253    </td>
254  </tr>
255</table>
256<table cellspacing=5 cellpadding=0 border=0>
257  <tr>
258    <td>
259      &nbsp;
260    </td>
261    <td>
262
263<p>
264
265<p>
266Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00045">45</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.
267<p>
268Referenced by <a class="el" href="OgreRay_8h-source.html#l00084">Ogre::Ray::intersects()</a>.    </td>
269  </tr>
270</table>
271<a class="anchor" name="Ogre_1_1PlaneBoundedVolumeo0" doxytag="Ogre::PlaneBoundedVolume::planes" ></a><p>
272<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
273  <tr>
274    <td class="mdRow">
275      <table cellpadding="0" cellspacing="0" border="0">
276        <tr>
277          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a410">PlaneList</a> <a class="el" href="classOgre_1_1PlaneBoundedVolume.html#Ogre_1_1PlaneBoundedVolumeo0">Ogre::PlaneBoundedVolume::planes</a>
278      </table>
279    </td>
280  </tr>
281</table>
282<table cellspacing=5 cellpadding=0 border=0>
283  <tr>
284    <td>
285      &nbsp;
286    </td>
287    <td>
288
289<p>
290Publicly accessible plane list, you can modify this direct.
291<p>
292
293<p>
294Definition at line <a class="el" href="OgrePlaneBoundedVolume_8h-source.html#l00044">44</a> of file <a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a>.
295<p>
296Referenced by <a class="el" href="OgreRay_8h-source.html#l00084">Ogre::Ray::intersects()</a>.    </td>
297  </tr>
298</table>
299<hr>The documentation for this class was generated from the following file:<ul>
300<li><a class="el" href="OgrePlaneBoundedVolume_8h-source.html">OgrePlaneBoundedVolume.h</a></ul>
301<hr>
302<p>
303Copyright &copy; 2000-2005 by The OGRE Team<br />
304<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
305This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
306                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
307                <Work rdf:about="">
308                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
309        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
310                </Work>
311                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
312
313Last modified Sun Feb 12 13:02:08 2006
314</p>
315</body>
316</html>
Note: See TracBrowser for help on using the repository browser.