Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/ode/ode-0.9/docs/group__collide__box.html @ 216

Last change on this file since 216 was 216, checked in by mathiask, 17 years ago

[Physik] add ode-0.9
File size: 8.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>Open Dynamics Engine: Box Class</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.3 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13    <li><a href="files.html"><span>Files</span></a></li>
14  </ul>
15</div>
16<h1>Box Class<br>
17<small>
18[<a class="el" href="group__collide.html">Collision Detection</a>]</small>
19</h1><table border="0" cellpadding="0" cellspacing="0">
20<tr><td></td></tr>
21<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
22<tr><td class="memItemLeft" nowrap align="right" valign="top">ODE_API dGeomID&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__collide__box.html#g3e3b0b249a8ccd40a9969e3a26548397">dCreateBox</a> (dSpaceID space, dReal lx, dReal ly, dReal lz)</td></tr>
23
24<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a box geom with the provided side lengths.  <a href="#g3e3b0b249a8ccd40a9969e3a26548397"></a><br></td></tr>
25<tr><td class="memItemLeft" nowrap align="right" valign="top">ODE_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__collide__box.html#g4c7060780be9eaf74228565910168273">dGeomBoxSetLengths</a> (dGeomID box, dReal lx, dReal ly, dReal lz)</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the side lengths of the given box.  <a href="#g4c7060780be9eaf74228565910168273"></a><br></td></tr>
28<tr><td class="memItemLeft" nowrap align="right" valign="top">ODE_API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__collide__box.html#ge24d9264235d2487b2e2d52b2c62c879">dGeomBoxGetLengths</a> (dGeomID box, dVector3 result)</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the side lengths of a box.  <a href="#ge24d9264235d2487b2e2d52b2c62c879"></a><br></td></tr>
31</table>
32<hr><h2>Function Documentation</h2>
33<a class="anchor" name="g3e3b0b249a8ccd40a9969e3a26548397"></a><!-- doxytag: member="collision.h::dCreateBox" ref="g3e3b0b249a8ccd40a9969e3a26548397" args="(dSpaceID space, dReal lx, dReal ly, dReal lz)" -->
34<div class="memitem">
35<div class="memproto">
36      <table class="memname">
37        <tr>
38          <td class="memname">ODE_API dGeomID dCreateBox           </td>
39          <td>(</td>
40          <td class="paramtype">dSpaceID&nbsp;</td>
41          <td class="paramname"> <em>space</em>, </td>
42        </tr>
43        <tr>
44          <td class="paramkey"></td>
45          <td></td>
46          <td class="paramtype">dReal&nbsp;</td>
47          <td class="paramname"> <em>lx</em>, </td>
48        </tr>
49        <tr>
50          <td class="paramkey"></td>
51          <td></td>
52          <td class="paramtype">dReal&nbsp;</td>
53          <td class="paramname"> <em>ly</em>, </td>
54        </tr>
55        <tr>
56          <td class="paramkey"></td>
57          <td></td>
58          <td class="paramtype">dReal&nbsp;</td>
59          <td class="paramname"> <em>lz</em></td><td>&nbsp;</td>
60        </tr>
61        <tr>
62          <td></td>
63          <td>)</td>
64          <td></td><td></td><td width="100%"></td>
65        </tr>
66      </table>
67</div>
68<div class="memdoc">
69
70<p>
71Create a box geom with the provided side lengths.
72<p>
73<dl compact><dt><b>Parameters:</b></dt><dd>
74  <table border="0" cellspacing="2" cellpadding="0">
75    <tr><td valign="top"></td><td valign="top"><em>space</em>&nbsp;</td><td>a space to contain the new geom. May be null. </td></tr>
76    <tr><td valign="top"></td><td valign="top"><em>lx</em>&nbsp;</td><td>the length of the box along the X axis </td></tr>
77    <tr><td valign="top"></td><td valign="top"><em>ly</em>&nbsp;</td><td>the length of the box along the Y axis </td></tr>
78    <tr><td valign="top"></td><td valign="top"><em>lz</em>&nbsp;</td><td>the length of the box along the Z axis</td></tr>
79  </table>
80</dl>
81<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new box geom.</dd></dl>
82<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The point of reference for a box is its center.</dd></dl>
83<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__collide.html#g96b9e7d3a7ca769b0c8f37eecfaf98c6" title="Destroy a geom, removing it from any space.">dGeomDestroy</a> <p>
84<a class="el" href="group__collide__box.html#g4c7060780be9eaf74228565910168273" title="Set the side lengths of the given box.">dGeomBoxSetLengths</a> </dd></dl>
85
86</div>
87</div><p>
88<a class="anchor" name="ge24d9264235d2487b2e2d52b2c62c879"></a><!-- doxytag: member="collision.h::dGeomBoxGetLengths" ref="ge24d9264235d2487b2e2d52b2c62c879" args="(dGeomID box, dVector3 result)" -->
89<div class="memitem">
90<div class="memproto">
91      <table class="memname">
92        <tr>
93          <td class="memname">ODE_API void dGeomBoxGetLengths           </td>
94          <td>(</td>
95          <td class="paramtype">dGeomID&nbsp;</td>
96          <td class="paramname"> <em>box</em>, </td>
97        </tr>
98        <tr>
99          <td class="paramkey"></td>
100          <td></td>
101          <td class="paramtype">dVector3&nbsp;</td>
102          <td class="paramname"> <em>result</em></td><td>&nbsp;</td>
103        </tr>
104        <tr>
105          <td></td>
106          <td>)</td>
107          <td></td><td></td><td width="100%"></td>
108        </tr>
109      </table>
110</div>
111<div class="memdoc">
112
113<p>
114Get the side lengths of a box.
115<p>
116<dl compact><dt><b>Parameters:</b></dt><dd>
117  <table border="0" cellspacing="2" cellpadding="0">
118    <tr><td valign="top"></td><td valign="top"><em>box</em>&nbsp;</td><td>the box to query </td></tr>
119    <tr><td valign="top"></td><td valign="top"><em>result</em>&nbsp;</td><td>the returned side lengths</td></tr>
120  </table>
121</dl>
122<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__collide__box.html#g4c7060780be9eaf74228565910168273" title="Set the side lengths of the given box.">dGeomBoxSetLengths</a> </dd></dl>
123
124</div>
125</div><p>
126<a class="anchor" name="g4c7060780be9eaf74228565910168273"></a><!-- doxytag: member="collision.h::dGeomBoxSetLengths" ref="g4c7060780be9eaf74228565910168273" args="(dGeomID box, dReal lx, dReal ly, dReal lz)" -->
127<div class="memitem">
128<div class="memproto">
129      <table class="memname">
130        <tr>
131          <td class="memname">ODE_API void dGeomBoxSetLengths           </td>
132          <td>(</td>
133          <td class="paramtype">dGeomID&nbsp;</td>
134          <td class="paramname"> <em>box</em>, </td>
135        </tr>
136        <tr>
137          <td class="paramkey"></td>
138          <td></td>
139          <td class="paramtype">dReal&nbsp;</td>
140          <td class="paramname"> <em>lx</em>, </td>
141        </tr>
142        <tr>
143          <td class="paramkey"></td>
144          <td></td>
145          <td class="paramtype">dReal&nbsp;</td>
146          <td class="paramname"> <em>ly</em>, </td>
147        </tr>
148        <tr>
149          <td class="paramkey"></td>
150          <td></td>
151          <td class="paramtype">dReal&nbsp;</td>
152          <td class="paramname"> <em>lz</em></td><td>&nbsp;</td>
153        </tr>
154        <tr>
155          <td></td>
156          <td>)</td>
157          <td></td><td></td><td width="100%"></td>
158        </tr>
159      </table>
160</div>
161<div class="memdoc">
162
163<p>
164Set the side lengths of the given box.
165<p>
166<dl compact><dt><b>Parameters:</b></dt><dd>
167  <table border="0" cellspacing="2" cellpadding="0">
168    <tr><td valign="top"></td><td valign="top"><em>box</em>&nbsp;</td><td>the box to set </td></tr>
169    <tr><td valign="top"></td><td valign="top"><em>lx</em>&nbsp;</td><td>the length of the box along the X axis </td></tr>
170    <tr><td valign="top"></td><td valign="top"><em>ly</em>&nbsp;</td><td>the length of the box along the Y axis </td></tr>
171    <tr><td valign="top"></td><td valign="top"><em>lz</em>&nbsp;</td><td>the length of the box along the Z axis</td></tr>
172  </table>
173</dl>
174<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__collide__box.html#ge24d9264235d2487b2e2d52b2c62c879" title="Get the side lengths of a box.">dGeomBoxGetLengths</a> </dd></dl>
175
176</div>
177</div><p>
178<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 12 08:36:51 2007 for Open Dynamics Engine by&nbsp;
179<a href="http://www.doxygen.org/index.html">
180<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
181</body>
182</html>
Note: See TracBrowser for help on using the repository browser.