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/classPxBoxController.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/classPxBoxController.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html | 283 |
1 files changed, 283 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html new file mode 100644 index 00000000..97d20f43 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxBoxController.html @@ -0,0 +1,283 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxController 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>PxBoxController Class Reference<br> +<small> +[<a class="el" href="group__character.html">Character</a>]</small> +</h1><!-- doxytag: class="PxBoxController" --><!-- doxytag: inherits="PxController" -->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 PxBoxController:</div> +<div class="dynsection"> +<p><center><img src="classPxBoxController__inherit__graph.png" border="0" usemap="#PxBoxController__inherit__map" alt="Inheritance graph"></center> +<map name="PxBoxController__inherit__map"> +<area shape="rect" href="classPxController.html" title="Base class for character controllers." alt="PxController" coords="17,16,100,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxBoxController:</div> +<div class="dynsection"> +<p><center><img src="classPxBoxController__coll__graph.png" border="0" usemap="#PxBoxController__coll__map" alt="Collaboration graph"></center> +<map name="PxBoxController__coll__map"> +<area shape="rect" href="classPxController.html" title="Base class for character controllers." alt="PxController" coords="17,16,100,37"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxBoxController-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="classPxBoxController.html#25c66f4fabdb4d689bc77aba02f66ebd">getHalfHeight</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets controller's half height. <a href="#25c66f4fabdb4d689bc77aba02f66ebd"></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="classPxBoxController.html#3e1de6ef41ef607c768012530931cb98">getHalfSideExtent</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets controller's half side extent. <a href="#3e1de6ef41ef607c768012530931cb98"></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="classPxBoxController.html#ddbaf29dafa43422705e70449a62a8a1">getHalfForwardExtent</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets controller's half forward extent. <a href="#ddbaf29dafa43422705e70449a62a8a1"></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="classPxBoxController.html#f959bc51b41f2c00156cd28bd19fc240">setHalfHeight</a> (PxF32 halfHeight)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets controller's half height. <a href="#f959bc51b41f2c00156cd28bd19fc240"></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="classPxBoxController.html#f1b0b85810c79821ddb61cb42d0ef730">setHalfSideExtent</a> (PxF32 halfSideExtent)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets controller's half side extent. <a href="#f1b0b85810c79821ddb61cb42d0ef730"></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="classPxBoxController.html#cae44a6bab0ca9da6d47b84345d03e61">setHalfForwardExtent</a> (PxF32 halfForwardExtent)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets controller's half forward extent. <a href="#cae44a6bab0ca9da6d47b84345d03e61"></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="classPxBoxController.html#5182b7d6bd38b10d31ecdc6453b0ecbe">PxBoxController</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxBoxController.html#792cdd51d6c3efdf97679f7afb399332">~PxBoxController</a> ()</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Box character controller. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a> <a class="el" href="classPxController.html" title="Base class for character controllers.">PxController</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="5182b7d6bd38b10d31ecdc6453b0ecbe"></a><!-- doxytag: member="PxBoxController::PxBoxController" ref="5182b7d6bd38b10d31ecdc6453b0ecbe" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxBoxController::PxBoxController </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="792cdd51d6c3efdf97679f7afb399332"></a><!-- doxytag: member="PxBoxController::~PxBoxController" ref="792cdd51d6c3efdf97679f7afb399332" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxBoxController::~PxBoxController </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="ddbaf29dafa43422705e70449a62a8a1"></a><!-- doxytag: member="PxBoxController::getHalfForwardExtent" ref="ddbaf29dafa43422705e70449a62a8a1" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxF32 PxBoxController::getHalfForwardExtent </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 half forward extent. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The half forward extent of the controller.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf" title="Half forward extent.">PxBoxControllerDesc.halfForwardExtent</a> <a class="el" href="classPxBoxController.html#cae44a6bab0ca9da6d47b84345d03e61" title="Sets controller's half forward extent.">setHalfForwardExtent()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="25c66f4fabdb4d689bc77aba02f66ebd"></a><!-- doxytag: member="PxBoxController::getHalfHeight" ref="25c66f4fabdb4d689bc77aba02f66ebd" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxF32 PxBoxController::getHalfHeight </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 half height. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The half height of the controller.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">PxBoxControllerDesc.halfHeight</a> <a class="el" href="classPxBoxController.html#f959bc51b41f2c00156cd28bd19fc240" title="Sets controller's half height.">setHalfHeight()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3e1de6ef41ef607c768012530931cb98"></a><!-- doxytag: member="PxBoxController::getHalfSideExtent" ref="3e1de6ef41ef607c768012530931cb98" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxF32 PxBoxController::getHalfSideExtent </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 half side extent. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The half side extent of the controller.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808" title="Half side extent.">PxBoxControllerDesc.halfSideExtent</a> <a class="el" href="classPxBoxController.html#f1b0b85810c79821ddb61cb42d0ef730" title="Sets controller's half side extent.">setHalfSideExtent()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="cae44a6bab0ca9da6d47b84345d03e61"></a><!-- doxytag: member="PxBoxController::setHalfForwardExtent" ref="cae44a6bab0ca9da6d47b84345d03e61" args="(PxF32 halfForwardExtent)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxBoxController::setHalfForwardExtent </td> + <td>(</td> + <td class="paramtype">PxF32 </td> + <td class="paramname"> <em>halfForwardExtent</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets controller's half forward extent. +<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>halfForwardExtent</em> </td><td>The new half forward extent 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="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf" title="Half forward extent.">PxBoxControllerDesc.halfForwardExtent</a> <a class="el" href="classPxBoxController.html#ddbaf29dafa43422705e70449a62a8a1" title="Gets controller's half forward extent.">getHalfForwardExtent()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f959bc51b41f2c00156cd28bd19fc240"></a><!-- doxytag: member="PxBoxController::setHalfHeight" ref="f959bc51b41f2c00156cd28bd19fc240" args="(PxF32 halfHeight)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxBoxController::setHalfHeight </td> + <td>(</td> + <td class="paramtype">PxF32 </td> + <td class="paramname"> <em>halfHeight</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets controller's half 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>halfHeight</em> </td><td>The new half 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="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">PxBoxControllerDesc.halfHeight</a> <a class="el" href="classPxBoxController.html#25c66f4fabdb4d689bc77aba02f66ebd" title="Gets controller's half height.">getHalfHeight()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f1b0b85810c79821ddb61cb42d0ef730"></a><!-- doxytag: member="PxBoxController::setHalfSideExtent" ref="f1b0b85810c79821ddb61cb42d0ef730" args="(PxF32 halfSideExtent)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxBoxController::setHalfSideExtent </td> + <td>(</td> + <td class="paramtype">PxF32 </td> + <td class="paramname"> <em>halfSideExtent</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets controller's half side extent. +<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>halfSideExtent</em> </td><td>The new half side extent 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="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808" title="Half side extent.">PxBoxControllerDesc.halfSideExtent</a> <a class="el" href="classPxBoxController.html#3e1de6ef41ef607c768012530931cb98" title="Gets controller's half side extent.">getHalfSideExtent()</a> </dd></dl> + +</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> |