Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

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

[Physik] add ode-0.9
File size: 9.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: Sphere 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>Sphere 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__sphere.html#g53c79c860638ca3600744a193da68474">dCreateSphere</a> (dSpaceID space, dReal radius)</td></tr>
23
24<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a sphere geom of the given radius, and return its ID.  <a href="#g53c79c860638ca3600744a193da68474"></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__sphere.html#g2341ae9b3b733571eff7a1857109f394">dGeomSphereSetRadius</a> (dGeomID sphere, dReal radius)</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the radius of a sphere geom.  <a href="#g2341ae9b3b733571eff7a1857109f394"></a><br></td></tr>
28<tr><td class="memItemLeft" nowrap align="right" valign="top">ODE_API dReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__collide__sphere.html#g0e7f664deb9f557a6a24f93705b29fa9">dGeomSphereGetRadius</a> (dGeomID sphere)</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the radius of a sphere geom.  <a href="#g0e7f664deb9f557a6a24f93705b29fa9"></a><br></td></tr>
31<tr><td class="memItemLeft" nowrap align="right" valign="top">ODE_API dReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__collide__sphere.html#gee86d3744471e447ffc85f85ee6578b1">dGeomSpherePointDepth</a> (dGeomID sphere, dReal x, dReal y, dReal z)</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the depth of the a given point within a sphere.  <a href="#gee86d3744471e447ffc85f85ee6578b1"></a><br></td></tr>
34</table>
35<hr><h2>Function Documentation</h2>
36<a class="anchor" name="g53c79c860638ca3600744a193da68474"></a><!-- doxytag: member="collision.h::dCreateSphere" ref="g53c79c860638ca3600744a193da68474" args="(dSpaceID space, dReal radius)" -->
37<div class="memitem">
38<div class="memproto">
39      <table class="memname">
40        <tr>
41          <td class="memname">ODE_API dGeomID dCreateSphere           </td>
42          <td>(</td>
43          <td class="paramtype">dSpaceID&nbsp;</td>
44          <td class="paramname"> <em>space</em>, </td>
45        </tr>
46        <tr>
47          <td class="paramkey"></td>
48          <td></td>
49          <td class="paramtype">dReal&nbsp;</td>
50          <td class="paramname"> <em>radius</em></td><td>&nbsp;</td>
51        </tr>
52        <tr>
53          <td></td>
54          <td>)</td>
55          <td></td><td></td><td width="100%"></td>
56        </tr>
57      </table>
58</div>
59<div class="memdoc">
60
61<p>
62Create a sphere geom of the given radius, and return its ID.
63<p>
64<dl compact><dt><b>Parameters:</b></dt><dd>
65  <table border="0" cellspacing="2" cellpadding="0">
66    <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>
67    <tr><td valign="top"></td><td valign="top"><em>radius</em>&nbsp;</td><td>the radius of the sphere.</td></tr>
68  </table>
69</dl>
70<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new sphere geom.</dd></dl>
71<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The point of reference for a sphere is its center.</dd></dl>
72<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>
73<a class="el" href="group__collide__sphere.html#g2341ae9b3b733571eff7a1857109f394" title="Set the radius of a sphere geom.">dGeomSphereSetRadius</a> </dd></dl>
74
75</div>
76</div><p>
77<a class="anchor" name="g0e7f664deb9f557a6a24f93705b29fa9"></a><!-- doxytag: member="collision.h::dGeomSphereGetRadius" ref="g0e7f664deb9f557a6a24f93705b29fa9" args="(dGeomID sphere)" -->
78<div class="memitem">
79<div class="memproto">
80      <table class="memname">
81        <tr>
82          <td class="memname">ODE_API dReal dGeomSphereGetRadius           </td>
83          <td>(</td>
84          <td class="paramtype">dGeomID&nbsp;</td>
85          <td class="paramname"> <em>sphere</em>          </td>
86          <td>&nbsp;)&nbsp;</td>
87          <td width="100%"></td>
88        </tr>
89      </table>
90</div>
91<div class="memdoc">
92
93<p>
94Retrieves the radius of a sphere geom.
95<p>
96<dl compact><dt><b>Parameters:</b></dt><dd>
97  <table border="0" cellspacing="2" cellpadding="0">
98    <tr><td valign="top"></td><td valign="top"><em>sphere</em>&nbsp;</td><td>the sphere to query.</td></tr>
99  </table>
100</dl>
101<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__collide__sphere.html#g2341ae9b3b733571eff7a1857109f394" title="Set the radius of a sphere geom.">dGeomSphereSetRadius</a> </dd></dl>
102
103</div>
104</div><p>
105<a class="anchor" name="gee86d3744471e447ffc85f85ee6578b1"></a><!-- doxytag: member="collision.h::dGeomSpherePointDepth" ref="gee86d3744471e447ffc85f85ee6578b1" args="(dGeomID sphere, dReal x, dReal y, dReal z)" -->
106<div class="memitem">
107<div class="memproto">
108      <table class="memname">
109        <tr>
110          <td class="memname">ODE_API dReal dGeomSpherePointDepth           </td>
111          <td>(</td>
112          <td class="paramtype">dGeomID&nbsp;</td>
113          <td class="paramname"> <em>sphere</em>, </td>
114        </tr>
115        <tr>
116          <td class="paramkey"></td>
117          <td></td>
118          <td class="paramtype">dReal&nbsp;</td>
119          <td class="paramname"> <em>x</em>, </td>
120        </tr>
121        <tr>
122          <td class="paramkey"></td>
123          <td></td>
124          <td class="paramtype">dReal&nbsp;</td>
125          <td class="paramname"> <em>y</em>, </td>
126        </tr>
127        <tr>
128          <td class="paramkey"></td>
129          <td></td>
130          <td class="paramtype">dReal&nbsp;</td>
131          <td class="paramname"> <em>z</em></td><td>&nbsp;</td>
132        </tr>
133        <tr>
134          <td></td>
135          <td>)</td>
136          <td></td><td></td><td width="100%"></td>
137        </tr>
138      </table>
139</div>
140<div class="memdoc">
141
142<p>
143Calculate the depth of the a given point within a sphere.
144<p>
145<dl compact><dt><b>Parameters:</b></dt><dd>
146  <table border="0" cellspacing="2" cellpadding="0">
147    <tr><td valign="top"></td><td valign="top"><em>sphere</em>&nbsp;</td><td>the sphere to query. </td></tr>
148    <tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>the X coordinate of the point. </td></tr>
149    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>the Y coordinate of the point. </td></tr>
150    <tr><td valign="top"></td><td valign="top"><em>z</em>&nbsp;</td><td>the Z coordinate of the point.</td></tr>
151  </table>
152</dl>
153<dl class="return" compact><dt><b>Returns:</b></dt><dd>The depth of the point. Points inside the sphere will have a positive depth, points outside it will have a negative depth, and points on the surface will have a depth of zero. </dd></dl>
154
155</div>
156</div><p>
157<a class="anchor" name="g2341ae9b3b733571eff7a1857109f394"></a><!-- doxytag: member="collision.h::dGeomSphereSetRadius" ref="g2341ae9b3b733571eff7a1857109f394" args="(dGeomID sphere, dReal radius)" -->
158<div class="memitem">
159<div class="memproto">
160      <table class="memname">
161        <tr>
162          <td class="memname">ODE_API void dGeomSphereSetRadius           </td>
163          <td>(</td>
164          <td class="paramtype">dGeomID&nbsp;</td>
165          <td class="paramname"> <em>sphere</em>, </td>
166        </tr>
167        <tr>
168          <td class="paramkey"></td>
169          <td></td>
170          <td class="paramtype">dReal&nbsp;</td>
171          <td class="paramname"> <em>radius</em></td><td>&nbsp;</td>
172        </tr>
173        <tr>
174          <td></td>
175          <td>)</td>
176          <td></td><td></td><td width="100%"></td>
177        </tr>
178      </table>
179</div>
180<div class="memdoc">
181
182<p>
183Set the radius of a sphere geom.
184<p>
185<dl compact><dt><b>Parameters:</b></dt><dd>
186  <table border="0" cellspacing="2" cellpadding="0">
187    <tr><td valign="top"></td><td valign="top"><em>sphere</em>&nbsp;</td><td>the sphere to set. </td></tr>
188    <tr><td valign="top"></td><td valign="top"><em>radius</em>&nbsp;</td><td>the new radius.</td></tr>
189  </table>
190</dl>
191<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__collide__sphere.html#g0e7f664deb9f557a6a24f93705b29fa9" title="Retrieves the radius of a sphere geom.">dGeomSphereGetRadius</a> </dd></dl>
192
193</div>
194</div><p>
195<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 12 08:36:51 2007 for Open Dynamics Engine by&nbsp;
196<a href="http://www.doxygen.org/index.html">
197<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
198</body>
199</html>
Note: See TracBrowser for help on using the repository browser.