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/structPxContactPairExtraDataIterator.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/structPxContactPairExtraDataIterator.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairExtraDataIterator.html | 277 |
1 files changed, 277 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairExtraDataIterator.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairExtraDataIterator.html new file mode 100644 index 00000000..1f52990b --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairExtraDataIterator.html @@ -0,0 +1,277 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxContactPairExtraDataIterator 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>PxContactPairExtraDataIterator Struct Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxContactPairExtraDataIterator" -->A class to iterate over a contact pair extra data stream. +<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 PxContactPairExtraDataIterator:</div> +<div class="dynsection"> +<p><center><img src="structPxContactPairExtraDataIterator__coll__graph.png" border="0" usemap="#PxContactPairExtraDataIterator__coll__map" alt="Collaboration graph"></center> +<map name="PxContactPairExtraDataIterator__coll__map"> +<area shape="rect" href="structPxContactPairVelocity.html" title="Velocities of the contact pair rigid bodies." alt="PxContactPairVelocity" coords="60,214,193,235"><area shape="rect" href="structPxContactPairExtraDataItem.html" title="Base class for items in the extra data stream of contact pairs." alt="PxContactPairExtraDataItem" coords="152,115,323,136"><area shape="rect" href="structPxContactPairPose.html" title="World space actor poses of the contact pair rigid bodies." alt="PxContactPairPose" coords="231,214,351,235"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="144,16,197,38"><area shape="rect" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector" alt="PxTransform" coords="347,115,429,136"><area shape="rect" href="classPxQuat.html" title="This is a quaternion class. For more information on quaternion mathematics consult..." alt="PxQuat" coords="361,16,415,38"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="structPxContactPairExtraDataIterator-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_FORCE_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataIterator.html#f5d36be4d51a22af103523375a04d5e0">PxContactPairExtraDataIterator</a> (const PxU8 *stream, <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> size)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#f5d36be4d51a22af103523375a04d5e0"></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="structPxContactPairExtraDataIterator.html#6938e71e6ed8d693a4fe9e1bd3bd9d3a">nextItemSet</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Advances the iterator to next set of extra data items. <a href="#6938e71e6ed8d693a4fe9e1bd3bd9d3a"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const PxU8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataIterator.html#c54b5d820140765076bc39255d679750">currPtr</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Current pointer in the stream. <a href="#c54b5d820140765076bc39255d679750"></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="structPxContactPairExtraDataIterator.html#ff63eb915e6527e8d807ed6cdac48a7b">endPtr</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the end of the stream. <a href="#ff63eb915e6527e8d807ed6cdac48a7b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structPxContactPairVelocity.html">PxContactPairVelocity</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataIterator.html#bec5ba2e81dc6604bf322fe4cb1810e1">preSolverVelocity</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the current pre solver velocity item in the stream. NULL if there is none. <a href="#bec5ba2e81dc6604bf322fe4cb1810e1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structPxContactPairVelocity.html">PxContactPairVelocity</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataIterator.html#8e2656d684789f0f05c135d5f5c5fa25">postSolverVelocity</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the current post solver velocity item in the stream. NULL if there is none. <a href="#8e2656d684789f0f05c135d5f5c5fa25"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structPxContactPairPose.html">PxContactPairPose</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataIterator.html#dcdd22f0243e8e2ffc81241a8831074c">eventPose</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the current contact event pose item in the stream. NULL if there is none. <a href="#dcdd22f0243e8e2ffc81241a8831074c"></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="structPxContactPairExtraDataIterator.html#137240c7c0d90d99f78800108a311256">contactPairIndex</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The contact pair index of the current item set in the stream. <a href="#137240c7c0d90d99f78800108a311256"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_FORCE_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataIterator.html#1d2a22a64b21c547ad7e586307ca3afb">clearDataPtrs</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal helper. <a href="#1d2a22a64b21c547ad7e586307ca3afb"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A class to iterate over a contact pair extra data stream. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxContactPairHeader.html#2a9619192f15e1a60104c90b83f67e33" title="Stream containing extra data as requested in the PxPairFlag flags of the simulation...">PxContactPairHeader.extraDataStream</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="f5d36be4d51a22af103523375a04d5e0"></a><!-- doxytag: member="PxContactPairExtraDataIterator::PxContactPairExtraDataIterator" ref="f5d36be4d51a22af103523375a04d5e0" args="(const PxU8 *stream, PxU32 size)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE PxContactPairExtraDataIterator::PxContactPairExtraDataIterator </td> + <td>(</td> + <td class="paramtype">const PxU8 * </td> + <td class="paramname"> <em>stream</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>size</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. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>stream</em> </td><td>Pointer to the start of the stream. </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>Size of the stream in bytes. </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="1d2a22a64b21c547ad7e586307ca3afb"></a><!-- doxytag: member="PxContactPairExtraDataIterator::clearDataPtrs" ref="1d2a22a64b21c547ad7e586307ca3afb" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_FORCE_INLINE void PxContactPairExtraDataIterator::clearDataPtrs </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Internal helper. +<p> + +</div> +</div><p> +<a class="anchor" name="6938e71e6ed8d693a4fe9e1bd3bd9d3a"></a><!-- doxytag: member="PxContactPairExtraDataIterator::nextItemSet" ref="6938e71e6ed8d693a4fe9e1bd3bd9d3a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE bool PxContactPairExtraDataIterator::nextItemSet </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Advances the iterator to next set of extra data items. +<p> +The contact pair extra data stream contains sets of items as requested by the corresponding <a class="el" href="structPxPairFlag.html" title="Collection of flags describing the actions to take for a collision pair.">PxPairFlag</a> flags <a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2fcac6889c907f5e9dcf8e6ea56da1f99e" title="Provide pre solver velocities in contact reports for this collision pair.">PxPairFlag::ePRE_SOLVER_VELOCITY</a>, <a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2f9502180b279a27e884468c3cb7c64544" title="Provide post solver velocities in contact reports for this collision pair.">PxPairFlag::ePOST_SOLVER_VELOCITY</a>, <a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2f31be9ac6da5a882091927851a2c73c59" title="Provide rigid body poses in contact reports for this collision pair.">PxPairFlag::eCONTACT_EVENT_POSE</a>. A set can contain one item of each plus the <a class="el" href="structPxContactPairIndex.html" title="Marker for the beginning of a new item set in the extra data stream.">PxContactPairIndex</a> item. This method parses the stream and points the iterator member variables to the corresponding items of the current set, if they are available. If CCD is not enabled, you should only get one set of items. If CCD with multiple passes is enabled, you might get more than one item set.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Even though contact pair extra data is requested per shape pair, you will not get an item set per shape pair but one per actor pair. If, for example, an actor has two shapes and both collide with another actor, then there will only be one item set (since it applies to both shape pairs).</dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if there was another set of extra data items in the stream, else false.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxContactPairVelocity.html" title="Velocities of the contact pair rigid bodies.">PxContactPairVelocity</a> <a class="el" href="structPxContactPairPose.html" title="World space actor poses of the contact pair rigid bodies.">PxContactPairPose</a> <a class="el" href="structPxContactPairIndex.html" title="Marker for the beginning of a new item set in the extra data stream.">PxContactPairIndex</a> </dd></dl> + +<p>References <a class="el" href="PxSimulationEventCallback_8h-source.html#l00067">PxContactPairExtraDataType::eCONTACT_EVENT_POSE</a>, <a class="el" href="PxSimulationEventCallback_8h-source.html#l00068">PxContactPairExtraDataType::eCONTACT_PAIR_INDEX</a>, <a class="el" href="PxSimulationEventCallback_8h-source.html#l00066">PxContactPairExtraDataType::ePOST_SOLVER_VELOCITY</a>, <a class="el" href="PxSimulationEventCallback_8h-source.html#l00065">PxContactPairExtraDataType::ePRE_SOLVER_VELOCITY</a>, <a class="el" href="PxAssert_8h-source.html#l00061">PX_ASSERT</a>, and <a class="el" href="PxSimulationEventCallback_8h-source.html#l00086">PxContactPairExtraDataItem::type</a>.</p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="137240c7c0d90d99f78800108a311256"></a><!-- doxytag: member="PxContactPairExtraDataIterator::contactPairIndex" ref="137240c7c0d90d99f78800108a311256" 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="structPxContactPairExtraDataIterator.html#137240c7c0d90d99f78800108a311256">PxContactPairExtraDataIterator::contactPairIndex</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The contact pair index of the current item set in the stream. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxContactPairIndex.html" title="Marker for the beginning of a new item set in the extra data stream.">PxContactPairIndex</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c54b5d820140765076bc39255d679750"></a><!-- doxytag: member="PxContactPairExtraDataIterator::currPtr" ref="c54b5d820140765076bc39255d679750" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const PxU8* <a class="el" href="structPxContactPairExtraDataIterator.html#c54b5d820140765076bc39255d679750">PxContactPairExtraDataIterator::currPtr</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Current pointer in the stream. +<p> + +</div> +</div><p> +<a class="anchor" name="ff63eb915e6527e8d807ed6cdac48a7b"></a><!-- doxytag: member="PxContactPairExtraDataIterator::endPtr" ref="ff63eb915e6527e8d807ed6cdac48a7b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const PxU8* <a class="el" href="structPxContactPairExtraDataIterator.html#ff63eb915e6527e8d807ed6cdac48a7b">PxContactPairExtraDataIterator::endPtr</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Pointer to the end of the stream. +<p> + +</div> +</div><p> +<a class="anchor" name="dcdd22f0243e8e2ffc81241a8831074c"></a><!-- doxytag: member="PxContactPairExtraDataIterator::eventPose" ref="dcdd22f0243e8e2ffc81241a8831074c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="structPxContactPairPose.html">PxContactPairPose</a>* <a class="el" href="structPxContactPairExtraDataIterator.html#dcdd22f0243e8e2ffc81241a8831074c">PxContactPairExtraDataIterator::eventPose</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Pointer to the current contact event pose item in the stream. NULL if there is none. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxContactPairPose.html" title="World space actor poses of the contact pair rigid bodies.">PxContactPairPose</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8e2656d684789f0f05c135d5f5c5fa25"></a><!-- doxytag: member="PxContactPairExtraDataIterator::postSolverVelocity" ref="8e2656d684789f0f05c135d5f5c5fa25" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="structPxContactPairVelocity.html">PxContactPairVelocity</a>* <a class="el" href="structPxContactPairExtraDataIterator.html#8e2656d684789f0f05c135d5f5c5fa25">PxContactPairExtraDataIterator::postSolverVelocity</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Pointer to the current post solver velocity item in the stream. NULL if there is none. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxContactPairVelocity.html" title="Velocities of the contact pair rigid bodies.">PxContactPairVelocity</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="bec5ba2e81dc6604bf322fe4cb1810e1"></a><!-- doxytag: member="PxContactPairExtraDataIterator::preSolverVelocity" ref="bec5ba2e81dc6604bf322fe4cb1810e1" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="structPxContactPairVelocity.html">PxContactPairVelocity</a>* <a class="el" href="structPxContactPairExtraDataIterator.html#bec5ba2e81dc6604bf322fe4cb1810e1">PxContactPairExtraDataIterator::preSolverVelocity</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Pointer to the current pre solver velocity item in the stream. NULL if there is none. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxContactPairVelocity.html" title="Velocities of the contact pair rigid bodies.">PxContactPairVelocity</a> </dd></dl> + +</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> |