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/classPxCapsuleController.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/classPxCapsuleController.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleController.html | 290 |
1 files changed, 290 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleController.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleController.html new file mode 100644 index 00000000..6963cd57 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleController.html @@ -0,0 +1,290 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxCapsuleController 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>PxCapsuleController Class Reference<br> +<small> +[<a class="el" href="group__character.html">Character</a>]</small> +</h1><!-- doxytag: class="PxCapsuleController" --><!-- doxytag: inherits="PxController" -->A capsule character controller. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxCapsuleController_8h-source.html">PxCapsuleController.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxCapsuleController:</div> +<div class="dynsection"> +<p><center><img src="classPxCapsuleController__inherit__graph.png" border="0" usemap="#PxCapsuleController__inherit__map" alt="Inheritance graph"></center> +<map name="PxCapsuleController__inherit__map"> +<area shape="rect" href="classPxController.html" title="Base class for character controllers." alt="PxController" coords="31,16,113,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxCapsuleController:</div> +<div class="dynsection"> +<p><center><img src="classPxCapsuleController__coll__graph.png" border="0" usemap="#PxCapsuleController__coll__map" alt="Collaboration graph"></center> +<map name="PxCapsuleController__coll__map"> +<area shape="rect" href="classPxController.html" title="Base class for character controllers." alt="PxController" coords="31,16,113,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxCapsuleController-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 PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#8c361593760ea09b0ae84ab414520ed1">getRadius</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets controller's radius. <a href="#8c361593760ea09b0ae84ab414520ed1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#a568af92bc897e9242c063d50c71cfd2">setRadius</a> (PxF32 radius)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets controller's radius. <a href="#a568af92bc897e9242c063d50c71cfd2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#9adfe5950e68450982a07a89b5b0e8ed">getHeight</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets controller's height. <a href="#9adfe5950e68450982a07a89b5b0e8ed"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#8068e1a64b40a6c6a96bd30ba1db0883">setHeight</a> (PxF32 height)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Resets controller's height. <a href="#8068e1a64b40a6c6a96bd30ba1db0883"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxCapsuleClimbingMode.html#a5842460fe36a16e5f1f5b1383db9ef5">PxCapsuleClimbingMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#68225dcdb5577d623a0fa5250de40f0b">getClimbingMode</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets controller's climbing mode. <a href="#68225dcdb5577d623a0fa5250de40f0b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#256d6b281406c5bd1fa30dbc99e5a2df">setClimbingMode</a> (<a class="el" href="structPxCapsuleClimbingMode.html#a5842460fe36a16e5f1f5b1383db9ef5">PxCapsuleClimbingMode::Enum</a> mode)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets controller's climbing mode. <a href="#256d6b281406c5bd1fa30dbc99e5a2df"></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">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#600fba0f4d5bc98c70e45c162f0b6dd6">PxCapsuleController</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleController.html#1f391f475b656f082dbf618d549aef61">~PxCapsuleController</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A capsule character controller. +<p> +The capsule is defined as a position, a vertical height, and a radius. The height is the distance between the two sphere centers at the end of the capsule. In other words:<p> +p = pos (returned by controller)<br> + h = height<br> + r = radius<br> +<p> +p = center of capsule<br> + top sphere center = p.y + h*0.5<br> + bottom sphere center = p.y - h*0.5<br> + top capsule point = p.y + h*0.5 + r<br> + bottom capsule point = p.y - h*0.5 - r<br> + <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="600fba0f4d5bc98c70e45c162f0b6dd6"></a><!-- doxytag: member="PxCapsuleController::PxCapsuleController" ref="600fba0f4d5bc98c70e45c162f0b6dd6" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxCapsuleController::PxCapsuleController </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [inline, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="1f391f475b656f082dbf618d549aef61"></a><!-- doxytag: member="PxCapsuleController::~PxCapsuleController" ref="1f391f475b656f082dbf618d549aef61" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxCapsuleController::~PxCapsuleController </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="68225dcdb5577d623a0fa5250de40f0b"></a><!-- doxytag: member="PxCapsuleController::getClimbingMode" ref="68225dcdb5577d623a0fa5250de40f0b" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="structPxCapsuleClimbingMode.html#a5842460fe36a16e5f1f5b1383db9ef5">PxCapsuleClimbingMode::Enum</a> PxCapsuleController::getClimbingMode </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gets controller's climbing mode. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The capsule controller's climbing mode.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleControllerDesc.html#89888e84bf3091c6c3e7818732864674" title="The climbing mode.">PxCapsuleControllerDesc.climbingMode</a> <a class="el" href="classPxCapsuleController.html#256d6b281406c5bd1fa30dbc99e5a2df" title="Sets controller's climbing mode.">setClimbingMode()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9adfe5950e68450982a07a89b5b0e8ed"></a><!-- doxytag: member="PxCapsuleController::getHeight" ref="9adfe5950e68450982a07a89b5b0e8ed" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxF32 PxCapsuleController::getHeight </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gets controller's height. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The height of the capsule controller.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleControllerDesc.html#00dcfa7bd1c529bf745fdf8849746a97" title="The height of the controller.">PxCapsuleControllerDesc.height</a> <a class="el" href="classPxCapsuleController.html#8068e1a64b40a6c6a96bd30ba1db0883" title="Resets controller's height.">setHeight()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8c361593760ea09b0ae84ab414520ed1"></a><!-- doxytag: member="PxCapsuleController::getRadius" ref="8c361593760ea09b0ae84ab414520ed1" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxF32 PxCapsuleController::getRadius </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Gets controller's radius. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The radius of the controller.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleControllerDesc.html#a54d06eec5b469d6342e8f26535e8160" title="The radius of the capsule.">PxCapsuleControllerDesc.radius</a> <a class="el" href="classPxCapsuleController.html#a568af92bc897e9242c063d50c71cfd2" title="Sets controller's radius.">setRadius()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="256d6b281406c5bd1fa30dbc99e5a2df"></a><!-- doxytag: member="PxCapsuleController::setClimbingMode" ref="256d6b281406c5bd1fa30dbc99e5a2df" args="(PxCapsuleClimbingMode::Enum mode)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxCapsuleController::setClimbingMode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxCapsuleClimbingMode.html#a5842460fe36a16e5f1f5b1383db9ef5">PxCapsuleClimbingMode::Enum</a> </td> + <td class="paramname"> <em>mode</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets controller's climbing mode. +<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>mode</em> </td><td>The capsule controller's climbing mode.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleControllerDesc.html#89888e84bf3091c6c3e7818732864674" title="The climbing mode.">PxCapsuleControllerDesc.climbingMode</a> <a class="el" href="classPxCapsuleController.html#68225dcdb5577d623a0fa5250de40f0b" title="Gets controller's climbing mode.">getClimbingMode()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8068e1a64b40a6c6a96bd30ba1db0883"></a><!-- doxytag: member="PxCapsuleController::setHeight" ref="8068e1a64b40a6c6a96bd30ba1db0883" args="(PxF32 height)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxCapsuleController::setHeight </td> + <td>(</td> + <td class="paramtype">PxF32 </td> + <td class="paramname"> <em>height</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Resets controller's height. +<p> +<dl class="warning" compact><dt><b>Warning:</b></dt><dd>this doesn't check for collisions.</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>height</em> </td><td>The new height for the controller. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Currently always true.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleControllerDesc.html#00dcfa7bd1c529bf745fdf8849746a97" title="The height of the controller.">PxCapsuleControllerDesc.height</a> <a class="el" href="classPxCapsuleController.html#9adfe5950e68450982a07a89b5b0e8ed" title="Gets controller's height.">getHeight()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a568af92bc897e9242c063d50c71cfd2"></a><!-- doxytag: member="PxCapsuleController::setRadius" ref="a568af92bc897e9242c063d50c71cfd2" args="(PxF32 radius)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxCapsuleController::setRadius </td> + <td>(</td> + <td class="paramtype">PxF32 </td> + <td class="paramname"> <em>radius</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets controller's radius. +<p> +<dl class="warning" compact><dt><b>Warning:</b></dt><dd>this doesn't check for collisions.</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>radius</em> </td><td>The new radius for the controller. </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Currently always true.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleControllerDesc.html#a54d06eec5b469d6342e8f26535e8160" title="The radius of the capsule.">PxCapsuleControllerDesc.radius</a> <a class="el" href="classPxCapsuleController.html#8c361593760ea09b0ae84ab414520ed1" title="Gets controller's radius.">getRadius()</a> </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxCapsuleController_8h-source.html">PxCapsuleController.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> |