282 lines
17 KiB
HTML
282 lines
17 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>PxTriggerPair 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('structPxTriggerPair.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="structPxTriggerPair-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PxTriggerPair Struct Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Descriptor for a trigger pair.
|
|
<a href="structPxTriggerPair.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 PxTriggerPair:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structPxTriggerPair__coll__graph.png" border="0" usemap="#PxTriggerPair_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="PxTriggerPair_coll__map" id="PxTriggerPair_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="5,294,104,321"/>
|
|
<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="35,185,104,212"/>
|
|
<area shape="rect" id="node4" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection. " alt="" coords="82,109,150,136"/>
|
|
<area shape="rect" id="node7" href="classPxShape.html" title="Abstract class for collision shapes. " alt="" coords="112,236,187,263"/>
|
|
<area shape="rect" id="node5" href="classPxFlags.html" title="PxFlags\< PxBaseFlag\l::Enum, PxU16 \>" alt="" coords="39,5,193,47"/>
|
|
<area shape="rect" id="node6" href="classPxFlags.html" title="PxFlags\< PxTriggerPairFlag\l::Enum, PxU8 \>" alt="" coords="250,287,435,328"/>
|
|
</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:aadedcfa39f52b9e32b73d9f2096069f1"><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="structPxTriggerPair.html#aadedcfa39f52b9e32b73d9f2096069f1">PxTriggerPair</a> ()</td></tr>
|
|
<tr class="separator:aadedcfa39f52b9e32b73d9f2096069f1"><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:ad9010d4ddceacd431e8733a010dee664"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPxShape.html">PxShape</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#ad9010d4ddceacd431e8733a010dee664">triggerShape</a></td></tr>
|
|
<tr class="memdesc:ad9010d4ddceacd431e8733a010dee664"><td class="mdescLeft"> </td><td class="mdescRight">The shape that has been marked as a trigger. <a href="#ad9010d4ddceacd431e8733a010dee664">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9010d4ddceacd431e8733a010dee664"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4e22129ed6743a51b2ec3553e966950"><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="structPxTriggerPair.html#af4e22129ed6743a51b2ec3553e966950">triggerActor</a></td></tr>
|
|
<tr class="memdesc:af4e22129ed6743a51b2ec3553e966950"><td class="mdescLeft"> </td><td class="mdescRight">The actor to which triggerShape is attached. <a href="#af4e22129ed6743a51b2ec3553e966950">More...</a><br /></td></tr>
|
|
<tr class="separator:af4e22129ed6743a51b2ec3553e966950"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a483aaaaecb45e77230879bb0b303b8df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPxShape.html">PxShape</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#a483aaaaecb45e77230879bb0b303b8df">otherShape</a></td></tr>
|
|
<tr class="memdesc:a483aaaaecb45e77230879bb0b303b8df"><td class="mdescLeft"> </td><td class="mdescRight">The shape causing the trigger event. <a href="#a483aaaaecb45e77230879bb0b303b8df">More...</a><br /></td></tr>
|
|
<tr class="separator:a483aaaaecb45e77230879bb0b303b8df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad079ad0829b0e0e58a962a2167dcf566"><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="structPxTriggerPair.html#ad079ad0829b0e0e58a962a2167dcf566">otherActor</a></td></tr>
|
|
<tr class="memdesc:ad079ad0829b0e0e58a962a2167dcf566"><td class="mdescLeft"> </td><td class="mdescRight">The actor to which otherShape is attached. <a href="#ad079ad0829b0e0e58a962a2167dcf566">More...</a><br /></td></tr>
|
|
<tr class="separator:ad079ad0829b0e0e58a962a2167dcf566"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab02c51a235d45757e48ecaad5fb7c091"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPxPairFlag.html#a60e71a2948b030140f840766a3f7ac2f">PxPairFlag::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#ab02c51a235d45757e48ecaad5fb7c091">status</a></td></tr>
|
|
<tr class="memdesc:ab02c51a235d45757e48ecaad5fb7c091"><td class="mdescLeft"> </td><td class="mdescRight">Type of trigger event (eNOTIFY_TOUCH_FOUND or eNOTIFY_TOUCH_LOST). eNOTIFY_TOUCH_PERSISTS events are not supported. <a href="#ab02c51a235d45757e48ecaad5fb7c091">More...</a><br /></td></tr>
|
|
<tr class="separator:ab02c51a235d45757e48ecaad5fb7c091"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4e5f001e8736f5033c52291486c655b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__physics.html#gae5d4ef1b3321702c4431da8fe72b8f7f">PxTriggerPairFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#aa4e5f001e8736f5033c52291486c655b">flags</a></td></tr>
|
|
<tr class="memdesc:aa4e5f001e8736f5033c52291486c655b"><td class="mdescLeft"> </td><td class="mdescRight">Additional information on the pair (see <a class="el" href="structPxTriggerPairFlag.html" title="Collection of flags providing information on trigger report pairs. ">PxTriggerPairFlag</a>) <a href="#aa4e5f001e8736f5033c52291486c655b">More...</a><br /></td></tr>
|
|
<tr class="separator:aa4e5f001e8736f5033c52291486c655b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Descriptor for a trigger pair. </p>
|
|
<p>An array of these structs gets passed to the <a class="el" href="classPxSimulationEventCallback.html#a768b2ee9fe28736da3fcdc6a0eae9733" title="This is called with the current trigger pair events. ">PxSimulationEventCallback::onTrigger()</a> report.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The shape pointers might reference deleted shapes. 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> events were requested for the pair and one of the involved shapes gets deleted. Check the <a class="el" href="structPxTriggerPair.html#aa4e5f001e8736f5033c52291486c655b" title="Additional information on the pair (see PxTriggerPairFlag) ">flags</a> member to see whether that is the case. Do not dereference a pointer to a deleted shape. The pointer to a deleted shape 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="classPxSimulationEventCallback.html#a768b2ee9fe28736da3fcdc6a0eae9733" title="This is called with the current trigger pair events. ">PxSimulationEventCallback.onTrigger()</a> </dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aadedcfa39f52b9e32b73d9f2096069f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aadedcfa39f52b9e32b73d9f2096069f1">◆ </a></span>PxTriggerPair()</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> PxTriggerPair::PxTriggerPair </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="aa4e5f001e8736f5033c52291486c655b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4e5f001e8736f5033c52291486c655b">◆ </a></span>flags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__physics.html#gae5d4ef1b3321702c4431da8fe72b8f7f">PxTriggerPairFlags</a> PxTriggerPair::flags</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Additional information on the pair (see <a class="el" href="structPxTriggerPairFlag.html" title="Collection of flags providing information on trigger report pairs. ">PxTriggerPairFlag</a>) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad079ad0829b0e0e58a962a2167dcf566"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad079ad0829b0e0e58a962a2167dcf566">◆ </a></span>otherActor</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPxRigidActor.html">PxRigidActor</a>* PxTriggerPair::otherActor</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The actor to which otherShape is attached. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a483aaaaecb45e77230879bb0b303b8df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a483aaaaecb45e77230879bb0b303b8df">◆ </a></span>otherShape</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPxShape.html">PxShape</a>* PxTriggerPair::otherShape</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The shape causing the trigger event. </p>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>(see <a class="el" href="classPxSimulationEventCallback.html#a768b2ee9fe28736da3fcdc6a0eae9733" title="This is called with the current trigger pair events. ">PxSimulationEventCallback::onTrigger()</a>) If collision between trigger shapes is enabled, then this member might point to a trigger shape as well. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab02c51a235d45757e48ecaad5fb7c091"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab02c51a235d45757e48ecaad5fb7c091">◆ </a></span>status</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structPxPairFlag.html#a60e71a2948b030140f840766a3f7ac2f">PxPairFlag::Enum</a> PxTriggerPair::status</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Type of trigger event (eNOTIFY_TOUCH_FOUND or eNOTIFY_TOUCH_LOST). eNOTIFY_TOUCH_PERSISTS events are not supported. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af4e22129ed6743a51b2ec3553e966950"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af4e22129ed6743a51b2ec3553e966950">◆ </a></span>triggerActor</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPxRigidActor.html">PxRigidActor</a>* PxTriggerPair::triggerActor</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The actor to which triggerShape is attached. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad9010d4ddceacd431e8733a010dee664"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9010d4ddceacd431e8733a010dee664">◆ </a></span>triggerShape</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classPxShape.html">PxShape</a>* PxTriggerPair::triggerShape</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The shape that has been marked as a trigger. </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="structPxTriggerPair.html">PxTriggerPair</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>
|