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/PxBoxController_8h-source.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/PxBoxController_8h-source.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/PxBoxController_8h-source.html | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/PxBoxController_8h-source.html b/PhysX_3.4/Documentation/PhysXAPI/files/PxBoxController_8h-source.html new file mode 100644 index 00000000..738cd370 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/PxBoxController_8h-source.html @@ -0,0 +1,159 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxBoxController.h Source File</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 --> +<h1>PxBoxController.h</h1><a href="PxBoxController_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// This code contains NVIDIA Confidential Information and is disclosed to you</span> +<a name="l00002"></a>00002 <span class="comment">// under a form of NVIDIA software license agreement provided separately to you.</span> +<a name="l00003"></a>00003 <span class="comment">//</span> +<a name="l00004"></a>00004 <span class="comment">// Notice</span> +<a name="l00005"></a>00005 <span class="comment">// NVIDIA Corporation and its licensors retain all intellectual property and</span> +<a name="l00006"></a>00006 <span class="comment">// proprietary rights in and to this software and related documentation and</span> +<a name="l00007"></a>00007 <span class="comment">// any modifications thereto. Any use, reproduction, disclosure, or</span> +<a name="l00008"></a>00008 <span class="comment">// distribution of this software and related documentation without an express</span> +<a name="l00009"></a>00009 <span class="comment">// license agreement from NVIDIA Corporation is strictly prohibited.</span> +<a name="l00010"></a>00010 <span class="comment">//</span> +<a name="l00011"></a>00011 <span class="comment">// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES</span> +<a name="l00012"></a>00012 <span class="comment">// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO</span> +<a name="l00013"></a>00013 <span class="comment">// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,</span> +<a name="l00014"></a>00014 <span class="comment">// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.</span> +<a name="l00015"></a>00015 <span class="comment">//</span> +<a name="l00016"></a>00016 <span class="comment">// Information and code furnished is believed to be accurate and reliable.</span> +<a name="l00017"></a>00017 <span class="comment">// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such</span> +<a name="l00018"></a>00018 <span class="comment">// information or for any infringement of patents or other rights of third parties that may</span> +<a name="l00019"></a>00019 <span class="comment">// result from its use. No license is granted by implication or otherwise under any patent</span> +<a name="l00020"></a>00020 <span class="comment">// or patent rights of NVIDIA Corporation. Details are subject to change without notice.</span> +<a name="l00021"></a>00021 <span class="comment">// This code supersedes and replaces all information previously supplied.</span> +<a name="l00022"></a>00022 <span class="comment">// NVIDIA Corporation products are not authorized for use as critical</span> +<a name="l00023"></a>00023 <span class="comment">// components in life support devices or systems without express written approval of</span> +<a name="l00024"></a>00024 <span class="comment">// NVIDIA Corporation.</span> +<a name="l00025"></a>00025 <span class="comment">//</span> +<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.</span> +<a name="l00027"></a>00027 <span class="comment">// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.</span> +<a name="l00028"></a>00028 <span class="comment">// Copyright (c) 2001-2004 NovodeX AG. All rights reserved. </span> +<a name="l00029"></a>00029 +<a name="l00030"></a>00030 +<a name="l00031"></a>00031 <span class="preprocessor">#ifndef PX_PHYSICS_CCT_BOX_CONTROLLER</span> +<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_PHYSICS_CCT_BOX_CONTROLLER</span> +<a name="l00033"></a>00033 <span class="preprocessor"></span> +<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="PxCharacter_8h.html">characterkinematic/PxCharacter.h</a>"</span> +<a name="l00038"></a>00038 <span class="preprocessor">#include "<a class="code" href="PxController_8h.html">characterkinematic/PxController.h</a>"</span> +<a name="l00039"></a>00039 +<a name="l00040"></a>00040 <span class="preprocessor">#if !PX_DOXYGEN</span> +<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="keyword">namespace </span>physx +<a name="l00042"></a>00042 { +<a name="l00043"></a>00043 <span class="preprocessor">#endif</span> +<a name="l00044"></a>00044 <span class="preprocessor"></span> +<a name="l00050"></a><a class="code" href="classPxBoxControllerDesc.html">00050</a> <span class="keyword">class </span><a class="code" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a> : <span class="keyword">public</span> <a class="code" href="classPxControllerDesc.html" title="Descriptor class for a character controller.">PxControllerDesc</a> +<a name="l00051"></a>00051 { +<a name="l00052"></a>00052 <span class="keyword">public</span>: +<a name="l00056"></a>00056 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a>(); +<a name="l00057"></a><a class="code" href="classPxBoxControllerDesc.html#46b933510a1ae7f17a2a0ad63e46579e">00057</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keyword">virtual</span> <a class="code" href="classPxBoxControllerDesc.html#46b933510a1ae7f17a2a0ad63e46579e">~PxBoxControllerDesc</a>() {} +<a name="l00058"></a>00058 +<a name="l00062"></a>00062 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxBoxControllerDesc(<span class="keyword">const</span> PxBoxControllerDesc&); +<a name="l00063"></a>00063 +<a name="l00067"></a>00067 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxBoxControllerDesc& operator=(<span class="keyword">const</span> PxBoxControllerDesc&); +<a name="l00068"></a>00068 +<a name="l00072"></a>00072 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setToDefault(); +<a name="l00073"></a>00073 +<a name="l00079"></a>00079 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isValid() <span class="keyword">const</span>; +<a name="l00080"></a>00080 +<a name="l00086"></a><a class="code" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6">00086</a> <a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> halfHeight; <span class="comment">// Half-height in the "up" direction</span> +<a name="l00087"></a>00087 +<a name="l00093"></a><a class="code" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808">00093</a> <a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> halfSideExtent; <span class="comment">// Half-extent in the "side" direction</span> +<a name="l00094"></a>00094 +<a name="l00100"></a><a class="code" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf">00100</a> <a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> halfForwardExtent; <span class="comment">// Half-extent in the "forward" direction</span> +<a name="l00101"></a>00101 +<a name="l00102"></a>00102 <span class="keyword">protected</span>: +<a name="l00103"></a>00103 <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">void</span> copy(<span class="keyword">const</span> PxBoxControllerDesc&); +<a name="l00104"></a>00104 }; +<a name="l00105"></a>00105 +<a name="l00106"></a><a class="code" href="group__character.html#g5d8e29dacee8a0a6543029435c0d5dc6">00106</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="group__character.html#g5d8e29dacee8a0a6543029435c0d5dc6" title="constructor sets to default.">PxBoxControllerDesc::PxBoxControllerDesc</a>() : +<a name="l00107"></a>00107 <a class="code" href="classPxControllerDesc.html" title="Descriptor class for a character controller.">PxControllerDesc</a> (<a class="code" href="structPxControllerShapeType.html" title="The type of controller, eg box, sphere or capsule.">PxControllerShapeType</a>::eBOX), +<a name="l00108"></a>00108 halfHeight (1.0f), +<a name="l00109"></a>00109 halfSideExtent (0.5f), +<a name="l00110"></a>00110 halfForwardExtent (0.5f) +<a name="l00111"></a>00111 { +<a name="l00112"></a>00112 } +<a name="l00113"></a>00113 +<a name="l00114"></a><a class="code" href="group__character.html#gc1aba7d97780ef07724bbb1ec1a7514c">00114</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="group__character.html#g5d8e29dacee8a0a6543029435c0d5dc6" title="constructor sets to default.">PxBoxControllerDesc::PxBoxControllerDesc</a>(<span class="keyword">const</span> <a class="code" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a>& other) : <a class="code" href="classPxControllerDesc.html" title="Descriptor class for a character controller.">PxControllerDesc</a>(other) +<a name="l00115"></a>00115 { +<a name="l00116"></a>00116 <a class="code" href="group__character.html#g08c251badc674d74a5f9abb07ae5ad8f">copy</a>(other); +<a name="l00117"></a>00117 } +<a name="l00118"></a>00118 +<a name="l00119"></a><a class="code" href="group__character.html#g95e4b49e470d870c151c3d727a273676">00119</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a>& <a class="code" href="group__character.html#g95e4b49e470d870c151c3d727a273676" title="assignment operator.">PxBoxControllerDesc::operator=</a>(<span class="keyword">const</span> <a class="code" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a>& other) +<a name="l00120"></a>00120 { +<a name="l00121"></a>00121 <a class="code" href="group__character.html#g95e4b49e470d870c151c3d727a273676" title="assignment operator.">PxControllerDesc::operator=</a>(other); +<a name="l00122"></a>00122 <a class="code" href="group__character.html#g08c251badc674d74a5f9abb07ae5ad8f">copy</a>(other); +<a name="l00123"></a>00123 <span class="keywordflow">return</span> *<span class="keyword">this</span>; +<a name="l00124"></a>00124 } +<a name="l00125"></a>00125 +<a name="l00126"></a><a class="code" href="group__character.html#g08c251badc674d74a5f9abb07ae5ad8f">00126</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">void</span> <a class="code" href="group__character.html#g08c251badc674d74a5f9abb07ae5ad8f">PxBoxControllerDesc::copy</a>(<span class="keyword">const</span> <a class="code" href="classPxBoxControllerDesc.html" title="Descriptor for a box character controller.">PxBoxControllerDesc</a>& other) +<a name="l00127"></a>00127 { +<a name="l00128"></a>00128 <a class="code" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">halfHeight</a> = other.<a class="code" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">halfHeight</a>; +<a name="l00129"></a>00129 <a class="code" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808" title="Half side extent.">halfSideExtent</a> = other.<a class="code" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808" title="Half side extent.">halfSideExtent</a>; +<a name="l00130"></a>00130 <a class="code" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf" title="Half forward extent.">halfForwardExtent</a> = other.<a class="code" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf" title="Half forward extent.">halfForwardExtent</a>; +<a name="l00131"></a>00131 } +<a name="l00132"></a>00132 +<a name="l00133"></a><a class="code" href="group__character.html#gf2f271a2e1d38f619d345bd89f737412">00133</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">void</span> <a class="code" href="group__character.html#gf2f271a2e1d38f619d345bd89f737412" title="(re)sets the structure to the default.">PxBoxControllerDesc::setToDefault</a>() +<a name="l00134"></a>00134 { +<a name="l00135"></a>00135 *<span class="keyword">this</span> = <a class="code" href="group__character.html#g5d8e29dacee8a0a6543029435c0d5dc6" title="constructor sets to default.">PxBoxControllerDesc</a>(); +<a name="l00136"></a>00136 } +<a name="l00137"></a>00137 +<a name="l00138"></a><a class="code" href="group__character.html#g3180f6c48012e2b8d2d10a818ad9c2ab">00138</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <span class="keywordtype">bool</span> <a class="code" href="group__character.html#g3180f6c48012e2b8d2d10a818ad9c2ab" title="returns true if the current settings are valid">PxBoxControllerDesc::isValid</a>()<span class="keyword"> const</span> +<a name="l00139"></a>00139 <span class="keyword"></span>{ +<a name="l00140"></a>00140 <span class="keywordflow">if</span>(!<a class="code" href="group__character.html#g4bc247ac0f6c9cf1a0baa75c6b1c5ce1" title="returns true if the current settings are valid">PxControllerDesc::isValid</a>()) <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00141"></a>00141 <span class="keywordflow">if</span>(<a class="code" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">halfHeight</a><=0.0f) <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00142"></a>00142 <span class="keywordflow">if</span>(<a class="code" href="classPxBoxControllerDesc.html#b3c305136be5d04e77862a7e2e4f4808" title="Half side extent.">halfSideExtent</a><=0.0f) <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00143"></a>00143 <span class="keywordflow">if</span>(<a class="code" href="classPxBoxControllerDesc.html#4efede85355dc05251d1c5c8bbb5a8bf" title="Half forward extent.">halfForwardExtent</a><=0.0f) <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00144"></a>00144 <span class="keywordflow">if</span>(<a class="code" href="classPxControllerDesc.html#51fe254a4807b832b2d34e884d856438" title="Defines the maximum height of an obstacle which the character can climb.">stepOffset</a>>2.0f*<a class="code" href="classPxBoxControllerDesc.html#815c411aad6776da24bbb4fceb6aa8b6" title="Half height.">halfHeight</a>) <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// Prevents obvious mistakes</span> +<a name="l00145"></a>00145 <span class="keywordflow">return</span> <span class="keyword">true</span>; +<a name="l00146"></a>00146 } +<a name="l00147"></a>00147 +<a name="l00153"></a><a class="code" href="classPxBoxController.html">00153</a> <span class="keyword">class </span><a class="code" href="classPxBoxController.html" title="Box character controller.">PxBoxController</a> : <span class="keyword">public</span> <a class="code" href="classPxController.html" title="Base class for character controllers.">PxController</a> +<a name="l00154"></a>00154 { +<a name="l00155"></a>00155 <span class="keyword">public</span>: +<a name="l00156"></a>00156 +<a name="l00164"></a>00164 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> <a class="code" href="classPxBoxController.html#25c66f4fabdb4d689bc77aba02f66ebd" title="Gets controller&#39;s half height.">getHalfHeight</a>() <span class="keyword">const</span> = 0; +<a name="l00165"></a>00165 +<a name="l00173"></a>00173 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> <a class="code" href="classPxBoxController.html#3e1de6ef41ef607c768012530931cb98" title="Gets controller&#39;s half side extent.">getHalfSideExtent</a>() <span class="keyword">const</span> = 0; +<a name="l00174"></a>00174 +<a name="l00182"></a>00182 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> <a class="code" href="classPxBoxController.html#ddbaf29dafa43422705e70449a62a8a1" title="Gets controller&#39;s half forward extent.">getHalfForwardExtent</a>() <span class="keyword">const</span> = 0; +<a name="l00183"></a>00183 +<a name="l00194"></a>00194 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPxBoxController.html#f959bc51b41f2c00156cd28bd19fc240" title="Sets controller&#39;s half height.">setHalfHeight</a>(<a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> halfHeight) = 0; +<a name="l00195"></a>00195 +<a name="l00206"></a>00206 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPxBoxController.html#f1b0b85810c79821ddb61cb42d0ef730" title="Sets controller&#39;s half side extent.">setHalfSideExtent</a>(<a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> halfSideExtent) = 0; +<a name="l00207"></a>00207 +<a name="l00218"></a>00218 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPxBoxController.html#cae44a6bab0ca9da6d47b84345d03e61" title="Sets controller&#39;s half forward extent.">setHalfForwardExtent</a>(<a class="code" href="namespacephysx.html#b4cf332bdb6e8b183e40b6973acc1e9b">PxF32</a> halfForwardExtent) = 0; +<a name="l00219"></a>00219 +<a name="l00220"></a>00220 <span class="keyword">protected</span>: +<a name="l00221"></a><a class="code" href="classPxBoxController.html#5182b7d6bd38b10d31ecdc6453b0ecbe">00221</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxBoxController.html#5182b7d6bd38b10d31ecdc6453b0ecbe">PxBoxController</a>() {} +<a name="l00222"></a><a class="code" href="classPxBoxController.html#792cdd51d6c3efdf97679f7afb399332">00222</a> <span class="keyword">virtual</span> <a class="code" href="classPxBoxController.html#792cdd51d6c3efdf97679f7afb399332">~PxBoxController</a>() {} +<a name="l00223"></a>00223 }; +<a name="l00224"></a>00224 +<a name="l00225"></a>00225 <span class="preprocessor">#if !PX_DOXYGEN</span> +<a name="l00226"></a>00226 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span> +<a name="l00227"></a>00227 <span class="preprocessor">#endif</span> +<a name="l00228"></a>00228 <span class="preprocessor"></span> +<a name="l00230"></a>00230 <span class="preprocessor">#endif</span> +</pre></div></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> |