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/PxArticulationJoint_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/PxArticulationJoint_8h-source.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/PxArticulationJoint_8h-source.html | 186 |
1 files changed, 186 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/PxArticulationJoint_8h-source.html b/PhysX_3.4/Documentation/PhysXAPI/files/PxArticulationJoint_8h-source.html new file mode 100644 index 00000000..6e857b18 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/PxArticulationJoint_8h-source.html @@ -0,0 +1,186 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxArticulationJoint.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>PxArticulationJoint.h</h1><a href="PxArticulationJoint_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_NX_ARTICULATION_JOINT</span> +<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_PHYSICS_NX_ARTICULATION_JOINT</span> +<a name="l00033"></a>00033 <span class="preprocessor"></span> +<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="PxPhysXConfig_8h.html">PxPhysXConfig.h</a>"</span> +<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="PxBase_8h.html">common/PxBase.h</a>"</span> +<a name="l00038"></a>00038 +<a name="l00039"></a>00039 <span class="preprocessor">#if !PX_DOXYGEN</span> +<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="keyword">namespace </span>physx +<a name="l00041"></a>00041 { +<a name="l00042"></a>00042 <span class="preprocessor">#endif</span> +<a name="l00043"></a>00043 <span class="preprocessor"></span> +<a name="l00057"></a><a class="code" href="structPxArticulationJointDriveType.html">00057</a> <span class="keyword">struct </span><a class="code" href="structPxArticulationJointDriveType.html" title="The type of joint drive to use for the articulation joint.">PxArticulationJointDriveType</a> +<a name="l00058"></a>00058 { +<a name="l00059"></a><a class="code" href="structPxArticulationJointDriveType.html#c6be2c7afe87dd7755dae4aa7a0fdfe2">00059</a> <span class="keyword">enum</span> <a class="code" href="structPxArticulationJointDriveType.html#c6be2c7afe87dd7755dae4aa7a0fdfe2">Enum</a> +<a name="l00060"></a>00060 { +<a name="l00061"></a><a class="code" href="structPxArticulationJointDriveType.html#c6be2c7afe87dd7755dae4aa7a0fdfe26efbffee5445ed12550a3cb4f1e1cd9e">00061</a> eTARGET = 0, <span class="comment">// use the quaternion as the drive target</span> +<a name="l00062"></a><a class="code" href="structPxArticulationJointDriveType.html#c6be2c7afe87dd7755dae4aa7a0fdfe2178e00c7f3fa1771a6d607235ebb3372">00062</a> eERROR = 1 <span class="comment">// use the vector part of the quaternion as the drive error.</span> +<a name="l00063"></a>00063 }; +<a name="l00064"></a>00064 }; +<a name="l00065"></a>00065 +<a name="l00066"></a>00066 +<a name="l00076"></a><a class="code" href="classPxArticulationJoint.html">00076</a> <span class="keyword">class </span><a class="code" href="classPxArticulationJoint.html" title="a joint between two links in an articulation.">PxArticulationJoint</a> : <span class="keyword">public</span> <a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a> +<a name="l00077"></a>00077 { +<a name="l00078"></a>00078 <span class="keyword">public</span>: +<a name="l00079"></a>00079 +<a name="l00089"></a>00089 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setParentPose(<span class="keyword">const</span> <a class="code" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a>& pose) = 0; +<a name="l00090"></a>00090 +<a name="l00099"></a>00099 <span class="keyword">virtual</span> <a class="code" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a> getParentPose() <span class="keyword">const</span> = 0; +<a name="l00100"></a>00100 +<a name="l00101"></a>00101 +<a name="l00111"></a>00111 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setChildPose(<span class="keyword">const</span> <a class="code" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a>& pose) = 0; +<a name="l00112"></a>00112 +<a name="l00120"></a>00120 <span class="keyword">virtual</span> <a class="code" href="classPxTransform.html" title="class representing a rigid euclidean transform as a quaternion and a vector">PxTransform</a> getChildPose() <span class="keyword">const</span> = 0; +<a name="l00121"></a>00121 +<a name="l00122"></a>00122 +<a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTargetOrientation(<span class="keyword">const</span> <a class="code" href="classPxQuat.html" title="This is a quaternion class. For more information on quaternion mathematics consult...">PxQuat</a>& orientation) = 0; +<a name="l00136"></a>00136 +<a name="l00144"></a>00144 <span class="keyword">virtual</span> <a class="code" href="classPxQuat.html" title="This is a quaternion class. For more information on quaternion mathematics consult...">PxQuat</a> getTargetOrientation() <span class="keyword">const</span> = 0; +<a name="l00145"></a>00145 +<a name="l00156"></a>00156 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTargetVelocity(<span class="keyword">const</span> <a class="code" href="classPxVec3.html" title="3 Element vector class.">PxVec3</a>& velocity) = 0; +<a name="l00157"></a>00157 +<a name="l00165"></a>00165 <span class="keyword">virtual</span> <a class="code" href="classPxVec3.html" title="3 Element vector class.">PxVec3</a> getTargetVelocity() <span class="keyword">const</span> = 0; +<a name="l00166"></a>00166 +<a name="l00167"></a>00167 +<a name="l00176"></a>00176 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDriveType(<a class="code" href="structPxArticulationJointDriveType.html#c6be2c7afe87dd7755dae4aa7a0fdfe2">PxArticulationJointDriveType::Enum</a> driveType) = 0; +<a name="l00177"></a>00177 +<a name="l00185"></a>00185 <span class="keyword">virtual</span> <a class="code" href="structPxArticulationJointDriveType.html#c6be2c7afe87dd7755dae4aa7a0fdfe2">PxArticulationJointDriveType::Enum</a> +<a name="l00186"></a>00186 getDriveType() <span class="keyword">const</span> = 0; +<a name="l00187"></a>00187 +<a name="l00188"></a>00188 +<a name="l00202"></a>00202 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStiffness(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> spring) = 0; +<a name="l00203"></a>00203 +<a name="l00211"></a>00211 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getStiffness() <span class="keyword">const</span> = 0; +<a name="l00212"></a>00212 +<a name="l00213"></a>00213 +<a name="l00227"></a>00227 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDamping(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> damping) = 0; +<a name="l00228"></a>00228 +<a name="l00235"></a>00235 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getDamping() <span class="keyword">const</span> = 0; +<a name="l00236"></a>00236 +<a name="l00256"></a>00256 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setInternalCompliance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> compliance) = 0; +<a name="l00257"></a>00257 +<a name="l00258"></a>00258 +<a name="l00266"></a>00266 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getInternalCompliance() <span class="keyword">const</span> = 0; +<a name="l00267"></a>00267 +<a name="l00287"></a>00287 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setExternalCompliance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> compliance) = 0; +<a name="l00288"></a>00288 +<a name="l00296"></a>00296 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getExternalCompliance() <span class="keyword">const</span> = 0; +<a name="l00297"></a>00297 +<a name="l00298"></a>00298 +<a name="l00299"></a>00299 +<a name="l00312"></a>00312 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSwingLimit(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> yLimit, <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> zLimit) = 0; +<a name="l00313"></a>00313 +<a name="l00314"></a>00314 +<a name="l00323"></a>00323 <span class="keyword">virtual</span> <span class="keywordtype">void</span> getSwingLimit(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> &yLimit, <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> &zLimit) <span class="keyword">const</span> = 0; +<a name="l00324"></a>00324 +<a name="l00325"></a>00325 +<a name="l00326"></a>00326 +<a name="l00333"></a>00333 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTangentialStiffness(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> spring) = 0; +<a name="l00334"></a>00334 +<a name="l00335"></a>00335 +<a name="l00343"></a>00343 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getTangentialStiffness() <span class="keyword">const</span> = 0; +<a name="l00344"></a>00344 +<a name="l00345"></a>00345 +<a name="l00352"></a>00352 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTangentialDamping(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> damping) = 0; +<a name="l00353"></a>00353 +<a name="l00354"></a>00354 +<a name="l00362"></a>00362 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getTangentialDamping() <span class="keyword">const</span> = 0; +<a name="l00363"></a>00363 +<a name="l00364"></a>00364 +<a name="l00376"></a>00376 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSwingLimitContactDistance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> contactDistance) = 0; +<a name="l00377"></a>00377 +<a name="l00378"></a>00378 +<a name="l00386"></a>00386 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getSwingLimitContactDistance() <span class="keyword">const</span> = 0; +<a name="l00387"></a>00387 +<a name="l00388"></a>00388 +<a name="l00389"></a>00389 +<a name="l00398"></a>00398 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setSwingLimitEnabled(<span class="keywordtype">bool</span> enabled) = 0; +<a name="l00399"></a>00399 +<a name="l00408"></a>00408 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getSwingLimitEnabled() <span class="keyword">const</span> = 0; +<a name="l00409"></a>00409 +<a name="l00410"></a>00410 +<a name="l00423"></a>00423 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTwistLimit(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> lower, <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> upper) = 0; +<a name="l00424"></a>00424 +<a name="l00434"></a>00434 <span class="keyword">virtual</span> <span class="keywordtype">void</span> getTwistLimit(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> &lower, <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> &upper) <span class="keyword">const</span> = 0; +<a name="l00435"></a>00435 +<a name="l00436"></a>00436 +<a name="l00445"></a>00445 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTwistLimitEnabled(<span class="keywordtype">bool</span> enabled) = 0; +<a name="l00446"></a>00446 +<a name="l00455"></a>00455 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getTwistLimitEnabled() <span class="keyword">const</span> = 0; +<a name="l00456"></a>00456 +<a name="l00457"></a>00457 +<a name="l00469"></a>00469 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTwistLimitContactDistance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> contactDistance) = 0; +<a name="l00470"></a>00470 +<a name="l00471"></a>00471 +<a name="l00479"></a>00479 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getTwistLimitContactDistance() <span class="keyword">const</span> = 0; +<a name="l00480"></a>00480 +<a name="l00481"></a><a class="code" href="classPxArticulationJoint.html#0ec72415d78f1148731de1d9a65a7ab4">00481</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPxArticulationJoint.html#0ec72415d78f1148731de1d9a65a7ab4" title="Returns string name of dynamic type.">getConcreteTypeName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"PxArticulationJoint"</span>; } +<a name="l00482"></a>00482 +<a name="l00483"></a>00483 <span class="keyword">protected</span>: +<a name="l00484"></a><a class="code" href="classPxArticulationJoint.html#8ecb6fb89ec7e18314cfc9c6b255bd41">00484</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxArticulationJoint.html#8ecb6fb89ec7e18314cfc9c6b255bd41">PxArticulationJoint</a>(<a class="code" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags) : <a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>(concreteType, baseFlags) {} +<a name="l00485"></a><a class="code" href="classPxArticulationJoint.html#830694ba6d6b8bbe5dfdc71f446bac54">00485</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxArticulationJoint.html#830694ba6d6b8bbe5dfdc71f446bac54">PxArticulationJoint</a>(<a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags) : <a class="code" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection.">PxBase</a>(baseFlags) {} +<a name="l00486"></a><a class="code" href="classPxArticulationJoint.html#2a73babb0e7aa037d07132980281f302">00486</a> <span class="keyword">virtual</span> <a class="code" href="classPxArticulationJoint.html#2a73babb0e7aa037d07132980281f302">~PxArticulationJoint</a>() {} +<a name="l00487"></a><a class="code" href="classPxArticulationJoint.html#713c786ca5a9d2a93d3b5e8d3cb6943d">00487</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPxArticulationJoint.html#713c786ca5a9d2a93d3b5e8d3cb6943d" title="Returns whether a given type name matches with the type of this instance.">isKindOf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !::strcmp(<span class="stringliteral">"PxArticulationJoint"</span>, name) || <a class="code" href="classPxBase.html#ae9d444c7cfd1715a101350a1b1226ef" title="Returns whether a given type name matches with the type of this instance.">PxBase::isKindOf</a>(name); } +<a name="l00488"></a>00488 }; +<a name="l00489"></a>00489 +<a name="l00490"></a>00490 <span class="preprocessor">#if !PX_DOXYGEN</span> +<a name="l00491"></a>00491 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span> +<a name="l00492"></a>00492 <span class="preprocessor">#endif</span> +<a name="l00493"></a>00493 <span class="preprocessor"></span> +<a name="l00495"></a>00495 <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> |