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/structPxContactPairHeader.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/structPxContactPairHeader.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairHeader.html | 203 |
1 files changed, 203 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairHeader.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairHeader.html new file mode 100644 index 00000000..6ceaab9c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairHeader.html @@ -0,0 +1,203 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxContactPairHeader 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>PxContactPairHeader Struct Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxContactPairHeader" -->An Instance of this class is passed to <a class="el" href="classPxSimulationEventCallback.html#4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur.">PxSimulationEventCallback.onContact()</a>. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxSimulationEventCallback_8h-source.html">PxSimulationEventCallback.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxContactPairHeader:</div> +<div class="dynsection"> +<p><center><img src="structPxContactPairHeader__coll__graph.png" border="0" usemap="#PxContactPairHeader__coll__map" alt="Collaboration graph"></center> +<map name="PxContactPairHeader__coll__map"> +<area shape="rect" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies..." alt="PxRigidActor" coords="989,192,1072,214"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="607,208,660,230"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="389,103,445,124"><area shape="rect" href="classPxShape.html" title="Abstract class for collision shapes." alt="PxShape" coords="601,28,665,50"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="17,103,255,124"><area shape="rect" href="structPxContactPair.html" title="Contact report pair information." alt="PxContactPair" coords="985,92,1076,114"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxContactPairFlag::Enum, PxU16 \>" alt="PxFlags\< PxContactPairFlag::Enum, PxU16 \>" coords="497,86,769,107"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxPairFlag::Enum, PxU16 \>" alt="PxFlags\< PxPairFlag::Enum, PxU16 \>" coords="519,155,748,176"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxContactPairHeaderFlag::Enum, PxU16 \>" alt="PxFlags\< PxContactPairHeaderFlag::Enum, PxU16 \>" coords="873,250,1188,271"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="structPxContactPairHeader-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="structPxContactPairHeader.html#d5ae557cec81ae4c92b0e987b682af7d">PxContactPairHeader</a> ()</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="classPxRigidActor.html">PxRigidActor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#e3a7e00ec5edf59b946196becc840182">actors</a> [2]</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The two actors of the notification shape pairs. <a href="#e3a7e00ec5edf59b946196becc840182"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const PxU8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#2a9619192f15e1a60104c90b83f67e33">extraDataStream</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stream containing extra data as requested in the <a class="el" href="structPxPairFlag.html" title="Collection of flags describing the actions to take for a collision pair.">PxPairFlag</a> flags of the simulation filter. <a href="#2a9619192f15e1a60104c90b83f67e33"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU16 </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#b43e1aa99a8399533f57725d50f002d4">extraDataStreamSize</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Size of the extra data stream [bytes]. <a href="#b43e1aa99a8399533f57725d50f002d4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFlags.html">PxContactPairHeaderFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#ff053696e65138d0d5ca6625350e1011">flags</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Additional information on the contact report pair. <a href="#ff053696e65138d0d5ca6625350e1011"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct <a class="el" href="structPxContactPair.html">PxContactPair</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#e1b3429e7d69fcba36d264087e03c12b">pairs</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">pointer to the contact pairs <a href="#e1b3429e7d69fcba36d264087e03c12b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#a4b544da63d06205662034a5ebaf1e9f">nbPairs</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">number of contact pairs <a href="#a4b544da63d06205662034a5ebaf1e9f"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +An Instance of this class is passed to <a class="el" href="classPxSimulationEventCallback.html#4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur.">PxSimulationEventCallback.onContact()</a>. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSimulationEventCallback.html#4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur.">PxSimulationEventCallback.onContact()</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="d5ae557cec81ae4c92b0e987b682af7d"></a><!-- doxytag: member="PxContactPairHeader::PxContactPairHeader" ref="d5ae557cec81ae4c92b0e987b682af7d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxContactPairHeader::PxContactPairHeader </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 Data Documentation</h2> +<a class="anchor" name="e3a7e00ec5edf59b946196becc840182"></a><!-- doxytag: member="PxContactPairHeader::actors" ref="e3a7e00ec5edf59b946196becc840182" args="[2]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxRigidActor.html">PxRigidActor</a>* <a class="el" href="structPxContactPairHeader.html#e3a7e00ec5edf59b946196becc840182">PxContactPairHeader::actors</a>[2] </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The two actors of the notification shape pairs. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>The actor pointers might reference deleted actors. This will be the case if <a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2f201281be698379417370bf7b0aeeb78e" title="Call contact report callback or trigger callback when this collision pair stops to...">PxPairFlag::eNOTIFY_TOUCH_LOST</a> or <a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2f517ae07b413b27ad008f766170051ae6" title="Call contact report callback when the contact force between the actors of this collision...">PxPairFlag::eNOTIFY_THRESHOLD_FORCE_LOST</a> events were requested for the pair and one of the involved actors gets deleted or removed from the scene. Check the <a class="el" href="structPxContactPairHeader.html#ff053696e65138d0d5ca6625350e1011" title="Additional information on the contact report pair.">flags</a> member to see whether that is the case. Do not dereference a pointer to a deleted actor. The pointer to a deleted actor is only provided such that user data structures which might depend on the pointer value can be updated.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK.">PxActor</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2a9619192f15e1a60104c90b83f67e33"></a><!-- doxytag: member="PxContactPairHeader::extraDataStream" ref="2a9619192f15e1a60104c90b83f67e33" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const PxU8* <a class="el" href="structPxContactPairHeader.html#2a9619192f15e1a60104c90b83f67e33">PxContactPairHeader::extraDataStream</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Stream containing extra data as requested in the <a class="el" href="structPxPairFlag.html" title="Collection of flags describing the actions to take for a collision pair.">PxPairFlag</a> flags of the simulation filter. +<p> +This pointer is only valid if any kind of extra data information has been requested for the contact report pair (see <a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2f9502180b279a27e884468c3cb7c64544" title="Provide post solver velocities in contact reports for this collision pair.">PxPairFlag::ePOST_SOLVER_VELOCITY</a> etc.), else it will be NULL.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxPairFlag.html" title="Collection of flags describing the actions to take for a collision pair.">PxPairFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b43e1aa99a8399533f57725d50f002d4"></a><!-- doxytag: member="PxContactPairHeader::extraDataStreamSize" ref="b43e1aa99a8399533f57725d50f002d4" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxU16 <a class="el" href="structPxContactPairHeader.html#b43e1aa99a8399533f57725d50f002d4">PxContactPairHeader::extraDataStreamSize</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Size of the extra data stream [bytes]. +<p> + +</div> +</div><p> +<a class="anchor" name="ff053696e65138d0d5ca6625350e1011"></a><!-- doxytag: member="PxContactPairHeader::flags" ref="ff053696e65138d0d5ca6625350e1011" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxFlags.html">PxContactPairHeaderFlags</a> <a class="el" href="structPxContactPairHeader.html#ff053696e65138d0d5ca6625350e1011">PxContactPairHeader::flags</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Additional information on the contact report pair. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxContactPairHeaderFlag.html" title="Collection of flags providing information on contact report pairs.">PxContactPairHeaderFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a4b544da63d06205662034a5ebaf1e9f"></a><!-- doxytag: member="PxContactPairHeader::nbPairs" ref="a4b544da63d06205662034a5ebaf1e9f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="structPxContactPairHeader.html#a4b544da63d06205662034a5ebaf1e9f">PxContactPairHeader::nbPairs</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +number of contact pairs +<p> + +</div> +</div><p> +<a class="anchor" name="e1b3429e7d69fcba36d264087e03c12b"></a><!-- doxytag: member="PxContactPairHeader::pairs" ref="e1b3429e7d69fcba36d264087e03c12b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structPxContactPair.html">PxContactPair</a>* <a class="el" href="structPxContactPairHeader.html#e1b3429e7d69fcba36d264087e03c12b">PxContactPairHeader::pairs</a><code> [read]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +pointer to the contact pairs +<p> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="PxSimulationEventCallback_8h-source.html">PxSimulationEventCallback.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> |