diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxPlane.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxPlane.html | 434 |
1 files changed, 434 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxPlane.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPlane.html new file mode 100644 index 00000000..878934c6 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxPlane.html @@ -0,0 +1,434 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxPlane 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>PxPlane Class Reference<br> +<small> +[<a class="el" href="group__foundation.html">Foundation</a>]</small> +</h1><!-- doxytag: class="PxPlane" -->Representation of a plane. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxPlane_8h-source.html">PxPlane.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxPlane:</div> +<div class="dynsection"> +<p><center><img src="classPxPlane__coll__graph.png" border="0" usemap="#PxPlane__coll__map" alt="Collaboration graph"></center> +<map name="PxPlane__coll__map"> +<area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="9,16,63,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxPlane-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 PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#a91bd50f689e65d8df16b9bc451adbe4">PxPlane</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a91bd50f689e65d8df16b9bc451adbe4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#5d449753bd941b2ac7d4f507e53ff2b9">PxPlane</a> (float nx, float ny, float nz, float distance)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a normal and a distance. <a href="#5d449753bd941b2ac7d4f507e53ff2b9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#8999609dacee1ba2ac0011f481014d08">PxPlane</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &normal, float distance)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a normal and a distance. <a href="#8999609dacee1ba2ac0011f481014d08"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#0b6a4463b95366c1f9a12a84d57509bd">PxPlane</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &point, const <a class="el" href="classPxVec3.html">PxVec3</a> &normal)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from a point on the plane and a normal. <a href="#0b6a4463b95366c1f9a12a84d57509bd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#3ce0657187ece1138c35ea775e4d075e">PxPlane</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &p0, const <a class="el" href="classPxVec3.html">PxVec3</a> &p1, const <a class="el" href="classPxVec3.html">PxVec3</a> &p2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from three points. <a href="#3ce0657187ece1138c35ea775e4d075e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#53ceb7e1cf89c4ad8a2190d65e27973f">operator==</a> (const <a class="el" href="classPxPlane.html">PxPlane</a> &p) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the two planes are exactly equal <a href="#53ceb7e1cf89c4ad8a2190d65e27973f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE float </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#62350635f430e98c8c752b3649401803">distance</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &p) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#becea8070578abddd21160f5bd5450e8">contains</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &p) const </td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE <a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#3d23d45c05f3ad071d8f77cf78a5b231">project</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &p) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">projects p into the plane <a href="#3d23d45c05f3ad071d8f77cf78a5b231"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE <a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#b2e1652edb0075afcdf4e28f513ec736">pointInPlane</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">find an arbitrary point in the plane <a href="#b2e1652edb0075afcdf4e28f513ec736"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_CUDA_CALLABLE <br class="typebreak"> +PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#37c94eda03f24e3caed2e7739940c14a">normalize</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">equivalent plane with unit normal <a href="#37c94eda03f24e3caed2e7739940c14a"></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="classPxPlane.html#5697986eb1240eafe0261f453c5a7065">n</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The normal to the plane. <a href="#5697986eb1240eafe0261f453c5a7065"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxPlane.html#7cf263ac8ebddc47953a3fcbfc0a0455">d</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The distance from the origin. <a href="#7cf263ac8ebddc47953a3fcbfc0a0455"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Representation of a plane. +<p> +Plane equation used: n.dot(v) + d = 0 <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="a91bd50f689e65d8df16b9bc451adbe4"></a><!-- doxytag: member="PxPlane::PxPlane" ref="a91bd50f689e65d8df16b9bc451adbe4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxPlane::PxPlane </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructor. +<p> + +</div> +</div><p> +<a class="anchor" name="5d449753bd941b2ac7d4f507e53ff2b9"></a><!-- doxytag: member="PxPlane::PxPlane" ref="5d449753bd941b2ac7d4f507e53ff2b9" args="(float nx, float ny, float nz, float distance)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxPlane::PxPlane </td> + <td>(</td> + <td class="paramtype">float </td> + <td class="paramname"> <em>nx</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>ny</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>nz</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>distance</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 from a normal and a distance. +<p> + +</div> +</div><p> +<a class="anchor" name="8999609dacee1ba2ac0011f481014d08"></a><!-- doxytag: member="PxPlane::PxPlane" ref="8999609dacee1ba2ac0011f481014d08" args="(const PxVec3 &normal, float distance)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxPlane::PxPlane </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>normal</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>distance</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 from a normal and a distance. +<p> + +</div> +</div><p> +<a class="anchor" name="0b6a4463b95366c1f9a12a84d57509bd"></a><!-- doxytag: member="PxPlane::PxPlane" ref="0b6a4463b95366c1f9a12a84d57509bd" args="(const PxVec3 &point, const PxVec3 &normal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxPlane::PxPlane </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>point</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>normal</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 from a point on the plane and a normal. +<p> + +</div> +</div><p> +<a class="anchor" name="3ce0657187ece1138c35ea775e4d075e"></a><!-- doxytag: member="PxPlane::PxPlane" ref="3ce0657187ece1138c35ea775e4d075e" args="(const PxVec3 &p0, const PxVec3 &p1, const PxVec3 &p2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE PxPlane::PxPlane </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>p0</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>p1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>p2</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 from three points. +<p> + +<p>References <a class="el" href="PxVec3_8h-source.html#l00275">PxVec3::dot()</a>.</p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="becea8070578abddd21160f5bd5450e8"></a><!-- doxytag: member="PxPlane::contains" ref="becea8070578abddd21160f5bd5450e8" args="(const PxVec3 &p) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE bool PxPlane::contains </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>p</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>References <a class="el" href="PxMath_8h-source.html#l00107">PxAbs()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="62350635f430e98c8c752b3649401803"></a><!-- doxytag: member="PxPlane::distance" ref="62350635f430e98c8c752b3649401803" args="(const PxVec3 &p) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE float PxPlane::distance </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>p</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +<p>References <a class="el" href="PxVec3_8h-source.html#l00275">PxVec3::dot()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="37c94eda03f24e3caed2e7739940c14a"></a><!-- doxytag: member="PxPlane::normalize" ref="37c94eda03f24e3caed2e7739940c14a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE void PxPlane::normalize </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +equivalent plane with unit normal +<p> + +</div> +</div><p> +<a class="anchor" name="53ceb7e1cf89c4ad8a2190d65e27973f"></a><!-- doxytag: member="PxPlane::operator==" ref="53ceb7e1cf89c4ad8a2190d65e27973f" args="(const PxPlane &p) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_INLINE bool PxPlane::operator== </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxPlane.html">PxPlane</a> & </td> + <td class="paramname"> <em>p</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +returns true if the two planes are exactly equal +<p> + +<p>References <a class="el" href="PxPlane_8h-source.html#l00137">d</a>, and <a class="el" href="PxPlane_8h-source.html#l00136">n</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b2e1652edb0075afcdf4e28f513ec736"></a><!-- doxytag: member="PxPlane::pointInPlane" ref="b2e1652edb0075afcdf4e28f513ec736" 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="classPxVec3.html">PxVec3</a> PxPlane::pointInPlane </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +find an arbitrary point in the plane +<p> + +</div> +</div><p> +<a class="anchor" name="3d23d45c05f3ad071d8f77cf78a5b231"></a><!-- doxytag: member="PxPlane::project" ref="3d23d45c05f3ad071d8f77cf78a5b231" args="(const PxVec3 &p) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_CUDA_CALLABLE PX_FORCE_INLINE <a class="el" href="classPxVec3.html">PxVec3</a> PxPlane::project </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>p</em> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +projects p into the plane +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="7cf263ac8ebddc47953a3fcbfc0a0455"></a><!-- doxytag: member="PxPlane::d" ref="7cf263ac8ebddc47953a3fcbfc0a0455" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="classPxPlane.html#7cf263ac8ebddc47953a3fcbfc0a0455">PxPlane::d</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The distance from the origin. +<p> + +<p>Referenced by <a class="el" href="PxTransform_8h-source.html#l00195">PxTransform::inverseTransform()</a>, <a class="el" href="PxPlane_8h-source.html#l00094">operator==()</a>, and <a class="el" href="PxTransform_8h-source.html#l00185">PxTransform::transform()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5697986eb1240eafe0261f453c5a7065"></a><!-- doxytag: member="PxPlane::n" ref="5697986eb1240eafe0261f453c5a7065" 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="classPxPlane.html#5697986eb1240eafe0261f453c5a7065">PxPlane::n</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The normal to the plane. +<p> + +<p>Referenced by <a class="el" href="PxTransform_8h-source.html#l00195">PxTransform::inverseTransform()</a>, <a class="el" href="PxPlane_8h-source.html#l00094">operator==()</a>, and <a class="el" href="PxTransform_8h-source.html#l00185">PxTransform::transform()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxPlane_8h-source.html">PxPlane.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> |