aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxSphericalJoint_8h-source.html
blob: 2c70146948e769fe2aa34da4395c419f91c3b874 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxSphericalJoint.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>PxSphericalJoint.h</h1><a href="PxSphericalJoint_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// Redistribution and use in source and binary forms, with or without</span>
<a name="l00003"></a>00003 <span class="comment">// modification, are permitted provided that the following conditions</span>
<a name="l00004"></a>00004 <span class="comment">// are met:</span>
<a name="l00005"></a>00005 <span class="comment">//  * Redistributions of source code must retain the above copyright</span>
<a name="l00006"></a>00006 <span class="comment">//    notice, this list of conditions and the following disclaimer.</span>
<a name="l00007"></a>00007 <span class="comment">//  * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00008"></a>00008 <span class="comment">//    notice, this list of conditions and the following disclaimer in the</span>
<a name="l00009"></a>00009 <span class="comment">//    documentation and/or other materials provided with the distribution.</span>
<a name="l00010"></a>00010 <span class="comment">//  * Neither the name of NVIDIA CORPORATION nor the names of its</span>
<a name="l00011"></a>00011 <span class="comment">//    contributors may be used to endorse or promote products derived</span>
<a name="l00012"></a>00012 <span class="comment">//    from this software without specific prior written permission.</span>
<a name="l00013"></a>00013 <span class="comment">//</span>
<a name="l00014"></a>00014 <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY</span>
<a name="l00015"></a>00015 <span class="comment">// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00016"></a>00016 <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span>
<a name="l00017"></a>00017 <span class="comment">// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span>
<a name="l00018"></a>00018 <span class="comment">// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00019"></a>00019 <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00020"></a>00020 <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00021"></a>00021 <span class="comment">// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY</span>
<a name="l00022"></a>00022 <span class="comment">// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<a name="l00023"></a>00023 <span class="comment">// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<a name="l00024"></a>00024 <span class="comment">// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2018 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_SPHERICALJOINT_H</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_SPHERICALJOINT_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 <span class="preprocessor">#include "<a class="code" href="PxJointLimit_8h.html">extensions/PxJointLimit.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="l00045"></a>00045 <span class="keyword">class </span><a class="code" href="classPxSphericalJoint.html" title="A joint which behaves in a similar way to a ball and socket.">PxSphericalJoint</a>;
<a name="l00046"></a>00046 
<a name="l00059"></a>00059 <a class="code" href="classPxSphericalJoint.html" title="A joint which behaves in a similar way to a ball and socket.">PxSphericalJoint</a>*   <a class="code" href="group__extensions.html#g02d8221452498576e374288ef10b8dc9" title="Create a spherical joint.">PxSphericalJointCreate</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="l00060"></a>00060                                            <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="l00061"></a>00061                                            <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="l00062"></a>00062 
<a name="l00063"></a>00063 
<a name="l00070"></a><a class="code" href="structPxSphericalJointFlag.html">00070</a> <span class="keyword">struct </span><a class="code" href="structPxSphericalJointFlag.html" title="Flags specific to the spherical joint.">PxSphericalJointFlag</a>
<a name="l00071"></a>00071 {
<a name="l00072"></a><a class="code" href="structPxSphericalJointFlag.html#fc657f6cb078dd077c835e798ac56561">00072</a>     <span class="keyword">enum</span> <a class="code" href="structPxSphericalJointFlag.html#fc657f6cb078dd077c835e798ac56561">Enum</a>
<a name="l00073"></a>00073     {
<a name="l00074"></a><a class="code" href="structPxSphericalJointFlag.html#fc657f6cb078dd077c835e798ac56561dc8bbdc303d98a76306bf70548b6435c">00074</a>         eLIMIT_ENABLED  = 1&lt;&lt;1          
<a name="l00075"></a>00075     };
<a name="l00076"></a>00076 };
<a name="l00077"></a><a class="code" href="group__extensions.html#g4e2440ba605d9e05614c938fcb2e6fcb">00077</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;PxSphericalJointFlag::Enum, PxU16&gt;</a> <a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxSphericalJointFlags</a>;
<a name="l00078"></a>00078 <a class="code" href="group__foundation.html#g092f922a63fdc7a95ae4f4e24b3768c1">PX_FLAGS_OPERATORS</a>(<a class="code" href="structPxSphericalJointFlag.html#fc657f6cb078dd077c835e798ac56561">PxSphericalJointFlag::Enum</a>, <a class="code" href="namespacephysx.html#9caf1cbcda071b6d2a9c069faa99da23">PxU16</a>)
<a name="l00079"></a>00079 
<a name="l00080"></a>00080 
<a name="l00095"></a><a class="code" href="classPxSphericalJoint.html">00095</a> class <a class="code" href="classPxSphericalJoint.html" title="A joint which behaves in a similar way to a ball and socket.">PxSphericalJoint</a> : public <a class="code" href="classPxJoint.html" title="a base interface providing common functionality for PhysX joints">PxJoint</a>
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 <span class="keyword">public</span>:
<a name="l00098"></a>00098     
<a name="l00099"></a>00099 
<a name="l00111"></a>00111     <span class="keyword">virtual</span> <a class="code" href="classPxJointLimitCone.html" title="Describes an elliptical conical joint limit. Note that very small or highly elliptical...">PxJointLimitCone</a>    getLimitCone() <span class="keyword">const</span>                                    = 0;
<a name="l00112"></a>00112 
<a name="l00121"></a>00121     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                setLimitCone(<span class="keyword">const</span> <a class="code" href="classPxJointLimitCone.html" title="Describes an elliptical conical joint limit. Note that very small or highly elliptical...">PxJointLimitCone</a> &amp;limit)         = 0;
<a name="l00122"></a>00122 
<a name="l00133"></a>00133     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                setSphericalJointFlags(<a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxSphericalJointFlags</a> flags) = 0;
<a name="l00134"></a>00134 
<a name="l00144"></a>00144     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                setSphericalJointFlag(<a class="code" href="structPxSphericalJointFlag.html#fc657f6cb078dd077c835e798ac56561">PxSphericalJointFlag::Enum</a> flag, <span class="keywordtype">bool</span> value) = 0;
<a name="l00145"></a>00145 
<a name="l00154"></a>00154     <span class="keyword">virtual</span> <a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxSphericalJointFlags</a>   getSphericalJointFlags(<span class="keywordtype">void</span>)                    <span class="keyword">const</span>   = 0;
<a name="l00155"></a>00155 
<a name="l00175"></a>00175     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                setProjectionLinearTolerance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> tolerance)          = 0;
<a name="l00176"></a>00176 
<a name="l00177"></a>00177 
<a name="l00186"></a>00186     <span class="keyword">virtual</span> <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a>              getProjectionLinearTolerance()          <span class="keyword">const</span>           = 0;
<a name="l00187"></a>00187 
<a name="l00191"></a><a class="code" href="classPxSphericalJoint.html#33bc9866342c10b633dffff5536d17ee">00191</a>     <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>*         <a class="code" href="classPxSphericalJoint.html#33bc9866342c10b633dffff5536d17ee" title="Returns string name of PxSphericalJoint, used for serialization.">getConcreteTypeName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"PxSphericalJoint"</span>; }
<a name="l00192"></a>00192 
<a name="l00193"></a>00193 <span class="keyword">protected</span>:
<a name="l00194"></a>00194 
<a name="l00195"></a>00195     <span class="comment">//serialization</span>
<a name="l00196"></a>00196 
<a name="l00200"></a><a class="code" href="classPxSphericalJoint.html#b06e4205a73a38b86f803b33596ff2b0">00200</a>     <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>                   <a class="code" href="classPxSphericalJoint.html#b06e4205a73a38b86f803b33596ff2b0" title="Constructor.">PxSphericalJoint</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="l00201"></a>00201 
<a name="l00205"></a><a class="code" href="classPxSphericalJoint.html#c286965aa17ee29f33dfc66723f30116">00205</a>     <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>                   <a class="code" href="classPxSphericalJoint.html#c286965aa17ee29f33dfc66723f30116" title="Deserialization constructor.">PxSphericalJoint</a>(<a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags) : PxJoint(baseFlags)    {}
<a name="l00206"></a>00206 
<a name="l00210"></a><a class="code" href="classPxSphericalJoint.html#2fa42a5334d0b2395dec6b2be0909dd3">00210</a>     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                <a class="code" href="classPxSphericalJoint.html#2fa42a5334d0b2395dec6b2be0909dd3" 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">"PxSphericalJoint"</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="l00211"></a>00211 
<a name="l00212"></a>00212     <span class="comment">//~serialization</span>
<a name="l00213"></a>00213 
<a name="l00214"></a>00214 };
<a name="l00215"></a>00215 
<a name="l00216"></a>00216 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00217"></a>00217 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
<a name="l00218"></a>00218 <span class="preprocessor">#endif</span>
<a name="l00219"></a>00219 <span class="preprocessor"></span>
<a name="l00221"></a>00221 <span class="preprocessor">#endif</span>
</pre></div></div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2018 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>