diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/structPxTriggerPair.html | |
| download | physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip | |
Initial commit:
PhysX 3.4.0 Update @ 21294896
APEX 1.4.0 Update @ 21275617
[CL 21300167]
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxTriggerPair.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/structPxTriggerPair.html | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxTriggerPair.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxTriggerPair.html new file mode 100644 index 00000000..40231a0c --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxTriggerPair.html @@ -0,0 +1,201 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxTriggerPair 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> + <a class="qindex" href="hierarchy.html">Class Hierarchy</a> + <a class="qindex" href="annotated.html">Compound List</a> + <a class="qindex" href="functions.html">Compound Members</a> + </center> + <hr class="second"> + </div> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>PxTriggerPair Struct Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxTriggerPair" -->Descriptor for a trigger pair. +<a href="#_details">More...</a> +<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="dynsection"> +<p><center><img src="structPxTriggerPair__coll__graph.png" border="0" usemap="#PxTriggerPair__coll__map" alt="Collaboration graph"></center> +<map name="PxTriggerPair__coll__map"> +<area shape="rect" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies..." alt="PxRigidActor" coords="24,278,107,299"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="61,179,115,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,107,153,128"><area shape="rect" href="classPxShape.html" title="Abstract class for collision shapes." alt="PxShape" coords="127,224,191,246"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,38"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxTriggerPairFlag::Enum, PxU8 \>" alt="PxFlags\< PxTriggerPairFlag::Enum, PxU8 \>" coords="276,278,540,299"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="structPxTriggerPair-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#adedcfa39f52b9e32b73d9f2096069f1">PxTriggerPair</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="classPxShape.html">PxShape</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#d9010d4ddceacd431e8733a010dee664">triggerShape</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The shape that has been marked as a trigger. <a href="#d9010d4ddceacd431e8733a010dee664"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#f4e22129ed6743a51b2ec3553e966950">triggerActor</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The actor to which triggerShape is attached. <a href="#f4e22129ed6743a51b2ec3553e966950"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxShape.html">PxShape</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#483aaaaecb45e77230879bb0b303b8df">otherShape</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The shape causing the trigger event. <a href="#483aaaaecb45e77230879bb0b303b8df"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxRigidActor.html">PxRigidActor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#d079ad0829b0e0e58a962a2167dcf566">otherActor</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The actor to which otherShape is attached. <a href="#d079ad0829b0e0e58a962a2167dcf566"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2f">PxPairFlag::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#b02c51a235d45757e48ecaad5fb7c091">status</a></td></tr> + +<tr><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="#b02c51a235d45757e48ecaad5fb7c091"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxFlags.html">PxTriggerPairFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPxTriggerPair.html#a4e5f001e8736f5033c52291486c655b">flags</a></td></tr> + +<tr><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="#a4e5f001e8736f5033c52291486c655b"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Descriptor for a trigger pair. +<p> +An array of these structs gets passed to the <a class="el" href="classPxSimulationEventCallback.html#768b2ee9fe28736da3fcdc6a0eae9733" title="This is called with the current trigger pair events.">PxSimulationEventCallback::onTrigger()</a> report.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>The shape pointers might reference deleted shapes. 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> events were requested for the pair and one of the involved shapes gets deleted. Check the <a class="el" href="structPxTriggerPair.html#a4e5f001e8736f5033c52291486c655b" 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="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSimulationEventCallback.html#768b2ee9fe28736da3fcdc6a0eae9733" title="This is called with the current trigger pair events.">PxSimulationEventCallback.onTrigger()</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="adedcfa39f52b9e32b73d9f2096069f1"></a><!-- doxytag: member="PxTriggerPair::PxTriggerPair" ref="adedcfa39f52b9e32b73d9f2096069f1" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxTriggerPair::PxTriggerPair </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </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="a4e5f001e8736f5033c52291486c655b"></a><!-- doxytag: member="PxTriggerPair::flags" ref="a4e5f001e8736f5033c52291486c655b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxFlags.html">PxTriggerPairFlags</a> <a class="el" href="structPxTriggerPair.html#a4e5f001e8736f5033c52291486c655b">PxTriggerPair::flags</a> </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><p> +<a class="anchor" name="d079ad0829b0e0e58a962a2167dcf566"></a><!-- doxytag: member="PxTriggerPair::otherActor" ref="d079ad0829b0e0e58a962a2167dcf566" args="" --> +<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="structPxTriggerPair.html#d079ad0829b0e0e58a962a2167dcf566">PxTriggerPair::otherActor</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The actor to which otherShape is attached. +<p> + +</div> +</div><p> +<a class="anchor" name="483aaaaecb45e77230879bb0b303b8df"></a><!-- doxytag: member="PxTriggerPair::otherShape" ref="483aaaaecb45e77230879bb0b303b8df" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxShape.html">PxShape</a>* <a class="el" href="structPxTriggerPair.html#483aaaaecb45e77230879bb0b303b8df">PxTriggerPair::otherShape</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The shape causing the trigger event. +<p> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000034">Deprecated:</a></b></dt><dd>(see <a class="el" href="classPxSimulationEventCallback.html#768b2ee9fe28736da3fcdc6a0eae9733" 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><p> +<a class="anchor" name="b02c51a235d45757e48ecaad5fb7c091"></a><!-- doxytag: member="PxTriggerPair::status" ref="b02c51a235d45757e48ecaad5fb7c091" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxPairFlag.html#60e71a2948b030140f840766a3f7ac2f">PxPairFlag::Enum</a> <a class="el" href="structPxTriggerPair.html#b02c51a235d45757e48ecaad5fb7c091">PxTriggerPair::status</a> </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><p> +<a class="anchor" name="f4e22129ed6743a51b2ec3553e966950"></a><!-- doxytag: member="PxTriggerPair::triggerActor" ref="f4e22129ed6743a51b2ec3553e966950" args="" --> +<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="structPxTriggerPair.html#f4e22129ed6743a51b2ec3553e966950">PxTriggerPair::triggerActor</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The actor to which triggerShape is attached. +<p> + +</div> +</div><p> +<a class="anchor" name="d9010d4ddceacd431e8733a010dee664"></a><!-- doxytag: member="PxTriggerPair::triggerShape" ref="d9010d4ddceacd431e8733a010dee664" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxShape.html">PxShape</a>* <a class="el" href="structPxTriggerPair.html#d9010d4ddceacd431e8733a010dee664">PxTriggerPair::triggerShape</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The shape that has been marked as a trigger. +<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 © 2008-2016 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> |