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/classPxControllerBehaviorCallback.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/classPxControllerBehaviorCallback.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxControllerBehaviorCallback.html | 183 |
1 files changed, 183 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxControllerBehaviorCallback.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxControllerBehaviorCallback.html new file mode 100644 index 00000000..24203eef --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxControllerBehaviorCallback.html @@ -0,0 +1,183 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxControllerBehaviorCallback 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>PxControllerBehaviorCallback Class Reference<br> +<small> +[<a class="el" href="group__character.html">Character</a>]</small> +</h1><!-- doxytag: class="PxControllerBehaviorCallback" -->User behavior callback. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxControllerBehavior_8h-source.html">PxControllerBehavior.h</a>></code> +<p> + +<p> +<a href="classPxControllerBehaviorCallback-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 <a class="el" href="classPxFlags.html">PxControllerBehaviorFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerBehaviorCallback.html#f1cac5db44edb432053ae94b141a4150">getBehaviorFlags</a> (const <a class="el" href="classPxShape.html">PxShape</a> &shape, const <a class="el" href="classPxActor.html">PxActor</a> &actor)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve behavior flags for a shape. <a href="#f1cac5db44edb432053ae94b141a4150"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxControllerBehaviorFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerBehaviorCallback.html#79b661daa722e20eca9baa9a7b9745e9">getBehaviorFlags</a> (const <a class="el" href="classPxController.html">PxController</a> &controller)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve behavior flags for a controller. <a href="#79b661daa722e20eca9baa9a7b9745e9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxFlags.html">PxControllerBehaviorFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxControllerBehaviorCallback.html#21859ff2cacd3d1546e4d191493a6b39">getBehaviorFlags</a> (const <a class="el" href="classPxObstacle.html">PxObstacle</a> &obstacle)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve behavior flags for an obstacle. <a href="#21859ff2cacd3d1546e4d191493a6b39"></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="classPxControllerBehaviorCallback.html#435c808998d0ddb0ee20988a6542d570">~PxControllerBehaviorCallback</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +User behavior callback. +<p> +This behavior callback is called to customize the controller's behavior w.r.t. touched shapes. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="435c808998d0ddb0ee20988a6542d570"></a><!-- doxytag: member="PxControllerBehaviorCallback::~PxControllerBehaviorCallback" ref="435c808998d0ddb0ee20988a6542d570" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxControllerBehaviorCallback::~PxControllerBehaviorCallback </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="21859ff2cacd3d1546e4d191493a6b39"></a><!-- doxytag: member="PxControllerBehaviorCallback::getBehaviorFlags" ref="21859ff2cacd3d1546e4d191493a6b39" args="(const PxObstacle &obstacle)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxControllerBehaviorFlags</a> PxControllerBehaviorCallback::getBehaviorFlags </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxObstacle.html">PxObstacle</a> & </td> + <td class="paramname"> <em>obstacle</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieve behavior flags for an obstacle. +<p> +When the CCT touches an obstacle, the CCT's behavior w.r.t. this obstacle can be customized by users. This function retrieves the desired <a class="el" href="structPxControllerBehaviorFlag.html" title="specifies controller behavior">PxControllerBehaviorFlag</a> flags capturing the desired behavior.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>See comments about deprecated functions at the start of this class</dd></dl> +<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>obstacle</em> </td><td>The obstacle the CCT is currently touching</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Desired behavior flags for the given obstacle</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerBehaviorFlag.html" title="specifies controller behavior">PxControllerBehaviorFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="79b661daa722e20eca9baa9a7b9745e9"></a><!-- doxytag: member="PxControllerBehaviorCallback::getBehaviorFlags" ref="79b661daa722e20eca9baa9a7b9745e9" args="(const PxController &controller)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxControllerBehaviorFlags</a> PxControllerBehaviorCallback::getBehaviorFlags </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxController.html">PxController</a> & </td> + <td class="paramname"> <em>controller</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieve behavior flags for a controller. +<p> +When the CCT touches a controller, the CCT's behavior w.r.t. this controller can be customized by users. This function retrieves the desired <a class="el" href="structPxControllerBehaviorFlag.html" title="specifies controller behavior">PxControllerBehaviorFlag</a> flags capturing the desired behavior.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>The flag <a class="el" href="structPxControllerBehaviorFlag.html#a8d6dfaac2847892e8c5b76eb4d1d55bff9a861db9c1c8457b1aa0ea220eafbc" title="Controller can ride on touched object (i.e. when this touched object is moving horizontally)...">PxControllerBehaviorFlag::eCCT_CAN_RIDE_ON_OBJECT</a> is not supported. <p> +See comments about deprecated functions at the start of this class</dd></dl> +<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>controller</em> </td><td>The controller the CCT is currently touching</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Desired behavior flags for the given controller</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerBehaviorFlag.html" title="specifies controller behavior">PxControllerBehaviorFlag</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f1cac5db44edb432053ae94b141a4150"></a><!-- doxytag: member="PxControllerBehaviorCallback::getBehaviorFlags" ref="f1cac5db44edb432053ae94b141a4150" args="(const PxShape &shape, const PxActor &actor)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxFlags.html">PxControllerBehaviorFlags</a> PxControllerBehaviorCallback::getBehaviorFlags </td> + <td>(</td> + <td class="paramtype">const <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">const <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> +Retrieve behavior flags for a shape. +<p> +When the CCT touches a shape, the CCT's behavior w.r.t. this shape can be customized by users. This function retrieves the desired <a class="el" href="structPxControllerBehaviorFlag.html" title="specifies controller behavior">PxControllerBehaviorFlag</a> flags capturing the desired behavior.<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>See comments about deprecated functions at the start of this class</dd></dl> +<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>The shape the CCT is currently touching </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>actor</em> </td><td>The actor owning the shape</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Desired behavior flags for the given shape</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxControllerBehaviorFlag.html" title="specifies controller behavior">PxControllerBehaviorFlag</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxControllerBehavior_8h-source.html">PxControllerBehavior.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> |