diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxGeometry.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxGeometry.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxGeometry.html | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxGeometry.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxGeometry.html new file mode 100644 index 00000000..6c8e63c9 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxGeometry.html @@ -0,0 +1,190 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxGeometry 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>PxBoxGeometry Class Reference<br> +<small> +[<a class="el" href="group__geomutils.html">Geomutils</a>]</small> +</h1><!-- doxytag: class="PxBoxGeometry" --><!-- doxytag: inherits="PxGeometry" -->Class representing the geometry of a box. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxBoxGeometry_8h-source.html">PxBoxGeometry.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxBoxGeometry:</div> +<div class="dynsection"> +<p><center><img src="classPxBoxGeometry__inherit__graph.png" border="0" usemap="#PxBoxGeometry__inherit__map" alt="Inheritance graph"></center> +<map name="PxBoxGeometry__inherit__map"> +<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="17,16,103,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxBoxGeometry:</div> +<div class="dynsection"> +<p><center><img src="classPxBoxGeometry__coll__graph.png" border="0" usemap="#PxBoxGeometry__coll__map" alt="Collaboration graph"></center> +<map name="PxBoxGeometry__coll__map"> +<area shape="rect" href="classPxGeometry.html" title="A geometry object." alt="PxGeometry" coords="7,16,92,37"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="116,16,169,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxBoxGeometry-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="classPxBoxGeometry.html#ab5633a2c4280cc591bf9f13902405c2">PxBoxGeometry</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, initializes to a box with zero dimensions. <a href="#ab5633a2c4280cc591bf9f13902405c2"></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="classPxBoxGeometry.html#ef82a3ad150e5c85815d37548deb198c">PxBoxGeometry</a> (PxReal hx, PxReal hy, PxReal hz)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to initialize half extents from scalar parameters. <a href="#ef82a3ad150e5c85815d37548deb198c"></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="classPxBoxGeometry.html#9df30f1adc5a8cad38f70b3ae106860a">PxBoxGeometry</a> (<a class="el" href="classPxVec3.html">PxVec3</a> halfExtents_)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to initialize half extents from vector parameter. <a href="#9df30f1adc5a8cad38f70b3ae106860a"></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#g22ed148d960700feffe5a88a3fa7d5fa">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#g22ed148d960700feffe5a88a3fa7d5fa"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxGeometry.html#8fe8be4ca1467353956634d550dc8561">halfExtents</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Half of the width, height, and depth of the box. <a href="#8fe8be4ca1467353956634d550dc8561"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Class representing the geometry of a box. +<p> +The geometry of a box can be fully specified by its half extents. This is the half of its width, height, and depth. <dl class="note" compact><dt><b>Note:</b></dt><dd>The scaling of the box is expected to be baked into these values, there is no additional scaling parameter. </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="ab5633a2c4280cc591bf9f13902405c2"></a><!-- doxytag: member="PxBoxGeometry::PxBoxGeometry" ref="ab5633a2c4280cc591bf9f13902405c2" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxBoxGeometry::PxBoxGeometry </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 box with zero dimensions. +<p> + +</div> +</div><p> +<a class="anchor" name="ef82a3ad150e5c85815d37548deb198c"></a><!-- doxytag: member="PxBoxGeometry::PxBoxGeometry" ref="ef82a3ad150e5c85815d37548deb198c" args="(PxReal hx, PxReal hy, PxReal hz)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxBoxGeometry::PxBoxGeometry </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>hx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>hy</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>hz</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 to initialize half extents from scalar parameters. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hx</em> </td><td>Initial half extents' x component. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>hy</em> </td><td>Initial half extents' y component. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>hz</em> </td><td>Initial half extents' z component. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="9df30f1adc5a8cad38f70b3ae106860a"></a><!-- doxytag: member="PxBoxGeometry::PxBoxGeometry" ref="9df30f1adc5a8cad38f70b3ae106860a" args="(PxVec3 halfExtents_)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxBoxGeometry::PxBoxGeometry </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a> </td> + <td class="paramname"> <em>halfExtents_</em> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor to initialize half extents from vector parameter. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>halfExtents_</em> </td><td>Initial half extents. </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="8fe8be4ca1467353956634d550dc8561"></a><!-- doxytag: member="PxBoxGeometry::halfExtents" ref="8fe8be4ca1467353956634d550dc8561" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxVec3.html">PxVec3</a> <a class="el" href="classPxBoxGeometry.html#8fe8be4ca1467353956634d550dc8561">PxBoxGeometry::halfExtents</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Half of the width, height, and depth of the box. +<p> + +<p>Referenced by <a class="el" href="PxBoxGeometry_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="PxBoxGeometry_8h-source.html">PxBoxGeometry.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 2008-2016 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> |