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/classPxUserControllerHitReport.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/classPxUserControllerHitReport.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxUserControllerHitReport.html | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxUserControllerHitReport.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxUserControllerHitReport.html new file mode 100644 index 00000000..bd96e96d --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxUserControllerHitReport.html @@ -0,0 +1,166 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxUserControllerHitReport 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>PxUserControllerHitReport Class Reference<br> +<small> +[<a class="el" href="group__character.html">Character</a>]</small> +</h1><!-- doxytag: class="PxUserControllerHitReport" -->User callback class for character controller events. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxController_8h-source.html">PxController.h</a>></code> +<p> + +<p> +<a href="classPxUserControllerHitReport-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxUserControllerHitReport.html#4f12af437470d8c6dfb3bf8454f000d9">onShapeHit</a> (const <a class="el" href="structPxControllerShapeHit.html">PxControllerShapeHit</a> &hit)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when current controller hits a shape. <a href="#4f12af437470d8c6dfb3bf8454f000d9"></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="classPxUserControllerHitReport.html#b2340ac48d016da0481c6cb6efda97b9">onControllerHit</a> (const <a class="el" href="structPxControllersHit.html">PxControllersHit</a> &hit)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when current controller hits another controller. <a href="#b2340ac48d016da0481c6cb6efda97b9"></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="classPxUserControllerHitReport.html#b806ae70badbece00c364a37951cd9b1">onObstacleHit</a> (const <a class="el" href="structPxControllerObstacleHit.html">PxControllerObstacleHit</a> &hit)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when current controller hits a user-defined obstacle. <a href="#b806ae70badbece00c364a37951cd9b1"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected 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="classPxUserControllerHitReport.html#4c9fb318a01f7bc299c29d4ce8038058">~PxUserControllerHitReport</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +User callback class for character controller events. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>Character controller hit reports are only generated when move is called.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd>PxControllerDesc.callback </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="4c9fb318a01f7bc299c29d4ce8038058"></a><!-- doxytag: member="PxUserControllerHitReport::~PxUserControllerHitReport" ref="4c9fb318a01f7bc299c29d4ce8038058" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxUserControllerHitReport::~PxUserControllerHitReport </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="b2340ac48d016da0481c6cb6efda97b9"></a><!-- doxytag: member="PxUserControllerHitReport::onControllerHit" ref="b2340ac48d016da0481c6cb6efda97b9" args="(const PxControllersHit &hit)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxUserControllerHitReport::onControllerHit </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structPxControllersHit.html">PxControllersHit</a> & </td> + <td class="paramname"> <em>hit</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called when current controller hits another controller. +<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>hit</em> </td><td>Provides information about the hit.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllersHit.html" title="Describes a hit between a CCT and another CCT. Passed to onControllerHit().">PxControllersHit</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b806ae70badbece00c364a37951cd9b1"></a><!-- doxytag: member="PxUserControllerHitReport::onObstacleHit" ref="b806ae70badbece00c364a37951cd9b1" args="(const PxControllerObstacleHit &hit)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxUserControllerHitReport::onObstacleHit </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structPxControllerObstacleHit.html">PxControllerObstacleHit</a> & </td> + <td class="paramname"> <em>hit</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called when current controller hits a user-defined obstacle. +<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>hit</em> </td><td>Provides information about the hit.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerObstacleHit.html" title="Describes a hit between a CCT and a user-defined obstacle. Passed to onObstacleHit()...">PxControllerObstacleHit</a> <a class="el" href="classPxObstacleContext.html" title="Context class for obstacles.">PxObstacleContext</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="4f12af437470d8c6dfb3bf8454f000d9"></a><!-- doxytag: member="PxUserControllerHitReport::onShapeHit" ref="4f12af437470d8c6dfb3bf8454f000d9" args="(const PxControllerShapeHit &hit)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxUserControllerHitReport::onShapeHit </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structPxControllerShapeHit.html">PxControllerShapeHit</a> & </td> + <td class="paramname"> <em>hit</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called when current controller hits a shape. +<p> +This is called when the CCT moves and hits a shape. This will not be called when a moving shape hits a non-moving CCT.<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>hit</em> </td><td>Provides information about the hit.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerShapeHit.html" title="Describes a hit between a CCT and a shape. Passed to onShapeHit().">PxControllerShapeHit</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxController_8h-source.html">PxController.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> |