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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
<html>
<head>
<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxParticleSystem 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>
<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 -->
<div class="contents">
<h1>PxParticleSystem Class Reference<br>
<small>
[<a class="el" href="group__particles.html">particles (deprecated)</a>]</small>
</h1><!-- doxytag: class="PxParticleSystem" --><!-- doxytag: inherits="PxParticleBase" -->The particle system class represents the main module for particle based simulation. (deprecated).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="PxParticleSystem_8h-source.html">PxParticleSystem.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PxParticleSystem:</div>
<div class="dynsection">
<p><center><img src="classPxParticleSystem__inherit__graph.png" border="0" usemap="#PxParticleSystem__inherit__map" alt="Inheritance graph"></center>
<map name="PxParticleSystem__inherit__map">
<area shape="rect" href="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation..." alt="PxParticleBase" coords="13,155,112,176"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="36,86,89,107"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="35,16,91,38"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for PxParticleSystem:</div>
<div class="dynsection">
<p><center><img src="classPxParticleSystem__coll__graph.png" border="0" usemap="#PxParticleSystem__coll__map" alt="Collaboration graph"></center>
<map name="PxParticleSystem__coll__map">
<area shape="rect" href="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation..." alt="PxParticleBase" coords="76,250,175,272"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="99,178,152,200"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="97,106,153,128"><area shape="rect" href="classPxFlags.html" title="PxFlags\< PxBaseFlag::Enum, PxU16 \>" alt="PxFlags\< PxBaseFlag::Enum, PxU16 \>" coords="7,16,244,37"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPxParticleSystem-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 const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleSystem.html#d01ae909bd27f8ef569114652a21170f">getConcreteTypeName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns string name of dynamic type. <a href="#d01ae909bd27f8ef569114652a21170f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleSystem.html#fd52afc4a8cff4049dc6a7db67c6d75f">PxParticleSystem</a> (<a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> concreteType, <a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleSystem.html#0ccb6322e44707a5384912d0a0fd6003">PxParticleSystem</a> (<a class="el" href="classPxFlags.html">PxBaseFlags</a> baseFlags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleSystem.html#718ff09317aacfd68666e0f1104b2c2d">~PxParticleSystem</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleSystem.html#5ca70971bfaa280a0401152ce3fc5fe6">isKindOf</a> (const char *name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a given type name matches with the type of this instance. <a href="#5ca70971bfaa280a0401152ce3fc5fe6"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The particle system class represents the main module for particle based simulation. (deprecated).
<p>
This class inherits the properties of the <a class="el" href="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation...">PxParticleBase</a> class.<p>
The particle system class manages a set of particles. Particles can be created, released and updated directly through the API. When a particle is created the user gets an id for it which can be used to address the particle until it is released again.<p>
Particles collide with static and dynamic shapes. They are also affected by the scene gravity and a user force, as well as global velocity damping. When a particle collides, a particle flag is raised corresponding to the type of actor, static or dynamic, it collided with. Additionally a shape can be flagged as a drain (See <a class="el" href="structPxShapeFlag.html" title="Flags which affect the behavior of PxShapes.">PxShapeFlag</a>), in order to get a corresponding particle flag raised when a collision occurs. This information can be used to delete particles.<p>
The particles of a particle system don't collide with each other. In order to simulate particle-particle interactions use the subclass <a class="el" href="classPxParticleFluid.html" title="The particle fluid class represents the main module for particle based fluid simulation...">PxParticleFluid</a>.<p>
<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000097">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="classPxParticleBase.html" title="The particle base class represents the shared module for particle based simulation...">PxParticleBase</a>, <a class="el" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated).">PxParticleReadData</a>, <a class="el" href="classPxPhysics.html#fc569d866211bc45d7ab01002a0dadca" title="Creates a particle system. (deprecated).">PxPhysics.createParticleSystem</a> </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="fd52afc4a8cff4049dc6a7db67c6d75f"></a><!-- doxytag: member="PxParticleSystem::PxParticleSystem" ref="fd52afc4a8cff4049dc6a7db67c6d75f" args="(PxType concreteType, PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxParticleSystem::PxParticleSystem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__common.html#gc1fb4b256a5d900d394e89db170a2b79">PxType</a> </td>
<td class="paramname"> <em>concreteType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td>
<td class="paramname"> <em>baseFlags</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0ccb6322e44707a5384912d0a0fd6003"></a><!-- doxytag: member="PxParticleSystem::PxParticleSystem" ref="0ccb6322e44707a5384912d0a0fd6003" args="(PxBaseFlags baseFlags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PX_INLINE PxParticleSystem::PxParticleSystem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPxFlags.html">PxBaseFlags</a> </td>
<td class="paramname"> <em>baseFlags</em> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="718ff09317aacfd68666e0f1104b2c2d"></a><!-- doxytag: member="PxParticleSystem::~PxParticleSystem" ref="718ff09317aacfd68666e0f1104b2c2d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PxParticleSystem::~PxParticleSystem </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d01ae909bd27f8ef569114652a21170f"></a><!-- doxytag: member="PxParticleSystem::getConcreteTypeName" ref="d01ae909bd27f8ef569114652a21170f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* PxParticleSystem::getConcreteTypeName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns string name of dynamic type.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Class name of most derived type of this object. </dd></dl>
<p>Implements <a class="el" href="classPxBase.html#67fe206d8897ddce896c371ac8d789a9">PxBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="5ca70971bfaa280a0401152ce3fc5fe6"></a><!-- doxytag: member="PxParticleSystem::isKindOf" ref="5ca70971bfaa280a0401152ce3fc5fe6" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PxParticleSystem::isKindOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>superClass</em> </td>
<td> ) </td>
<td> const<code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns whether a given type name matches with the type of this instance.
<p>
<p>Reimplemented from <a class="el" href="classPxParticleBase.html#61ea48642f847d81588a2c9e442fe8a0">PxParticleBase</a>.</p>
<p>References <a class="el" href="PxParticleBase_8h-source.html#l00456">PxParticleBase::isKindOf()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxParticleSystem_8h-source.html">PxParticleSystem.h</a></ul>
</div>
<hr style="width: 100%; height: 2px;"><br>
Copyright © 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>
|