aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleFluidReadData.html
blob: 08a6fe2bcb204b0c203ffb13d0000130bfdf9f12 (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: PxParticleFluidReadData Class Reference</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 -->
<div class="contents">
<h1>PxParticleFluidReadData Class Reference<br>
<small>
[<a class="el" href="group__particles.html">particles (deprecated)</a>]</small>
</h1><!-- doxytag: class="PxParticleFluidReadData" --><!-- doxytag: inherits="PxParticleReadData" -->Data layout descriptor for reading fluid particle data from the SDK. (deprecated).  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="PxParticleFluidReadData_8h-source.html">PxParticleFluidReadData.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for PxParticleFluidReadData:</div>
<div class="dynsection">
<p><center><img src="classPxParticleFluidReadData__inherit__graph.png" border="0" usemap="#PxParticleFluidReadData__inherit__map" alt="Inheritance graph"></center>
<map name="PxParticleFluidReadData__inherit__map">
<area shape="rect" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated)." alt="PxParticleReadData" coords="20,85,145,106"><area shape="rect" href="classPxLockedData.html" title="Parent class for bulk data that is shared between the SDK and the application." alt="PxLockedData" coords="36,16,129,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxParticleFluidReadData:</div>
<div class="dynsection">
<p><center><img src="classPxParticleFluidReadData__coll__graph.png" border="0" usemap="#PxParticleFluidReadData__coll__map" alt="Collaboration graph"></center>
<map name="PxParticleFluidReadData__coll__map">
<area shape="rect" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated)." alt="PxParticleReadData" coords="591,136,716,157"><area shape="rect" href="classPxLockedData.html" title="Parent class for bulk data that is shared between the SDK and the application." alt="PxLockedData" coords="237,136,331,157"><area shape="rect" href="classPxStrideIterator.html" title="PxStrideIterator\&lt; const PxF32 \&gt;" alt="PxStrideIterator\&lt; const PxF32 \&gt;" coords="188,45,380,66"><area shape="rect" href="classPxStrideIterator.html" title="PxStrideIterator\&lt; const PxParticleFlags \&gt;" alt="PxStrideIterator\&lt; const PxParticleFlags \&gt;" coords="163,312,405,333"><area shape="rect" href="classPxStrideIterator.html" title="PxStrideIterator\&lt; const PxVec3 \&gt;" alt="PxStrideIterator\&lt; const PxVec3 \&gt;" coords="185,242,383,264"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="19,242,72,264"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classPxParticleFluidReadData-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleFluidReadData.html#b59739e740902e0e0352d9f62adaca94">~PxParticleFluidReadData</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">virtual destructor  <a href="#b59739e740902e0e0352d9f62adaca94"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>&lt; const PxF32 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleFluidReadData.html#faf473d99ac091f4eab7bfa5f8e0f6a1">densityBuffer</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Particle density data.  <a href="#faf473d99ac091f4eab7bfa5f8e0f6a1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Data layout descriptor for reading fluid particle data from the SDK. (deprecated). 
<p>
Additionally to <a class="el" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated).">PxParticleReadData</a>, the density can be read from the SDK.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000092">Deprecated:</a></b></dt><dd>The PhysX particle feature has been deprecated in PhysX version 3.4</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated).">PxParticleReadData</a> <a class="el" href="classPxParticleFluid.html#32d7cf762fd8d1e71b961b0565c06f95" title="Locks the particle data and provides the data descriptor for accessing the particles...">PxParticleFluid.lockParticleFluidReadData()</a> </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b59739e740902e0e0352d9f62adaca94"></a><!-- doxytag: member="PxParticleFluidReadData::~PxParticleFluidReadData" ref="b59739e740902e0e0352d9f62adaca94" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxParticleFluidReadData::~PxParticleFluidReadData           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
virtual destructor 
<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="faf473d99ac091f4eab7bfa5f8e0f6a1"></a><!-- doxytag: member="PxParticleFluidReadData::densityBuffer" ref="faf473d99ac091f4eab7bfa5f8e0f6a1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>&lt;const PxF32&gt; <a class="el" href="classPxParticleFluidReadData.html#faf473d99ac091f4eab7bfa5f8e0f6a1">PxParticleFluidReadData::densityBuffer</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Particle density data. 
<p>
The density depends on how close particles are to each other. The density values are normalized such that: <ol>
<li>
Particles which have no neighbors (no particles closer than restParticleDistance * 2) will have a density of zero. </li>
<li>
Particles which are at rest density (distances corresponding to restParticleDistance in the mean) will have a density of one. </li>
</ol>
<p>
The density buffer is only guaranteed to be valid after the particle fluid has been simulated. Otherwise densityBuffer.ptr() is NULL. This also applies to particle fluids that are not assigned to a scene. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxParticleFluidReadData_8h-source.html">PxParticleFluidReadData.h</a></ul>
</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>