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/classPxCapsuleControllerDesc.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/classPxCapsuleControllerDesc.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleControllerDesc.html | 175 |
1 files changed, 175 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleControllerDesc.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleControllerDesc.html new file mode 100644 index 00000000..8c0feb90 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxCapsuleControllerDesc.html @@ -0,0 +1,175 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxCapsuleControllerDesc 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>PxCapsuleControllerDesc Class Reference<br> +<small> +[<a class="el" href="group__character.html">Character</a>]</small> +</h1><!-- doxytag: class="PxCapsuleControllerDesc" --><!-- doxytag: inherits="PxControllerDesc" -->A descriptor for 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 PxCapsuleControllerDesc:</div> +<div class="dynsection"> +<p><center><img src="classPxCapsuleControllerDesc__inherit__graph.png" border="0" usemap="#PxCapsuleControllerDesc__inherit__map" alt="Inheritance graph"></center> +<map name="PxCapsuleControllerDesc__inherit__map"> +<area shape="rect" href="classPxControllerDesc.html" title="Descriptor class for a character controller." alt="PxControllerDesc" coords="31,16,143,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxCapsuleControllerDesc:</div> +<div class="dynsection"> +<p><center><img src="classPxCapsuleControllerDesc__coll__graph.png" border="0" usemap="#PxCapsuleControllerDesc__coll__map" alt="Collaboration graph"></center> +<map name="PxCapsuleControllerDesc__coll__map"> +<area shape="rect" href="classPxControllerDesc.html" title="Descriptor class for a character controller." alt="PxControllerDesc" coords="839,155,951,176"><area shape="rect" href="structPxExtendedVec3.html" title="PxExtendedVec3" alt="PxExtendedVec3" coords="535,16,644,38"><area shape="rect" href="classPxMaterial.html" title="Material class to represent a set of surface properties." alt="PxMaterial" coords="553,86,625,107"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="389,86,445,107"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="17,86,255,107"><area shape="rect" href="classPxControllerBehaviorCallback.html" title="User behavior callback." alt="PxControllerBehaviorCallback" coords="499,155,680,176"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="563,224,616,246"><area shape="rect" href="classPxUserControllerHitReport.html" title="User callback class for character controller events." alt="PxUserControllerHitReport" coords="508,294,671,315"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxCapsuleControllerDesc-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="group__character.html#g9a157f74e3a2d7c0756bd527ca69d387">PxCapsuleControllerDesc</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor sets to default. <a href="group__character.html#g9a157f74e3a2d7c0756bd527ca69d387"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleControllerDesc.html#bb004bea1a109a1d77a3b9d53dfe8328">~PxCapsuleControllerDesc</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#g030da33b9be17c7cd67c6be5904d4860">PxCapsuleControllerDesc</a> (const <a class="el" href="classPxCapsuleControllerDesc.html">PxCapsuleControllerDesc</a> &)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor. <a href="group__character.html#g030da33b9be17c7cd67c6be5904d4860"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE <a class="el" href="classPxCapsuleControllerDesc.html">PxCapsuleControllerDesc</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#g81a73ed06438569e730320f322376ae8">operator=</a> (const <a class="el" href="classPxCapsuleControllerDesc.html">PxCapsuleControllerDesc</a> &)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">assignment operator. <a href="group__character.html#g81a73ed06438569e730320f322376ae8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#g48c1aa8996f7a4686f65cf517fb466e5">setToDefault</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(re)sets the structure to the default. <a href="group__character.html#g48c1aa8996f7a4686f65cf517fb466e5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#gea6bc16855502d71ef61889eec02bcce">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">returns true if the current settings are valid <a href="group__character.html#gea6bc16855502d71ef61889eec02bcce"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleControllerDesc.html#a54d06eec5b469d6342e8f26535e8160">radius</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The radius of the capsule. <a href="#a54d06eec5b469d6342e8f26535e8160"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleControllerDesc.html#00dcfa7bd1c529bf745fdf8849746a97">height</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The height of the controller. <a href="#00dcfa7bd1c529bf745fdf8849746a97"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structPxCapsuleClimbingMode.html#a5842460fe36a16e5f1f5b1383db9ef5">PxCapsuleClimbingMode::Enum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxCapsuleControllerDesc.html#89888e84bf3091c6c3e7818732864674">climbingMode</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The climbing mode. <a href="#89888e84bf3091c6c3e7818732864674"></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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#gca0cf550bc0f4c0a2f215ae79d309fd5">copy</a> (const <a class="el" href="classPxCapsuleControllerDesc.html">PxCapsuleControllerDesc</a> &)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A descriptor for a capsule character controller. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleController.html" title="A capsule character controller.">PxCapsuleController</a> <a class="el" href="classPxControllerDesc.html" title="Descriptor class for a character controller.">PxControllerDesc</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="bb004bea1a109a1d77a3b9d53dfe8328"></a><!-- doxytag: member="PxCapsuleControllerDesc::~PxCapsuleControllerDesc" ref="bb004bea1a109a1d77a3b9d53dfe8328" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_INLINE PxCapsuleControllerDesc::~PxCapsuleControllerDesc </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 Data Documentation</h2> +<a class="anchor" name="89888e84bf3091c6c3e7818732864674"></a><!-- doxytag: member="PxCapsuleControllerDesc::climbingMode" ref="89888e84bf3091c6c3e7818732864674" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structPxCapsuleClimbingMode.html#a5842460fe36a16e5f1f5b1383db9ef5">PxCapsuleClimbingMode::Enum</a> <a class="el" href="classPxCapsuleControllerDesc.html#89888e84bf3091c6c3e7818732864674">PxCapsuleControllerDesc::climbingMode</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The climbing mode. +<p> +<b>Default:</b> <a class="el" href="structPxCapsuleClimbingMode.html#a5842460fe36a16e5f1f5b1383db9ef56d3c1dbdc9af5384ef71e200846c9617" title="Standard mode, let the capsule climb over surfaces according to impact normal.">PxCapsuleClimbingMode::eEASY</a><p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleController.html" title="A capsule character controller.">PxCapsuleController</a> </dd></dl> + +<p>Referenced by <a class="el" href="PxCapsuleController_8h-source.html#l00140">copy()</a>, and <a class="el" href="PxCapsuleController_8h-source.html#l00122">PxCapsuleControllerDesc()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="00dcfa7bd1c529bf745fdf8849746a97"></a><!-- doxytag: member="PxCapsuleControllerDesc::height" ref="00dcfa7bd1c529bf745fdf8849746a97" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxF32 <a class="el" href="classPxCapsuleControllerDesc.html#00dcfa7bd1c529bf745fdf8849746a97">PxCapsuleControllerDesc::height</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The height of the controller. +<p> +<b>Default:</b> 0.0<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleController.html" title="A capsule character controller.">PxCapsuleController</a> </dd></dl> + +<p>Referenced by <a class="el" href="PxCapsuleController_8h-source.html#l00140">copy()</a>, <a class="el" href="PxCapsuleController_8h-source.html#l00152">isValid()</a>, and <a class="el" href="PxCapsuleController_8h-source.html#l00122">PxCapsuleControllerDesc()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a54d06eec5b469d6342e8f26535e8160"></a><!-- doxytag: member="PxCapsuleControllerDesc::radius" ref="a54d06eec5b469d6342e8f26535e8160" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxF32 <a class="el" href="classPxCapsuleControllerDesc.html#a54d06eec5b469d6342e8f26535e8160">PxCapsuleControllerDesc::radius</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The radius of the capsule. +<p> +<b>Default:</b> 0.0<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxCapsuleController.html" title="A capsule character controller.">PxCapsuleController</a> </dd></dl> + +<p>Referenced by <a class="el" href="PxCapsuleController_8h-source.html#l00140">copy()</a>, <a class="el" href="PxCapsuleController_8h-source.html#l00152">isValid()</a>, and <a class="el" href="PxCapsuleController_8h-source.html#l00122">PxCapsuleControllerDesc()</a>.</p> + +</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> |