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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxCapsuleGeometry 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>
<a class="qindex" href="hierarchy.html">Class Hierarchy</a>
<a class="qindex" href="annotated.html">Compound List</a>
<a class="qindex" href="functions.html">Compound Members</a>
</center>
<hr class="second">
</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxCapsuleGeometry Class Reference<br>
<small>
[<a class="el" href="group__geomutils.html">Geomutils</a>]</small>
</h1><!-- doxytag: class="PxCapsuleGeometry" --><!-- doxytag: inherits="PxGeometry" -->Class representing the geometry of a capsule.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxCapsuleGeometry_8h-source.html">PxCapsuleGeometry.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxCapsuleGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxCapsuleGeometry__inherit__graph.png" border="0" usemap="#PxCapsuleGeometry__inherit__map" alt="Inheritance graph"></center>
<map name="PxCapsuleGeometry__inherit__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="31,16,116,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxCapsuleGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxCapsuleGeometry__coll__graph.png" border="0" usemap="#PxCapsuleGeometry__coll__map" alt="Collaboration graph"></center>
<map name="PxCapsuleGeometry__coll__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="31,16,116,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxCapsuleGeometry-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#5764bb1f327ae431aaf875560930e41f">PxCapsuleGeometry</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, initializes to a capsule with zero height and radius. <a href="#5764bb1f327ae431aaf875560930e41f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#eb685e9dca4cb99658783dc348901998">PxCapsuleGeometry</a> (PxReal radius_, PxReal halfHeight_)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor, initializes to a capsule with passed radius and half height. <a href="#eb685e9dca4cb99658783dc348901998"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geomutils.html#g89d7fc1ea24a1f9acf2fccfcd3e28990">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the geometry is valid. <a href="group__geomutils.html#g89d7fc1ea24a1f9acf2fccfcd3e28990"></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#c4f07af35bc86338c5bd01e11266dadd">radius</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The radius of the capsule. <a href="#c4f07af35bc86338c5bd01e11266dadd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleGeometry.html#f5affd7d085f89d0a90a35b97214cc40">halfHeight</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">half of the capsule's height, measured between the centers of the hemispherical ends. <a href="#f5affd7d085f89d0a90a35b97214cc40"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class representing the geometry of a capsule.
<p>
Capsules are shaped as the union of a cylinder of length 2 * halfHeight and with the given radius centered at the origin and extending along the x axis, and two hemispherical ends. <dl class="note" compact><dt><b>Note:</b></dt><dd>The scaling of the capsule is expected to be baked into these values, there is no additional scaling parameter.</dd></dl>
The function PxTransformFromSegment is a helper for generating an appropriate transform for the capsule from the capsule's interior line segment.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__geomutils.html#g60805c0463b00baf463d5281e034a141" title="creates a transform from the endpoints of a segment, suitable for an actor transform...">PxTransformFromSegment</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5764bb1f327ae431aaf875560930e41f"></a><!-- doxytag: member="PxCapsuleGeometry::PxCapsuleGeometry" ref="5764bb1f327ae431aaf875560930e41f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxCapsuleGeometry::PxCapsuleGeometry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor, initializes to a capsule with zero height and radius.
<p>
</div>
</div><p>
<a class="anchor" name="eb685e9dca4cb99658783dc348901998"></a><!-- doxytag: member="PxCapsuleGeometry::PxCapsuleGeometry" ref="eb685e9dca4cb99658783dc348901998" args="(PxReal radius_, PxReal halfHeight_)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxCapsuleGeometry::PxCapsuleGeometry </td>
<td>(</td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>radius_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PxReal </td>
<td class="paramname"> <em>halfHeight_</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor, initializes to a capsule with passed radius and half height.
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f5affd7d085f89d0a90a35b97214cc40"></a><!-- doxytag: member="PxCapsuleGeometry::halfHeight" ref="f5affd7d085f89d0a90a35b97214cc40" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxCapsuleGeometry.html#f5affd7d085f89d0a90a35b97214cc40">PxCapsuleGeometry::halfHeight</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
half of the capsule's height, measured between the centers of the hemispherical ends.
<p>
<p>Referenced by <a class="el" href="PxCapsuleGeometry_8h-source.html#l00092">isValid()</a>, and <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c4f07af35bc86338c5bd01e11266dadd"></a><!-- doxytag: member="PxCapsuleGeometry::radius" ref="c4f07af35bc86338c5bd01e11266dadd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxReal <a class="el" href="classPxCapsuleGeometry.html#c4f07af35bc86338c5bd01e11266dadd">PxCapsuleGeometry::radius</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The radius of the capsule.
<p>
<p>Referenced by <a class="el" href="PxCapsuleGeometry_8h-source.html#l00092">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="PxCapsuleGeometry_8h-source.html">PxCapsuleGeometry.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 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>
|