aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairIndex.html
blob: 891100a4329d9f92f43b67b72d87b0b3e5b52a05 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxContactPairIndex 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> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<div class="contents">
<h1>PxContactPairIndex Struct Reference<br>
<small>
[<a class="el" href="group__physics.html">Physics</a>]</small>
</h1><!-- doxytag: class="PxContactPairIndex" --><!-- doxytag: inherits="PxContactPairExtraDataItem" -->Marker for the beginning of a new item set in the extra data stream.  
<a href="#_details">More...</a>
<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="dynsection">
<p><center><img src="structPxContactPairIndex__inherit__graph.png" border="0" usemap="#PxContactPairIndex__inherit__map" alt="Inheritance graph"></center>
<map name="PxContactPairIndex__inherit__map">
<area shape="rect" href="structPxContactPairExtraDataItem.html" title="Base class for items in the extra data stream of contact pairs." alt="PxContactPairExtraDataItem" coords="7,16,177,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxContactPairIndex:</div>
<div class="dynsection">
<p><center><img src="structPxContactPairIndex__coll__graph.png" border="0" usemap="#PxContactPairIndex__coll__map" alt="Collaboration graph"></center>
<map name="PxContactPairIndex__coll__map">
<area shape="rect" href="structPxContactPairExtraDataItem.html" title="Base class for items in the extra data stream of contact pairs." alt="PxContactPairExtraDataItem" coords="7,16,177,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structPxContactPairIndex-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairIndex.html#0aae6856f18cbe9040c586ef4852a862">PxContactPairIndex</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PxU16&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairIndex.html#b9ca1f887cd9a26b50eadd4297c4d19e">index</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</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#b9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at...">index</a> in the reported <a class="el" href="structPxContactPair.html" title="Contact report pair information.">PxContactPair</a> array.  <a href="#b9ca1f887cd9a26b50eadd4297c4d19e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Marker for the beginning of a new item set in the extra data stream. 
<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>
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>
PxContactPairIndexA | PxContactPairPoseA | PxContactPairIndexB | PxContactPairPoseB<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#4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur.">PxSimulationEventCallback.onContact()</a>) will look like this:<p>
PxContactPair(touch_found: s0_0, s1) | PxContactPair(touch_lost: s0_0, s1) | PxContactPair(touch_found: s0_1, s1)<p>
The <a class="el" href="structPxContactPairIndex.html#b9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at...">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#b9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at...">index</a> will point to the third entry.<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 &amp; Destructor Documentation</h2>
<a class="anchor" name="0aae6856f18cbe9040c586ef4852a862"></a><!-- doxytag: member="PxContactPairIndex::PxContactPairIndex" ref="0aae6856f18cbe9040c586ef4852a862" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PX_FORCE_INLINE PxContactPairIndex::PxContactPairIndex           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="b9ca1f887cd9a26b50eadd4297c4d19e"></a><!-- doxytag: member="PxContactPairIndex::index" ref="b9ca1f887cd9a26b50eadd4297c4d19e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PxU16 <a class="el" href="structPxContactPairIndex.html#b9ca1f887cd9a26b50eadd4297c4d19e">PxContactPairIndex::index</a>          </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#b9ca1f887cd9a26b50eadd4297c4d19e" title="The next item set in the extra data stream refers to the contact pairs starting at...">index</a> in the reported <a class="el" href="structPxContactPair.html" title="Contact report pair information.">PxContactPair</a> array. 
<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 &copy; 2008-2018 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>