aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/structPxContactPairHeader.html
blob: 24860b5f1f92519ab7287fa13018c9a9b114fe03 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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> &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>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 &lt;<a class="el" href="PxSimulationEventCallback_8h-source.html">PxSimulationEventCallback.h</a>&gt;</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\&lt; PxBaseFlag::Enum, PxU16 \&gt;" alt="PxFlags\&lt; PxBaseFlag::Enum, PxU16 \&gt;" 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\&lt; PxContactPairFlag::Enum, PxU16 \&gt;" alt="PxFlags\&lt; PxContactPairFlag::Enum, PxU16 \&gt;" coords="497,86,769,107"><area shape="rect" href="classPxFlags.html" title="PxFlags\&lt; PxPairFlag::Enum, PxU16 \&gt;" alt="PxFlags\&lt; PxPairFlag::Enum, PxU16 \&gt;" coords="519,155,748,176"><area shape="rect" href="classPxFlags.html" title="PxFlags\&lt; PxContactPairHeaderFlag::Enum, PxU16 \&gt;" alt="PxFlags\&lt; PxContactPairHeaderFlag::Enum, PxU16 \&gt;" 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&nbsp;</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> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#e3a7e00ec5edf59b946196becc840182">actors</a> [2]</td></tr>

<tr><td class="mdescLeft">&nbsp;</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 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#2a9619192f15e1a60104c90b83f67e33">extraDataStream</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#b43e1aa99a8399533f57725d50f002d4">extraDataStreamSize</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#ff053696e65138d0d5ca6625350e1011">flags</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</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> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#e1b3429e7d69fcba36d264087e03c12b">pairs</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#a4b544da63d06205662034a5ebaf1e9f">nbPairs</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</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 &amp; 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>&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="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 &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>