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/structPxLocationHit.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/structPxLocationHit.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxLocationHit.html | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxLocationHit.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxLocationHit.html new file mode 100644 index 00000000..a4e0c5c8 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxLocationHit.html @@ -0,0 +1,188 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxLocationHit Struct 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>PxLocationHit Struct Reference<br> +<small> +[<a class="el" href="group__scenequery.html">Scenequery</a>]</small> +</h1><!-- doxytag: class="PxLocationHit" --><!-- doxytag: inherits="PxQueryHit" -->Scene query hit information for raycasts and sweeps returning hit position and normal information. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxQueryReport_8h-source.html">PxQueryReport.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxLocationHit:</div> +<div class="dynsection"> +<p><center><img src="structPxLocationHit__inherit__graph.png" border="0" usemap="#PxLocationHit__inherit__map" alt="Inheritance graph"></center> +<map name="PxLocationHit__inherit__map"> +<area shape="rect" href="structPxRaycastHit.html" title="Stores results of raycast queries." alt="PxRaycastHit" coords="7,224,92,246"><area shape="rect" href="structPxSweepHit.html" title="Stores results of sweep queries." alt="PxSweepHit" coords="116,224,199,246"><area shape="rect" href="structPxQueryHit.html" title="Scene query hit information." alt="PxQueryHit" coords="65,86,140,107"><area shape="rect" href="structPxActorShape.html" title="collection of set bits defined in PxHitFlag." alt="PxActorShape" coords="57,16,148,38"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxLocationHit:</div> +<div class="dynsection"> +<p><center><img src="structPxLocationHit__coll__graph.png" border="0" usemap="#PxLocationHit__coll__map" alt="Collaboration graph"></center> +<map name="PxLocationHit__coll__map"> +<area shape="rect" href="structPxQueryHit.html" title="Scene query hit information." alt="PxQueryHit" coords="87,432,161,453"><area shape="rect" href="structPxActorShape.html" title="collection of set bits defined in PxHitFlag." alt="PxActorShape" coords="79,360,169,381"><area shape="rect" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies..." alt="PxRigidActor" coords="32,269,115,290"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="61,178,115,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxShape.html" title="Abstract class for collision shapes." alt="PxShape" coords="125,224,189,245"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,37"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="185,432,239,453"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="structPxLocationHit-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="structPxLocationHit.html#9dce7a1e378082e86859350601591072">PxLocationHit</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxLocationHit.html#9d330de5e9a063ef91e034f7de7f1224">hadInitialOverlap</a> () const </td></tr> + +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxHitFlags </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxLocationHit.html#7a253cb291ae5850342dada5b4dfce34">flags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Hit flags specifying which members contain valid values. <a href="#7a253cb291ae5850342dada5b4dfce34"></a><br></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="structPxLocationHit.html#b7481e53d2f35a8249ae862d337fe5ac">position</a></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="structPxLocationHit.html#0e4815489090f4faced5e91f6f6cd336">normal</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">World-space hit normal (flag: <a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b645972f664c2fbe85c992fb9aaba46a5cf" title=""normal" member of PxQueryHit is valid">PxHitFlag::eNORMAL</a>). <a href="#0e4815489090f4faced5e91f6f6cd336"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxLocationHit.html#daccd7aa233279818ecdf50356ed0c76">distance</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Distance to hit. <a href="#daccd7aa233279818ecdf50356ed0c76"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Scene query hit information for raycasts and sweeps returning hit position and normal information. +<p> +<a class="el" href="structPxHitFlag.html" title="Scene query and geometry query behavior flags.">PxHitFlag</a> flags can be passed to scene query functions, as an optimization, to cause the SDK to only generate specific members of this structure. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="9dce7a1e378082e86859350601591072"></a><!-- doxytag: member="PxLocationHit::PxLocationHit" ref="9dce7a1e378082e86859350601591072" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxLocationHit::PxLocationHit </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="9d330de5e9a063ef91e034f7de7f1224"></a><!-- doxytag: member="PxLocationHit::hadInitialOverlap" ref="9d330de5e9a063ef91e034f7de7f1224" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE bool PxLocationHit::hadInitialOverlap </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>For raycast hits: true for shapes overlapping with raycast origin. <p> +For sweep hits: true for shapes overlapping at zero sweep distance.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxRaycastHit.html" title="Stores results of raycast queries.">PxRaycastHit</a> <a class="el" href="structPxSweepHit.html" title="Stores results of sweep queries.">PxSweepHit</a> </dd></dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="daccd7aa233279818ecdf50356ed0c76"></a><!-- doxytag: member="PxLocationHit::distance" ref="daccd7aa233279818ecdf50356ed0c76" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxF32 <a class="el" href="structPxLocationHit.html#daccd7aa233279818ecdf50356ed0c76">PxLocationHit::distance</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Distance to hit. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>If the eMTD flag is used, distance will be a negative value if shapes are overlapping indicating the penetration depth. <p> +Otherwise, this value will be >= 0 (flag: <a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b648bcc72eb9965eae03f53182e7e4b79ae" title=""distance" member of PxQueryHit is valid. Deprecated: the system will always...">PxHitFlag::eDISTANCE</a>) </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7a253cb291ae5850342dada5b4dfce34"></a><!-- doxytag: member="PxLocationHit::flags" ref="7a253cb291ae5850342dada5b4dfce34" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxHitFlags <a class="el" href="structPxLocationHit.html#7a253cb291ae5850342dada5b4dfce34">PxLocationHit::flags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Hit flags specifying which members contain valid values. +<p> + +</div> +</div><p> +<a class="anchor" name="0e4815489090f4faced5e91f6f6cd336"></a><!-- doxytag: member="PxLocationHit::normal" ref="0e4815489090f4faced5e91f6f6cd336" 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="structPxLocationHit.html#0e4815489090f4faced5e91f6f6cd336">PxLocationHit::normal</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +World-space hit normal (flag: <a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b645972f664c2fbe85c992fb9aaba46a5cf" title=""normal" member of PxQueryHit is valid">PxHitFlag::eNORMAL</a>). +<p> + +</div> +</div><p> +<a class="anchor" name="b7481e53d2f35a8249ae862d337fe5ac"></a><!-- doxytag: member="PxLocationHit::position" ref="b7481e53d2f35a8249ae862d337fe5ac" 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="structPxLocationHit.html#b7481e53d2f35a8249ae862d337fe5ac">PxLocationHit::position</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +World-space hit position (flag: <a class="el" href="structPxHitFlag.html#44c173f6ddf0522ffbd8fa3c585e6b6421e4769575db55be01d8f91e06c59b1a" title=""position" member of PxQueryHit is valid">PxHitFlag::ePOSITION</a>) Formerly known as .impact, renamed for clarity. +</div> +</div><p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="PxQueryReport_8h-source.html">PxQueryReport.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> |