aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxPlaneGeometry.html
blob: f1a948c3671e5955b7bdcaecbd655d5771ced24d (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPlaneGeometry 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>PxPlaneGeometry Class Reference<br>
<small>
[<a class="el" href="group__geomutils.html">Geomutils</a>]</small>
</h1><!-- doxytag: class="PxPlaneGeometry" --><!-- doxytag: inherits="PxGeometry" -->Class describing a plane geometry.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxPlaneGeometry_8h-source.html">PxPlaneGeometry.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxPlaneGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxPlaneGeometry__inherit__graph.png" border="0" usemap="#PxPlaneGeometry__inherit__map" alt="Inheritance graph"></center>
<map name="PxPlaneGeometry__inherit__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="23,16,108,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxPlaneGeometry:</div>
<div class="dynsection">
<p><center><img src="classPxPlaneGeometry__coll__graph.png" border="0" usemap="#PxPlaneGeometry__coll__map" alt="Collaboration graph"></center>
<map name="PxPlaneGeometry__coll__map">
<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="23,16,108,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxPlaneGeometry-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="classPxPlaneGeometry.html#d71ebf9ac3a2f3831fb65dfe91adf505">PxPlaneGeometry</a> ()</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#g41a7d06c9b508d962211ed1d91b0bf2f">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#g41a7d06c9b508d962211ed1d91b0bf2f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class describing a plane geometry. 
<p>
The plane geometry specifies the half-space volume x&lt;=0. As with other geometry types, when used in a <a class="el" href="classPxShape.html" title="Abstract class for collision shapes.">PxShape</a> the collision volume is obtained by transforming the halfspace by the shape local pose and the actor global pose.<p>
To generate a <a class="el" href="classPxPlane.html" title="Representation of a plane.">PxPlane</a> from a <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a>, transform PxPlane(1,0,0,0).<p>
To generate a <a class="el" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a> from a <a class="el" href="classPxPlane.html" title="Representation of a plane.">PxPlane</a>, use PxTransformFromPlaneEquation.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxShape.html#c6112e8c0ee9803eb3436bbaf673d98a" title="Adjust the geometry of the shape.">PxShape.setGeometry()</a> <a class="el" href="classPxShape.html#fe05ad6f093d762abaf03e3e0c1de704" title="Fetch the geometry of the shape.">PxShape.getPlaneGeometry()</a> <a class="el" href="group__geomutils.html#gd7702c73625ee858ad6458b97856d475" title="creates a transform from a plane equation, suitable for an actor transform for a...">PxTransformFromPlaneEquation</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="d71ebf9ac3a2f3831fb65dfe91adf505"></a><!-- doxytag: member="PxPlaneGeometry::PxPlaneGeometry" ref="d71ebf9ac3a2f3831fb65dfe91adf505" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_INLINE PxPlaneGeometry::PxPlaneGeometry           </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>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxPlaneGeometry_8h-source.html">PxPlaneGeometry.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>