aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxGeometry.html
blob: a61c149a5c936607e8be85a02ed0479e59d98efc (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxGeometry 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>PxGeometry Class Reference<br>
<small>
[<a class="el" href="group__geomutils.html">Geomutils</a>]</small>
</h1><!-- doxytag: class="PxGeometry" -->A geometry object.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxGeometry_8h-source.html">PxGeometry.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxGeometry__inherit__graph.png" border="0" usemap="#PxGeometry__inherit__map" alt="Inheritance graph"></center>
<map name="PxGeometry__inherit__map">
<area shape="rect" href="classPxBoxGeometry.html" title="Class representing the geometry of a box." alt="PxBoxGeometry" coords="180,5,287,26"><area shape="rect" href="classPxCapsuleGeometry.html" title="Class representing the geometry of a capsule." alt="PxCapsuleGeometry" coords="167,50,300,72"><area shape="rect" href="classPxConvexMeshGeometry.html" title="Convex mesh geometry class." alt="PxConvexMeshGeometry" coords="153,96,313,117"><area shape="rect" href="classPxHeightFieldGeometry.html" title="Height field geometry class." alt="PxHeightFieldGeometry" coords="159,141,308,162"><area shape="rect" href="classPxPlaneGeometry.html" title="Class describing a plane geometry." alt="PxPlaneGeometry" coords="175,186,292,208"><area shape="rect" href="classPxSphereGeometry.html" title="A class representing the geometry of a sphere." alt="PxSphereGeometry" coords="169,232,297,253"><area shape="rect" href="classPxTriangleMeshGeometry.html" title="Triangle mesh geometry class." alt="PxTriangleMeshGeometry" coords="151,277,316,298"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxGeometry-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_CUDA_CALLABLE <br class="typebreak">
PX_FORCE_INLINE <br class="typebreak">
<a class="el" href="structPxGeometryType.html#efc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#da00045053aaa9bdc56eeb38066cbe29">getType</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type of the geometry.  <a href="#da00045053aaa9bdc56eeb38066cbe29"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#2507c9f4d63fe816968fe9a2744ac549">PxGeometry</a> (<a class="el" href="structPxGeometryType.html#efc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a> type)</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxGeometryType.html#efc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxGeometry.html#f24eeb8078fbd12e17206029b52a45b6">mType</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A geometry object. 
<p>
A geometry object defines the characteristics of a spatial object, but without any information about its placement in the world.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>This is an abstract class. You cannot create instances directly. Create an instance of one of the derived classes instead. </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2507c9f4d63fe816968fe9a2744ac549"></a><!-- doxytag: member="PxGeometry::PxGeometry" ref="2507c9f4d63fe816968fe9a2744ac549" args="(PxGeometryType::Enum type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxGeometry::PxGeometry           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structPxGeometryType.html#efc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="da00045053aaa9bdc56eeb38066cbe29"></a><!-- doxytag: member="PxGeometry::getType" ref="da00045053aaa9bdc56eeb38066cbe29" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE <a class="el" href="structPxGeometryType.html#efc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a> PxGeometry::getType           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Returns the type of the geometry. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of the object. </dd></dl>

<p>Referenced by <a class="el" href="PxMassProperties_8h-source.html#l00083">PxMassProperties::PxMassProperties()</a>, and <a class="el" href="PxGeometryHelpers_8h-source.html#l00153">PxGeometryHolder::storeAny()</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="f24eeb8078fbd12e17206029b52a45b6"></a><!-- doxytag: member="PxGeometry::mType" ref="f24eeb8078fbd12e17206029b52a45b6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structPxGeometryType.html#efc79f72c4c479192ac19d41a6f30ed5">PxGeometryType::Enum</a> <a class="el" href="classPxGeometry.html#f24eeb8078fbd12e17206029b52a45b6">PxGeometry::mType</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Referenced by <a class="el" href="PxTriangleMeshGeometry_8h-source.html#l00131">PxTriangleMeshGeometry::isValid()</a>, <a class="el" href="PxSphereGeometry_8h-source.html#l00076">PxSphereGeometry::isValid()</a>, <a class="el" href="PxPlaneGeometry_8h-source.html#l00072">PxPlaneGeometry::isValid()</a>, <a class="el" href="PxHeightFieldGeometry_8h-source.html#l00124">PxHeightFieldGeometry::isValid()</a>, <a class="el" href="PxConvexMeshGeometry_8h-source.html#l00136">PxConvexMeshGeometry::isValid()</a>, <a class="el" href="PxCapsuleGeometry_8h-source.html#l00092">PxCapsuleGeometry::isValid()</a>, and <a class="el" href="PxBoxGeometry_8h-source.html#l00092">PxBoxGeometry::isValid()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxGeometry_8h-source.html">PxGeometry.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>