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/classPxBroadPhaseCallback.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/classPxBroadPhaseCallback.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxBroadPhaseCallback.html | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxBroadPhaseCallback.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBroadPhaseCallback.html new file mode 100644 index 00000000..f6a5ed3b --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBroadPhaseCallback.html @@ -0,0 +1,147 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBroadPhaseCallback Class 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>PxBroadPhaseCallback Class Reference<br> +<small> +[<a class="el" href="group__physics.html">Physics</a>]</small> +</h1><!-- doxytag: class="PxBroadPhaseCallback" -->Broad-phase callback to receive broad-phase related events. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxBroadPhase_8h-source.html">PxBroadPhase.h</a>></code> +<p> + +<p> +<a href="classPxBroadPhaseCallback-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBroadPhaseCallback.html#dbbd54fb4eb42348829be1aa27980005">~PxBroadPhaseCallback</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBroadPhaseCallback.html#b7aa03ff4a741400562bd5787a7aaca0">onObjectOutOfBounds</a> (<a class="el" href="classPxShape.html">PxShape</a> &shape, <a class="el" href="classPxActor.html">PxActor</a> &actor)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Out-of-bounds notification. <a href="#b7aa03ff4a741400562bd5787a7aaca0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBroadPhaseCallback.html#a5dd0f892825c46619939a11caae5620">onObjectOutOfBounds</a> (<a class="el" href="classPxAggregate.html">PxAggregate</a> &aggregate)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Out-of-bounds notification. <a href="#a5dd0f892825c46619939a11caae5620"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Broad-phase callback to receive broad-phase related events. +<p> +Each broadphase callback object is associated with a PxClientID. It is possible to register different callbacks for different clients. The callback functions are called this way:<ul> +<li>for shapes/actors, the callback assigned to the actors' clients are used</li><li>for aggregates, the callbacks assigned to clients from aggregated actors are used</li></ul> +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>SDK state should not be modified from within the callbacks. In particular objects should not be created or destroyed. If state modification is needed then the changes should be stored to a buffer and performed after the simulation step.</dd></dl> +<b>Threading:</b> It is not necessary to make this class thread safe as it will only be called in the context of the user thread.<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxSceneDesc.html" title="Descriptor class for scenes. See PxScene.">PxSceneDesc</a> <a class="el" href="classPxScene.html#c1110386fc2ffad70aa771aabc51d026" title="Sets a broad-phase user callback object.">PxScene.setBroadPhaseCallback()</a> <a class="el" href="classPxScene.html#3823d25fc80ebe53c1c02cef57115b06" title="Retrieves the PxBroadPhaseCallback pointer set with setBroadPhaseCallback().">PxScene.getBroadPhaseCallback()</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="dbbd54fb4eb42348829be1aa27980005"></a><!-- doxytag: member="PxBroadPhaseCallback::~PxBroadPhaseCallback" ref="dbbd54fb4eb42348829be1aa27980005" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxBroadPhaseCallback::~PxBroadPhaseCallback </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="a5dd0f892825c46619939a11caae5620"></a><!-- doxytag: member="PxBroadPhaseCallback::onObjectOutOfBounds" ref="a5dd0f892825c46619939a11caae5620" args="(PxAggregate &aggregate)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxBroadPhaseCallback::onObjectOutOfBounds </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxAggregate.html">PxAggregate</a> & </td> + <td class="paramname"> <em>aggregate</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Out-of-bounds notification. +<p> +This function is called when an aggregate leaves the broad-phase.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>aggregate</em> </td><td>Aggregate that left the broad-phase bounds </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="b7aa03ff4a741400562bd5787a7aaca0"></a><!-- doxytag: member="PxBroadPhaseCallback::onObjectOutOfBounds" ref="b7aa03ff4a741400562bd5787a7aaca0" args="(PxShape &shape, PxActor &actor)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxBroadPhaseCallback::onObjectOutOfBounds </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxShape.html">PxShape</a> & </td> + <td class="paramname"> <em>shape</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classPxActor.html">PxActor</a> & </td> + <td class="paramname"> <em>actor</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Out-of-bounds notification. +<p> +This function is called when an object leaves the broad-phase.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>shape</em> </td><td>Shape that left the broad-phase bounds </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>actor</em> </td><td>Owner actor </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxBroadPhase_8h-source.html">PxBroadPhase.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> |