Files
PhysX4.1/physx/documentation/PhysXAPI/files/structPxContactPairIndex.html
2025-11-28 23:13:44 +05:30

200 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxContactPairIndex Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structPxContactPairIndex.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structPxContactPairIndex-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PxContactPairIndex Struct Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Marker for the beginning of a new item set in the extra data stream.
<a href="structPxContactPairIndex.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PxSimulationEventCallback_8h_source.html">PxSimulationEventCallback.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PxContactPairIndex:</div>
<div class="dyncontent">
<div class="center"><img src="structPxContactPairIndex__inherit__graph.png" border="0" usemap="#PxContactPairIndex_inherit__map" alt="Inheritance graph"/></div>
<map name="PxContactPairIndex_inherit__map" id="PxContactPairIndex_inherit__map">
<area shape="rect" id="node2" href="structPxContactPairExtraDataItem.html" title="Base class for items in the extra data stream of contact pairs. " alt="" coords="5,5,195,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PxContactPairIndex:</div>
<div class="dyncontent">
<div class="center"><img src="structPxContactPairIndex__coll__graph.png" border="0" usemap="#PxContactPairIndex_coll__map" alt="Collaboration graph"/></div>
<map name="PxContactPairIndex_coll__map" id="PxContactPairIndex_coll__map">
<area shape="rect" id="node2" href="structPxContactPairExtraDataItem.html" title="Base class for items in the extra data stream of contact pairs. " alt="" coords="5,5,195,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0aae6856f18cbe9040c586ef4852a862"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairIndex.html#a0aae6856f18cbe9040c586ef4852a862">PxContactPairIndex</a> ()</td></tr>
<tr class="separator:a0aae6856f18cbe9040c586ef4852a862"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structPxContactPairExtraDataItem"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structPxContactPairExtraDataItem')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structPxContactPairExtraDataItem.html">PxContactPairExtraDataItem</a></td></tr>
<tr class="memitem:a79c3bb558f707953197bd57b15baa0fe inherit pub_methods_structPxContactPairExtraDataItem"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataItem.html#a79c3bb558f707953197bd57b15baa0fe">PxContactPairExtraDataItem</a> ()</td></tr>
<tr class="separator:a79c3bb558f707953197bd57b15baa0fe inherit pub_methods_structPxContactPairExtraDataItem"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab9ca1f887cd9a26b50eadd4297c4d19e"><td class="memItemLeft" align="right" valign="top">PxU16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairIndex.html#ab9ca1f887cd9a26b50eadd4297c4d19e">index</a></td></tr>
<tr class="memdesc:ab9ca1f887cd9a26b50eadd4297c4d19e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The next item set in the extra data stream refers to the contact pairs starting at <a class="el" href="structPxContactPairIndex.html#ab9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at index in the repor...">index</a> in the reported <a class="el" href="structPxContactPair.html" title="Contact report pair information. ">PxContactPair</a> array. <a href="#ab9ca1f887cd9a26b50eadd4297c4d19e">More...</a><br /></td></tr>
<tr class="separator:ab9ca1f887cd9a26b50eadd4297c4d19e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structPxContactPairExtraDataItem"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structPxContactPairExtraDataItem')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structPxContactPairExtraDataItem.html">PxContactPairExtraDataItem</a></td></tr>
<tr class="memitem:a18e83c33b02a0a57f0daf818379e06d6 inherit pub_attribs_structPxContactPairExtraDataItem"><td class="memItemLeft" align="right" valign="top">PxU8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairExtraDataItem.html#a18e83c33b02a0a57f0daf818379e06d6">type</a></td></tr>
<tr class="memdesc:a18e83c33b02a0a57f0daf818379e06d6 inherit pub_attribs_structPxContactPairExtraDataItem"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of the extra data stream item. <a href="structPxContactPairExtraDataItem.html#a18e83c33b02a0a57f0daf818379e06d6">More...</a><br /></td></tr>
<tr class="separator:a18e83c33b02a0a57f0daf818379e06d6 inherit pub_attribs_structPxContactPairExtraDataItem"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Marker for the beginning of a new item set in the extra data stream. </p>
<p>If CCD with multiple passes is enabled, then a fast moving object might bounce on and off the same object multiple times. Also, different shapes of the same actor might gain and lose contact with an other object over multiple passes. This marker allows to seperate the extra data items for each collision case, as well as distinguish the shape pair reports of different CCD passes.</p>
<p>Example: Let us assume that an actor a0 with shapes s0_0 and s0_1 hits another actor a1 with shape s1. First s0_0 will hit s1, then a0 will slightly rotate and s0_1 will hit s1 while s0_0 will lose contact with s1. Furthermore, let us say that contact event pose information is requested as extra data. The extra data stream will look like this:</p>
<p>PxContactPairIndexA | PxContactPairPoseA | PxContactPairIndexB | PxContactPairPoseB</p>
<p>The corresponding array of <a class="el" href="structPxContactPair.html" title="Contact report pair information. ">PxContactPair</a> events (see <a class="el" href="classPxSimulationEventCallback.html#a4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur. ">PxSimulationEventCallback.onContact()</a>) will look like this:</p>
<p><a class="el" href="structPxContactPair.html" title="Contact report pair information. ">PxContactPair(touch_found: s0_0, s1)</a> | <a class="el" href="structPxContactPair.html" title="Contact report pair information. ">PxContactPair(touch_lost: s0_0, s1)</a> | <a class="el" href="structPxContactPair.html" title="Contact report pair information. ">PxContactPair(touch_found: s0_1, s1)</a></p>
<p>The <a class="el" href="structPxContactPairIndex.html#ab9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at index in the repor...">index</a> of PxContactPairIndexA will point to the first entry in the <a class="el" href="structPxContactPair.html" title="Contact report pair information. ">PxContactPair</a> array, for PxContactPairIndexB, <a class="el" href="structPxContactPairIndex.html#ab9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at index in the repor...">index</a> will point to the third entry.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxContactPairHeader.html#a2a9619192f15e1a60104c90b83f67e33" title="Stream containing extra data as requested in the PxPairFlag flags of the simulation filter...">PxContactPairHeader.extraDataStream</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0aae6856f18cbe9040c586ef4852a862"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0aae6856f18cbe9040c586ef4852a862">&#9670;&nbsp;</a></span>PxContactPairIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__foundation.html#ga6a774eed3cad34b0f636332a3d28c6bb">PX_FORCE_INLINE</a> PxContactPairIndex::PxContactPairIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab9ca1f887cd9a26b50eadd4297c4d19e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9ca1f887cd9a26b50eadd4297c4d19e">&#9670;&nbsp;</a></span>index</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PxU16 PxContactPairIndex::index</td>
</tr>
</table>
</div><div class="memdoc">
<p>The next item set in the extra data stream refers to the contact pairs starting at <a class="el" href="structPxContactPairIndex.html#ab9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at index in the repor...">index</a> in the reported <a class="el" href="structPxContactPair.html" title="Contact report pair information. ">PxContactPair</a> array. </p>
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structPxContactPairIndex.html">PxContactPairIndex</a></li>
<li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
</ul>
</div>
</body>
</html>