aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxSphereGeometry.html
blob: c10764d0ec5cfb34fc94dbcc6e23b1f4ead40ce0 (plain) (blame)
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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSphereGeometry Class Reference</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxSphereGeometry Class Reference<br>
<small>
[<a class="el" href="group__geomutils.html">Geomutils</a>]</small>
</h1><!-- doxytag: class="PxSphereGeometry" --><!-- doxytag: inherits="PxGeometry" -->A class representing the geometry of a sphere.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxSphereGeometry_8h-source.html">PxSphereGeometry.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxSphereGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxSphereGeometry__inherit__graph.png" border="0" usemap="#PxSphereGeometry__inherit__map" alt="Inheritance graph"></center>
<map name="PxSphereGeometry__inherit__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="28,16,113,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxSphereGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxSphereGeometry__coll__graph.png" border="0" usemap="#PxSphereGeometry__coll__map" alt="Collaboration graph"></center>
<map name="PxSphereGeometry__coll__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="28,16,113,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxSphereGeometry-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">PX_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSphereGeometry.html#b0c426a8db79da6808e364de8d213c28">PxSphereGeometry</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSphereGeometry.html#f190d00c7a0b5748e8159eba87cdb23a">PxSphereGeometry</a> (PxReal ir)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#gf291cce2e52852c81704c709997511a2">isValid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the geometry is valid.  <a href="group__geomutils.html#gf291cce2e52852c81704c709997511a2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxSphereGeometry.html#092be2e608f402b2c2da0309ad6fb2df">radius</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The radius of the sphere.  <a href="#092be2e608f402b2c2da0309ad6fb2df"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class representing the geometry of a sphere. 
<p>
Spheres are defined by their radius. <dl class="note" compact><dt><b>Note:</b></dt><dd>The scaling of the sphere is expected to be baked into this value, there is no additional scaling parameter. </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b0c426a8db79da6808e364de8d213c28"></a><!-- doxytag: member="PxSphereGeometry::PxSphereGeometry" ref="b0c426a8db79da6808e364de8d213c28" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxSphereGeometry::PxSphereGeometry           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="f190d00c7a0b5748e8159eba87cdb23a"></a><!-- doxytag: member="PxSphereGeometry::PxSphereGeometry" ref="f190d00c7a0b5748e8159eba87cdb23a" args="(PxReal ir)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxSphereGeometry::PxSphereGeometry           </td>
          <td>(</td>
          <td class="paramtype">PxReal&nbsp;</td>
          <td class="paramname"> <em>ir</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="092be2e608f402b2c2da0309ad6fb2df"></a><!-- doxytag: member="PxSphereGeometry::radius" ref="092be2e608f402b2c2da0309ad6fb2df" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxReal <a class="el" href="classPxSphereGeometry.html#092be2e608f402b2c2da0309ad6fb2df">PxSphereGeometry::radius</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The radius of the sphere. 
<p>

<p>Referenced by <a class="el" href="PxSphereGeometry_8h-source.html#l00076">isValid()</a>, and <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxSphereGeometry_8h-source.html">PxSphereGeometry.h</a></ul>
</div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>