aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxParticleFluid_8h-source.html
blob: 674a7c04694254e277bbd45a7955e6da3ed21325 (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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxParticleFluid.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>PxParticleFluid.h</h1><a href="PxParticleFluid_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_PHYSICS_NX_PARTICLEFLUID</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#define PX_PHYSICS_NX_PARTICLEFLUID</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include "<a class="code" href="PxParticleFluidReadData_8h.html">particles/PxParticleFluidReadData.h</a>"</span>
<a name="l00037"></a>00037 <span class="preprocessor">#include "<a class="code" href="PxParticleBase_8h.html">particles/PxParticleBase.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="l00069"></a><a class="code" href="classPxParticleFluid.html">00069</a> <span class="keyword">class </span><a class="code" href="group__foundation.html#gfd8f8779793627061774cfcfa1b9fbd7">PX_DEPRECATED</a> <a class="code" href="classPxParticleFluid.html" title="The particle fluid class represents the main module for particle based fluid simulation...">PxParticleFluid</a> : <span class="keyword">public</span> <a class="code" href="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation...">PxParticleBase</a>
<a name="l00070"></a>00070 {
<a name="l00071"></a>00071 
<a name="l00072"></a>00072 <span class="keyword">public</span>:
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 <span class="comment">/************************************************************************************************/</span>
<a name="l00075"></a>00075 
<a name="l00079"></a>00079     
<a name="l00086"></a>00086     <span class="keyword">virtual</span>     <a class="code" href="classPxParticleFluidReadData.html" title="Data layout descriptor for reading fluid particle data from the SDK. (deprecated)...">PxParticleFluidReadData</a>*        lockParticleFluidReadData(<a class="code" href="classPxFlags.html" title="Container for bitfield flag variables associated with a specific enum type.">PxDataAccessFlags</a> flags)  = 0;
<a name="l00087"></a>00087 
<a name="l00094"></a>00094     <span class="keyword">virtual</span>     <a class="code" href="classPxParticleFluidReadData.html" title="Data layout descriptor for reading fluid particle data from the SDK. (deprecated)...">PxParticleFluidReadData</a>*        lockParticleFluidReadData() = 0;
<a name="l00095"></a>00095 
<a name="l00097"></a>00097 <span class="comment">/************************************************************************************************/</span>
<a name="l00098"></a>00098 
<a name="l00099"></a>00099 
<a name="l00103"></a>00103 
<a name="l00109"></a>00109     <span class="keyword">virtual</span>     <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a>                          getStiffness()                                          <span class="keyword">const</span>   = 0;
<a name="l00110"></a>00110 
<a name="l00116"></a>00116     <span class="keyword">virtual</span>     <span class="keywordtype">void</span>                            setStiffness(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> stiffness)                                  = 0;
<a name="l00117"></a>00117 
<a name="l00123"></a>00123     <span class="keyword">virtual</span>     <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a>                          getViscosity()                                          <span class="keyword">const</span>   = 0;
<a name="l00124"></a>00124 
<a name="l00130"></a>00130     <span class="keyword">virtual</span>     <span class="keywordtype">void</span>                            setViscosity(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> viscosity)                                  = 0;
<a name="l00131"></a>00131 
<a name="l00133"></a>00133 <span class="comment">/************************************************************************************************/</span>
<a name="l00134"></a>00134 
<a name="l00138"></a>00138 
<a name="l00144"></a>00144     <span class="keyword">virtual</span>     <a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a>                          getRestParticleDistance()                               <span class="keyword">const</span>   = 0;
<a name="l00145"></a>00145 
<a name="l00147"></a>00147 <span class="comment">/************************************************************************************************/</span>
<a name="l00148"></a>00148 
<a name="l00152"></a>00152 
<a name="l00158"></a>00158     <span class="keyword">virtual</span>     <span class="keywordtype">void</span>                            setRestParticleDistance(<a class="code" href="namespacephysx.html#727d2d8426e2a21ebbc522fa65c3f97a">PxReal</a> restParticleDistance)            = 0;
<a name="l00159"></a>00159 
<a name="l00161"></a>00161 <span class="comment">/************************************************************************************************/</span>
<a name="l00162"></a>00162 
<a name="l00163"></a><a class="code" href="classPxParticleFluid.html#1ed3457d33695b2bc6742ea45e2d99e9">00163</a>     <span class="keyword">virtual</span>     <span class="keyword">const</span> <span class="keywordtype">char</span>*                     <a class="code" href="classPxParticleFluid.html#1ed3457d33695b2bc6742ea45e2d99e9" title="Returns string name of dynamic type.">getConcreteTypeName</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"PxParticleFluid"</span>; }
<a name="l00164"></a>00164 
<a name="l00165"></a>00165 <span class="keyword">protected</span>:
<a name="l00166"></a><a class="code" href="classPxParticleFluid.html#a47d7c6c87f093ecf774b1a164b294b5">00166</a>     <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>                                   <a class="code" href="classPxParticleFluid.html#a47d7c6c87f093ecf774b1a164b294b5">PxParticleFluid</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="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation...">PxParticleBase</a>(concreteType, baseFlags) {}
<a name="l00167"></a><a class="code" href="classPxParticleFluid.html#1355760c2e345ab70190308946fbd825">00167</a>     <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a>                                   <a class="code" href="classPxParticleFluid.html#1355760c2e345ab70190308946fbd825">PxParticleFluid</a>(<a class="code" href="classPxFlags.html">PxBaseFlags</a> baseFlags) : <a class="code" href="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation...">PxParticleBase</a>(baseFlags) {}
<a name="l00168"></a><a class="code" href="classPxParticleFluid.html#2025a7991e04e74dc8c62b38784b205d">00168</a>     <span class="keyword">virtual</span>                                     <a class="code" href="classPxParticleFluid.html#2025a7991e04e74dc8c62b38784b205d">~PxParticleFluid</a>() {}
<a name="l00169"></a><a class="code" href="classPxParticleFluid.html#0db52e5bf2c3ba3ee1e4c2eec3a18a74">00169</a>     <span class="keyword">virtual</span>     <span class="keywordtype">bool</span>                            <a class="code" href="classPxParticleFluid.html#0db52e5bf2c3ba3ee1e4c2eec3a18a74" 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">"PxParticleFluid"</span>, name) || <a class="code" href="classPxParticleBase.html#61ea48642f847d81588a2c9e442fe8a0" title="Returns whether a given type name matches with the type of this instance.">PxParticleBase::isKindOf</a>(name);  }
<a name="l00170"></a>00170 };
<a name="l00171"></a>00171 
<a name="l00172"></a>00172 <span class="preprocessor">#if !PX_DOXYGEN</span>
<a name="l00173"></a>00173 <span class="preprocessor"></span>} <span class="comment">// namespace physx</span>
<a name="l00174"></a>00174 <span class="preprocessor">#endif</span>
<a name="l00175"></a>00175 <span class="preprocessor"></span>
<a name="l00177"></a>00177 <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>