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/classPxBoxControllerDesc.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/classPxBoxControllerDesc.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxControllerDesc.html | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxControllerDesc.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxControllerDesc.html new file mode 100644 index 00000000..838305b7 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxControllerDesc.html @@ -0,0 +1,169 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxControllerDesc 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>PxBoxControllerDesc Class Reference<br> +<small> +[<a class="el" href="group__character.html">Character</a>]</small> +</h1><!-- doxytag: class="PxBoxControllerDesc" --><!-- doxytag: inherits="PxControllerDesc" -->Descriptor for a box character controller. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxBoxController_8h-source.html">PxBoxController.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxBoxControllerDesc:</div> +<div class="dynsection"> +<p><center><img src="classPxBoxControllerDesc__inherit__graph.png" border="0" usemap="#PxBoxControllerDesc__inherit__map" alt="Inheritance graph"></center> +<map name="PxBoxControllerDesc__inherit__map"> +<area shape="rect" href="classPxControllerDesc.html" title="Descriptor class for a character controller." alt="PxControllerDesc" coords="17,16,129,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxBoxControllerDesc:</div> +<div class="dynsection"> +<p><center><img src="classPxBoxControllerDesc__coll__graph.png" border="0" usemap="#PxBoxControllerDesc__coll__map" alt="Collaboration graph"></center> +<map name="PxBoxControllerDesc__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="classPxBoxControllerDesc-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#g5d8e29dacee8a0a6543029435c0d5dc6">PxBoxControllerDesc</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor sets to default. <a href="group__character.html#g5d8e29dacee8a0a6543029435c0d5dc6"></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="classPxBoxControllerDesc.html#46b933510a1ae7f17a2a0ad63e46579e">~PxBoxControllerDesc</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#gc1aba7d97780ef07724bbb1ec1a7514c">PxBoxControllerDesc</a> (const <a class="el" href="classPxBoxControllerDesc.html">PxBoxControllerDesc</a> &)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">copy constructor. <a href="group__character.html#gc1aba7d97780ef07724bbb1ec1a7514c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE <a class="el" href="classPxBoxControllerDesc.html">PxBoxControllerDesc</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__character.html#g95e4b49e470d870c151c3d727a273676">operator=</a> (const <a class="el" href="classPxBoxControllerDesc.html">PxBoxControllerDesc</a> &)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">assignment operator. <a href="group__character.html#g95e4b49e470d870c151c3d727a273676"></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#gf2f271a2e1d38f619d345bd89f737412">setToDefault</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(re)sets the structure to the default. <a href="group__character.html#gf2f271a2e1d38f619d345bd89f737412"></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#g3180f6c48012e2b8d2d10a818ad9c2ab">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#g3180f6c48012e2b8d2d10a818ad9c2ab"></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="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6">halfHeight</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Half height. <a href="#815c411aad6776da24bbb4fceb6aa8b6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808">halfSideExtent</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Half side extent. <a href="#b3c305136be5d04e77862a7e2e4f4808"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PxF32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf">halfForwardExtent</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Half forward extent. <a href="#4efede85355dc05251d1c5c8bbb5a8bf"></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#g08c251badc674d74a5f9abb07ae5ad8f">copy</a> (const <a class="el" href="classPxBoxControllerDesc.html">PxBoxControllerDesc</a> &)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Descriptor for a box character controller. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxController.html" title="Box character controller.">PxBoxController</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="46b933510a1ae7f17a2a0ad63e46579e"></a><!-- doxytag: member="PxBoxControllerDesc::~PxBoxControllerDesc" ref="46b933510a1ae7f17a2a0ad63e46579e" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PX_INLINE PxBoxControllerDesc::~PxBoxControllerDesc </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="4efede85355dc05251d1c5c8bbb5a8bf"></a><!-- doxytag: member="PxBoxControllerDesc::halfForwardExtent" ref="4efede85355dc05251d1c5c8bbb5a8bf" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxF32 <a class="el" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf">PxBoxControllerDesc::halfForwardExtent</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Half forward extent. +<p> +<b>Default:</b> 0.5 +<p>Referenced by <a class="el" href="PxBoxController_8h-source.html#l00126">copy()</a>, and <a class="el" href="PxBoxController_8h-source.html#l00138">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="815c411aad6776da24bbb4fceb6aa8b6"></a><!-- doxytag: member="PxBoxControllerDesc::halfHeight" ref="815c411aad6776da24bbb4fceb6aa8b6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxF32 <a class="el" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6">PxBoxControllerDesc::halfHeight</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Half height. +<p> +<b>Default:</b> 1.0 +<p>Referenced by <a class="el" href="PxBoxController_8h-source.html#l00126">copy()</a>, and <a class="el" href="PxBoxController_8h-source.html#l00138">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b3c305136be5d04e77862a7e2e4f4808"></a><!-- doxytag: member="PxBoxControllerDesc::halfSideExtent" ref="b3c305136be5d04e77862a7e2e4f4808" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PxF32 <a class="el" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808">PxBoxControllerDesc::halfSideExtent</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Half side extent. +<p> +<b>Default:</b> 0.5 +<p>Referenced by <a class="el" href="PxBoxController_8h-source.html#l00126">copy()</a>, and <a class="el" href="PxBoxController_8h-source.html#l00138">isValid()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxBoxController_8h-source.html">PxBoxController.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> |