287 lines
18 KiB
HTML
287 lines
18 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>PxContactPairHeader 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&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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('structPxContactPairHeader.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> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="structPxContactPairHeader-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PxContactPairHeader Struct Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An Instance of this class is passed to <a class="el" href="classPxSimulationEventCallback.html#a4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur. ">PxSimulationEventCallback.onContact()</a>.
|
|
<a href="structPxContactPairHeader.html#details">More...</a></p>
|
|
|
|
<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="dyncontent">
|
|
<div class="center"><img src="structPxContactPairHeader__coll__graph.png" border="0" usemap="#PxContactPairHeader_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="PxContactPairHeader_coll__map" id="PxContactPairHeader_coll__map">
|
|
<area shape="rect" id="node2" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies in the physics SD..." alt="" coords="741,177,839,204"/>
|
|
<area shape="rect" id="node3" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK. " alt="" coords="462,188,531,215"/>
|
|
<area shape="rect" id="node4" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. " alt="" coords="284,79,352,105"/>
|
|
<area shape="rect" id="node9" href="classPxShape.html" title="Abstract class for collision shapes. " alt="" coords="459,5,534,32"/>
|
|
<area shape="rect" id="node5" href="classPxFlags.html" title="PxFlags\< PxBaseFlag\l::Enum, PxU16 \>" alt="" coords="5,71,159,113"/>
|
|
<area shape="rect" id="node6" href="structPxContactPair.html" title="Contact report pair information. " alt="" coords="737,97,843,124"/>
|
|
<area shape="rect" id="node7" href="classPxFlags.html" title="PxFlags\< PxContactPairFlag\l::Enum, PxU16 \>" alt="" coords="401,57,592,98"/>
|
|
<area shape="rect" id="node8" href="classPxFlags.html" title="PxFlags\< PxPairFlag\l::Enum, PxU16 \>" alt="" coords="423,122,570,163"/>
|
|
<area shape="rect" id="node10" href="classPxFlags.html" title="PxFlags\< PxContactPairHeader\lFlag::Enum, PxU16 \>" alt="" coords="687,229,893,270"/>
|
|
</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:ad5ae557cec81ae4c92b0e987b682af7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#ad5ae557cec81ae4c92b0e987b682af7d">PxContactPairHeader</a> ()</td></tr>
|
|
<tr class="separator:ad5ae557cec81ae4c92b0e987b682af7d"><td class="memSeparator" colspan="2"> </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:ae3a7e00ec5edf59b946196becc840182"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#ae3a7e00ec5edf59b946196becc840182">actors</a> [2]</td></tr>
|
|
<tr class="memdesc:ae3a7e00ec5edf59b946196becc840182"><td class="mdescLeft"> </td><td class="mdescRight">The two actors of the notification shape pairs. <a href="#ae3a7e00ec5edf59b946196becc840182">More...</a><br /></td></tr>
|
|
<tr class="separator:ae3a7e00ec5edf59b946196becc840182"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a9619192f15e1a60104c90b83f67e33"><td class="memItemLeft" align="right" valign="top">const PxU8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#a2a9619192f15e1a60104c90b83f67e33">extraDataStream</a></td></tr>
|
|
<tr class="memdesc:a2a9619192f15e1a60104c90b83f67e33"><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="#a2a9619192f15e1a60104c90b83f67e33">More...</a><br /></td></tr>
|
|
<tr class="separator:a2a9619192f15e1a60104c90b83f67e33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab43e1aa99a8399533f57725d50f002d4"><td class="memItemLeft" align="right" valign="top">PxU16 </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#ab43e1aa99a8399533f57725d50f002d4">extraDataStreamSize</a></td></tr>
|
|
<tr class="memdesc:ab43e1aa99a8399533f57725d50f002d4"><td class="mdescLeft"> </td><td class="mdescRight">Size of the extra data stream [bytes]. <a href="#ab43e1aa99a8399533f57725d50f002d4">More...</a><br /></td></tr>
|
|
<tr class="separator:ab43e1aa99a8399533f57725d50f002d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff053696e65138d0d5ca6625350e1011"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__physics.html#gaa4275c674f70ce3f0be586339eb0b045">PxContactPairHeaderFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#aff053696e65138d0d5ca6625350e1011">flags</a></td></tr>
|
|
<tr class="memdesc:aff053696e65138d0d5ca6625350e1011"><td class="mdescLeft"> </td><td class="mdescRight">Additional information on the contact report pair. <a href="#aff053696e65138d0d5ca6625350e1011">More...</a><br /></td></tr>
|
|
<tr class="separator:aff053696e65138d0d5ca6625350e1011"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a747c8a693f1a7100b0da1e8b431fbb36"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="structPxContactPair.html">PxContactPair</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#a747c8a693f1a7100b0da1e8b431fbb36">pairs</a></td></tr>
|
|
<tr class="memdesc:a747c8a693f1a7100b0da1e8b431fbb36"><td class="mdescLeft"> </td><td class="mdescRight">pointer to the contact pairs <a href="#a747c8a693f1a7100b0da1e8b431fbb36">More...</a><br /></td></tr>
|
|
<tr class="separator:a747c8a693f1a7100b0da1e8b431fbb36"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4b544da63d06205662034a5ebaf1e9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxContactPairHeader.html#aa4b544da63d06205662034a5ebaf1e9f">nbPairs</a></td></tr>
|
|
<tr class="memdesc:aa4b544da63d06205662034a5ebaf1e9f"><td class="mdescLeft"> </td><td class="mdescRight">number of contact pairs <a href="#aa4b544da63d06205662034a5ebaf1e9f">More...</a><br /></td></tr>
|
|
<tr class="separator:aa4b544da63d06205662034a5ebaf1e9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>An Instance of this class is passed to <a class="el" href="classPxSimulationEventCallback.html#a4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur. ">PxSimulationEventCallback.onContact()</a>. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSimulationEventCallback.html#a4dc1da28643ccf9f77c8432b5eb2fd32" title="This is called when certain contact events occur. ">PxSimulationEventCallback.onContact()</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ad5ae557cec81ae4c92b0e987b682af7d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5ae557cec81ae4c92b0e987b682af7d">◆ </a></span>PxContactPairHeader()</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#gacb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxContactPairHeader::PxContactPairHeader </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="ae3a7e00ec5edf59b946196becc840182"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3a7e00ec5edf59b946196becc840182">◆ </a></span>actors</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPxRigidActor.html">PxRigidActor</a>* PxContactPairHeader::actors[2]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The two actors of the notification shape pairs. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>The actor pointers might reference deleted actors. This will be the case if <a class="el" href="structPxPairFlag.html#a60e71a2948b030140f840766a3f7ac2fa201281be698379417370bf7b0aeeb78e" title="Call contact report callback or trigger callback when this collision pair stops to be in contact...">PxPairFlag::eNOTIFY_TOUCH_LOST</a> or <a class="el" href="structPxPairFlag.html#a60e71a2948b030140f840766a3f7ac2fa517ae07b413b27ad008f766170051ae6" title="Call contact report callback when the contact force between the actors of this collision pair falls b...">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#aff053696e65138d0d5ca6625350e1011" 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="section see"><dt>See also</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>
|
|
<a id="a2a9619192f15e1a60104c90b83f67e33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a9619192f15e1a60104c90b83f67e33">◆ </a></span>extraDataStream</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const PxU8* PxContactPairHeader::extraDataStream</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>
|
|
<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#a60e71a2948b030140f840766a3f7ac2fa9502180b279a27e884468c3cb7c64544" 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="section see"><dt>See also</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>
|
|
<a id="ab43e1aa99a8399533f57725d50f002d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab43e1aa99a8399533f57725d50f002d4">◆ </a></span>extraDataStreamSize</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PxU16 PxContactPairHeader::extraDataStreamSize</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Size of the extra data stream [bytes]. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff053696e65138d0d5ca6625350e1011"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff053696e65138d0d5ca6625350e1011">◆ </a></span>flags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__physics.html#gaa4275c674f70ce3f0be586339eb0b045">PxContactPairHeaderFlags</a> PxContactPairHeader::flags</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Additional information on the contact report pair. </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxContactPairHeaderFlag.html" title="Collection of flags providing information on contact report pairs. ">PxContactPairHeaderFlag</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa4b544da63d06205662034a5ebaf1e9f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4b544da63d06205662034a5ebaf1e9f">◆ </a></span>nbPairs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__foundation.html#gacce5749db3dcfb916e98c253374264ed">PxU32</a> PxContactPairHeader::nbPairs</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>number of contact pairs </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a747c8a693f1a7100b0da1e8b431fbb36"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a747c8a693f1a7100b0da1e8b431fbb36">◆ </a></span>pairs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const struct <a class="el" href="structPxContactPair.html">PxContactPair</a>* PxContactPairHeader::pairs</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pointer to the contact pairs </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="structPxContactPairHeader.html">PxContactPairHeader</a></li>
|
|
<li class="footer">Copyright © 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>
|