aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxDistanceJoint_8h-source.html
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/PxDistanceJoint_8h-source.html
downloadphysx-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/PxDistanceJoint_8h-source.html')
-rw-r--r--PhysX_3.4/Documentation/PhysXAPI/files/PxDistanceJoint_8h-source.html146
1 files changed, 146 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/PxDistanceJoint_8h-source.html b/PhysX_3.4/Documentation/PhysXAPI/files/PxDistanceJoint_8h-source.html
new file mode 100644
index 00000000..96b4fa59
--- /dev/null
+++ b/PhysX_3.4/Documentation/PhysXAPI/files/PxDistanceJoint_8h-source.html
@@ -0,0 +1,146 @@
+<html>
+ <head>
+ <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxDistanceJoint.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> &nbsp;
+ <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp;
+ <a class="qindex" href="annotated.html">Compound List</a> &nbsp;
+ <a class="qindex" href="functions.html">Compound Members</a> &nbsp;
+ </center>
+ <hr class="second">
+ </div>
+<!-- Generated by Doxygen 1.5.8 -->
+<h1>PxDistanceJoint.h</h1><a href="PxDistanceJoint_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_DISTANCEJOINT_H</span>
+<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_DISTANCEJOINT_H</span>
+<a name="l00033"></a>00033 <span class="preprocessor"></span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="PxJoint_8h.html">extensions/PxJoint.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="l00044"></a>00044 <span class="keyword">class </span><a class="code" href="classPxDistanceJoint.html" title="a joint that maintains an upper or lower bound (or both) on the distance between...">PxDistanceJoint</a>;
+<a name="l00045"></a>00045
+<a name="l00058"></a>00058 <a class="code" href="classPxDistanceJoint.html" title="a joint that maintains an upper or lower bound (or both) on the distance between...">PxDistanceJoint</a>* <a class="code" href="group__extensions.html#gf7580a5a315137094cb676a7874c978a" title="Create a distance Joint.">PxDistanceJointCreate</a>(<a class="code" href="classPxPhysics.html" title="Abstract singleton factory class used for instancing objects in the Physics SDK.">PxPhysics</a>&amp; physics,
+<a name="l00059"></a>00059 <a class="code" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies...">PxRigidActor</a>* actor0, <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>&amp; localFrame0,
+<a name="l00060"></a>00060 <a class="code" href="classPxRigidActor.html" title="PxRigidActor represents a base class shared between dynamic and static rigid bodies...">PxRigidActor</a>* actor1, <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>&amp; localFrame1);
+<a name="l00061"></a>00061
+<a name="l00062"></a>00062
+<a name="l00069"></a><a class="code" href="structPxDistanceJointFlag.html">00069</a> <span class="keyword">struct </span><a class="code" href="structPxDistanceJointFlag.html" title="flags for configuring the drive of a PxDistanceJoint">PxDistanceJointFlag</a>
+<a name="l00070"></a>00070 {
+<a name="l00071"></a><a class="code" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9">00071</a> <span class="keyword">enum</span> <a class="code" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9">Enum</a>
+<a name="l00072"></a>00072 {
+<a name="l00073"></a><a class="code" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d957b10d96775d80633ee37fb674c37576">00073</a> eMAX_DISTANCE_ENABLED = 1&lt;&lt;1,
+<a name="l00074"></a><a class="code" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9445ff9fe34cd5d13f8bd5656899101cb">00074</a> eMIN_DISTANCE_ENABLED = 1&lt;&lt;2,
+<a name="l00075"></a><a class="code" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9cef7db4704446fb9dc75d3602f1bfd49">00075</a> eSPRING_ENABLED = 1&lt;&lt;3
+<a name="l00076"></a>00076 };
+<a name="l00077"></a>00077 };
+<a name="l00078"></a>00078
+<a name="l00079"></a><a class="code" href="group__extensions.html#ge24713c38834275bb67d41f03bcd28b5">00079</a> <span class="keyword">typedef</span> <a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxFlags&lt;PxDistanceJointFlag::Enum, PxU16&gt;</a> <a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxDistanceJointFlags</a>;
+<a name="l00080"></a>00080 <a class="code" href="group__foundation.html#g092f922a63fdc7a95ae4f4e24b3768c1">PX_FLAGS_OPERATORS</a>(<a class="code" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9">PxDistanceJointFlag::Enum</a>, <a class="code" href="namespacephysx.html#9caf1cbcda071b6d2a9c069faa99da23">PxU16</a>)
+<a name="l00081"></a>00081
+<a name="l00082"></a>00082
+<a name="l00087"></a><a class="code" href="classPxDistanceJoint.html">00087</a> class <a class="code" href="classPxDistanceJoint.html" title="a joint that maintains an upper or lower bound (or both) on the distance between...">PxDistanceJoint</a> : public <a class="code" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints">PxJoint</a>
+<a name="l00088"></a>00088 {
+<a name="l00089"></a>00089 <span class="keyword">public</span>:
+<a name="l00090"></a>00090
+<a name="l00091"></a>00091
+<a name="l00096"></a>00096 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getDistance() <span class="keyword">const</span> = 0;
+<a name="l00097"></a>00097
+<a name="l00111"></a>00111 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setMinDistance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> distance) = 0;
+<a name="l00112"></a>00112
+<a name="l00121"></a>00121 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getMinDistance() <span class="keyword">const</span> = 0;
+<a name="l00122"></a>00122
+<a name="l00123"></a>00123
+<a name="l00137"></a>00137 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setMaxDistance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> distance) = 0;
+<a name="l00138"></a>00138
+<a name="l00147"></a>00147 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getMaxDistance() <span class="keyword">const</span> = 0;
+<a name="l00148"></a>00148
+<a name="l00149"></a>00149
+<a name="l00158"></a>00158 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setTolerance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> tolerance) = 0;
+<a name="l00159"></a>00159
+<a name="l00160"></a>00160
+<a name="l00174"></a>00174 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getTolerance() <span class="keyword">const</span> = 0;
+<a name="l00175"></a>00175
+<a name="l00189"></a>00189 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStiffness(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> stiffness) = 0;
+<a name="l00190"></a>00190
+<a name="l00199"></a>00199 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getStiffness() <span class="keyword">const</span> = 0;
+<a name="l00200"></a>00200
+<a name="l00201"></a>00201
+<a name="l00215"></a>00215 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDamping(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> damping) = 0;
+<a name="l00216"></a>00216
+<a name="l00217"></a>00217
+<a name="l00226"></a>00226 <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> getDamping() <span class="keyword">const</span> = 0;
+<a name="l00227"></a>00227
+<a name="l00238"></a>00238 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDistanceJointFlags(<a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxDistanceJointFlags</a> flags) = 0;
+<a name="l00239"></a>00239
+<a name="l00240"></a>00240
+<a name="l00250"></a>00250 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setDistanceJointFlag(<a class="code" href="structPxDistanceJointFlag.html#739197f319da75b41a1f3fbcc39607d9">PxDistanceJointFlag::Enum</a> flag, <span class="keywordtype">bool</span> value) = 0;
+<a name="l00251"></a>00251
+<a name="l00260"></a>00260 <span class="keyword">virtual</span> <a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxDistanceJointFlags</a> getDistanceJointFlags(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
+<a name="l00261"></a>00261
+<a name="l00265"></a><a class="code" href="classPxDistanceJoint.html#25ea84cb332b384dba0211731f392c2e">00265</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classPxDistanceJoint.html#25ea84cb332b384dba0211731f392c2e" title="Returns string name of PxDistanceJoint, used for serialization.">getConcreteTypeName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"PxDistanceJoint"</span>; }
+<a name="l00266"></a>00266
+<a name="l00267"></a>00267 <span class="keyword">protected</span>:
+<a name="l00268"></a>00268
+<a name="l00269"></a>00269 <span class="comment">//serialization</span>
+<a name="l00270"></a>00270
+<a name="l00274"></a><a class="code" href="classPxDistanceJoint.html#ae85edd4c5a075bbefb05045efe264dc">00274</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxDistanceJoint.html#ae85edd4c5a075bbefb05045efe264dc" title="Constructor.">PxDistanceJoint</a>(<a class="code" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags) : PxJoint(concreteType, baseFlags) {}
+<a name="l00275"></a>00275
+<a name="l00279"></a><a class="code" href="classPxDistanceJoint.html#e627fb3c5c40d42b32a1373acf62497e">00279</a> <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> <a class="code" href="classPxDistanceJoint.html#e627fb3c5c40d42b32a1373acf62497e" title="Deserialization constructor.">PxDistanceJoint</a>(<a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags) : PxJoint(baseFlags) {}
+<a name="l00280"></a>00280
+<a name="l00284"></a><a class="code" href="classPxDistanceJoint.html#776679114f757961f63b9fd12c2dbae5">00284</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPxDistanceJoint.html#776679114f757961f63b9fd12c2dbae5" 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">"PxDistanceJoint"</span>, name) || <a class="code" href="classPxJoint.html#bf37afb8ce63b5402cf69ab6e9344b28" title="Returns whether a given type name matches with the type of this instance.">PxJoint::isKindOf</a>(name); }
+<a name="l00285"></a>00285
+<a name="l00286"></a>00286 <span class="comment">//~serialization</span>
+<a name="l00287"></a>00287 };
+<a name="l00288"></a>00288
+<a name="l00289"></a>00289 <span class="preprocessor">#if !PX_DOXYGEN</span>
+<a name="l00290"></a>00290 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
+<a name="l00291"></a>00291 <span class="preprocessor">#endif</span>
+<a name="l00292"></a>00292 <span class="preprocessor"></span>
+<a name="l00294"></a>00294 <span class="preprocessor">#endif</span>
+</pre></div></div>
+
+<hr style="width: 100%; height: 2px;"><br>
+Copyright &copy; 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>