diff options
| author | git perforce import user <a@b> | 2016-10-25 12:29:14 -0600 |
|---|---|---|
| committer | Sheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees> | 2016-10-25 18:56:37 -0500 |
| commit | 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch) | |
| tree | fa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleBase.html | |
| download | physx-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/classPxParticleBase.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleBase.html | 1381 |
1 files changed, 1381 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleBase.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleBase.html new file mode 100644 index 00000000..84e21464 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleBase.html @@ -0,0 +1,1381 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxParticleBase 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>PxParticleBase Class Reference<br> +<small> +[<a class="el" href="group__particles.html">particles (deprecated)</a>]</small> +</h1><!-- doxytag: class="PxParticleBase" --><!-- doxytag: inherits="PxActor" -->The particle base class represents the shared module for particle based simulation. This class can't be instantiated. (deprecated). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxParticleBase_8h-source.html">PxParticleBase.h</a>></code> +<p> +<div class="dynheader"> +Inheritance diagram for PxParticleBase:</div> +<div class="dynsection"> +<p><center><img src="classPxParticleBase__inherit__graph.png" border="0" usemap="#PxParticleBase__inherit__map" alt="Inheritance graph"></center> +<map name="PxParticleBase__inherit__map"> +<area shape="rect" href="classPxParticleFluid.html" title="The particle fluid class represents the main module for particle based fluid simulation..." alt="PxParticleFluid" coords="7,224,100,246"><area shape="rect" href="classPxParticleSystem.html" title="The particle system class represents the main module for particle based simulation..." alt="PxParticleSystem" coords="124,224,236,246"><area shape="rect" href="classPxActor.html" title="PxActor is the base class for the main simulation objects in the physics SDK." alt="PxActor" coords="89,86,143,107"><area shape="rect" href="classPxBase.html" title="Base class for objects that can be members of a PxCollection." alt="PxBase" coords="88,16,144,38"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> +<div class="dynheader"> +Collaboration diagram for PxParticleBase:</div> +<div class="dynsection"> +<p><center><img src="classPxParticleBase__coll__graph.png" border="0" usemap="#PxParticleBase__coll__map" alt="Collaboration graph"></center> +<map name="PxParticleBase__coll__map"> +<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="classPxParticleBase-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#4445c7746cfd5cbcda51173d0cf5c93a">setParticleBaseFlag</a> (<a class="el" href="structPxParticleBaseFlag.html#133d603af58af35124b6bea1977b5bc3">PxParticleBaseFlag::Enum</a> flag, bool val)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets particle system flags. <a href="#4445c7746cfd5cbcda51173d0cf5c93a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__particles.html#gd9a0f233df7019b50efb5fa8833610b9">PxParticleBaseFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#b7b8a318215e2a0a06446753e905bcd1">getParticleBaseFlags</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns particle system flags. <a href="#b7b8a318215e2a0a06446753e905bcd1"></a><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Particle Access and Manipulation</div></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxParticleReadData.html">PxParticleReadData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#a21d6efb9270614ce351db59e6643c51">lockParticleReadData</a> (<a class="el" href="classPxFlags.html">PxDataAccessFlags</a> flags)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Locks the particle data and provides the data descriptor for accessing the particles. After reading from the buffers the application needs to call <a class="el" href="classPxParticleReadData.html#91ffb8c566135b08fca268b2636ffb68" title="Unlocks the data.">PxParticleReadData::unlock()</a> before any SDK operation can access the buffers. Particularly the buffers need to be unlocked before calling <a class="el" href="classPxParticleBase.html#83e1673959b4e6f954173368a6c78ef6" title="Locks the particle read data and provides the data descriptor for accessing the particles...">PxParticleBase::lockParticleReadData()</a>, <a class="el" href="classPxParticleBase.html#f35d1dfda5ddb3c48855272ac4b702ad" title="Creates new particles.">PxParticleBase::createParticles()</a>, <a class="el" href="classPxParticleBase.html#fd32e1e6ffa0647a2c296bc8635ca99c" title="Releases all particles.">PxParticleBase::releaseParticles()</a>, <a class="el" href="classPxScene.html#b34e054ccf428a1cdbd81bf1e2b87fae">PxScene::fetchResults()</a>. <a href="#a21d6efb9270614ce351db59e6643c51"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxParticleReadData.html">PxParticleReadData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#83e1673959b4e6f954173368a6c78ef6">lockParticleReadData</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Locks the particle read data and provides the data descriptor for accessing the particles. <a href="#83e1673959b4e6f954173368a6c78ef6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#f35d1dfda5ddb3c48855272ac4b702ad">createParticles</a> (const <a class="el" href="classPxParticleCreationData.html">PxParticleCreationData</a> &creationData)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates new particles. <a href="#f35d1dfda5ddb3c48855272ac4b702ad"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#318b187bebc71828651f3ffc8b2bd9a9">releaseParticles</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> numParticles, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases particles. <a href="#318b187bebc71828651f3ffc8b2bd9a9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#fd32e1e6ffa0647a2c296bc8635ca99c">releaseParticles</a> ()=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Releases all particles. <a href="#fd32e1e6ffa0647a2c296bc8635ca99c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#4fba51bed2ec1b3445885916350b10d5">setPositions</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> numParticles, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > &positionBuffer)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets particle positions. <a href="#4fba51bed2ec1b3445885916350b10d5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#f73716656e6d6efef3a5650f9e04ffe3">setVelocities</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> numParticles, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > &velocityBuffer)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets particle velocities. <a href="#f73716656e6d6efef3a5650f9e04ffe3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#4b193d290509a4442ed0110580a16447">setRestOffsets</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> numParticles, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const PxF32 > &restOffsetBuffer)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets particle rest offsets. <a href="#4b193d290509a4442ed0110580a16447"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#f5ed504bf593d85dd50c2838d3d40933">addForces</a> (<a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> numParticles, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > &indexBuffer, const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > &forceBuffer, <a class="el" href="structPxForceMode.html#adaaafefe0478d829b816154c676e545">PxForceMode::Enum</a> forceMode)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set forces to be applied to the particles when the simulation starts. <a href="#f5ed504bf593d85dd50c2838d3d40933"></a><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">ParticleBase Parameters</div></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#edf534fec3c9ca3008e8eebb718d91bf">getDamping</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the particle system damping. <a href="#edf534fec3c9ca3008e8eebb718d91bf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#8fb190deeb6744368762b296d8819eeb">setDamping</a> (PxReal damp)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the particle system damping (must be nonnegative). <a href="#8fb190deeb6744368762b296d8819eeb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPxVec3.html">PxVec3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#7e39c7791bf865d3a12582068ffd997e">getExternalAcceleration</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the external acceleration applied to each particle at each time step. <a href="#7e39c7791bf865d3a12582068ffd997e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#b43431b492105e432f1f5eb33fabd0c4">setExternalAcceleration</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &acceleration)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the external acceleration applied to each particle at each time step. <a href="#b43431b492105e432f1f5eb33fabd0c4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#9d6cf609acc383d72151ca99e7091054">getProjectionPlane</a> (<a class="el" href="classPxVec3.html">PxVec3</a> &normal, PxReal &distance) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the plane the particles are projected to. <a href="#9d6cf609acc383d72151ca99e7091054"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#59216c6fd900d478cd1e75b0a34b37af">setProjectionPlane</a> (const <a class="el" href="classPxVec3.html">PxVec3</a> &normal, PxReal distance)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the plane the particles are projected to. <a href="#59216c6fd900d478cd1e75b0a34b37af"></a><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Collisions</div></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#badacdb02db9c5c3088ffec96d8a94fb">getParticleMass</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the mass of a particle. <a href="#badacdb02db9c5c3088ffec96d8a94fb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#80881666e5ee6743b6ac2c1f8723ce19">setParticleMass</a> (PxReal mass)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the mass of a particle. <a href="#80881666e5ee6743b6ac2c1f8723ce19"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#f685d7f2c306a42d345fcde35a2bf6fa">getRestitution</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the restitution used for collision with shapes. <a href="#f685d7f2c306a42d345fcde35a2bf6fa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#7dc8dc59b5032d7e4ebd9d901df20a3d">setRestitution</a> (PxReal rest)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the restitution used for collision with shapes. <a href="#7dc8dc59b5032d7e4ebd9d901df20a3d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#266449d2ac89ed540deeb7187ba59696">getDynamicFriction</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the dynamic friction used for collision with shapes. <a href="#266449d2ac89ed540deeb7187ba59696"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#d95b342c529785ca7e126605804ccfbb">setDynamicFriction</a> (PxReal friction)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the dynamic friction used for collision with shapes. <a href="#d95b342c529785ca7e126605804ccfbb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#490ead77cd5a791537c209c5650a8d0c">getStaticFriction</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the static friction used for collision with shapes. <a href="#490ead77cd5a791537c209c5650a8d0c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#3fb596178c017ed1c536c152e4fba358">setStaticFriction</a> (PxReal friction)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the static friction used for collision with shapes. <a href="#3fb596178c017ed1c536c152e4fba358"></a><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Collision Filtering</div></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#c9babb704b6400ee1a11b1d17439b362">setSimulationFilterData</a> (const <a class="el" href="structPxFilterData.html">PxFilterData</a> &data)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the user definable collision filter data. <a href="#c9babb704b6400ee1a11b1d17439b362"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structPxFilterData.html">PxFilterData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#12bf74e45c36e867894bc775a83a0593">getSimulationFilterData</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the object's collision filter data. <a href="#12bf74e45c36e867894bc775a83a0593"></a><br></td></tr> +<tr><td colspan="2"><br><h2>ParticleSystem Property Read Back</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#17ad9d3e2844ae50799e9bd6373eade2">getMaxParticles</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximum number of particles for this particle system. <a href="#17ad9d3e2844ae50799e9bd6373eade2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#243ce7ab61aced90ffe823d5cb9f5dfc">getMaxMotionDistance</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the maximal motion distance (the particle can move the maximal distance of <a class="el" href="classPxParticleBase.html#243ce7ab61aced90ffe823d5cb9f5dfc" title="Returns the maximal motion distance (the particle can move the maximal distance of...">getMaxMotionDistance()</a> during one timestep). <a href="#243ce7ab61aced90ffe823d5cb9f5dfc"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#0e768c7a7e0375b870078d45c890721e">setMaxMotionDistance</a> (PxReal distance)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximal motion distance (the particle can move the maximal distance during one timestep). Immutable when the particle system is part of a scene. <a href="#0e768c7a7e0375b870078d45c890721e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#8b52436ee7a5587fff1220954535d261">getRestOffset</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance between particles and collision geometry, which is maintained during simulation. <a href="#8b52436ee7a5587fff1220954535d261"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#9c5759758c6fcaf61759dacea5d4653d">setRestOffset</a> (PxReal restOffset)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the distance between particles and collision geometry, which is maintained during simulation. If per particle restOffsets are used, they need to be in the range [0.0f, restOffset]. Immutable when the particle system is part of a scene. <a href="#9c5759758c6fcaf61759dacea5d4653d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#743ec105fe0fb589030466165282db70">getContactOffset</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance at which contacts are generated between particles and collision geometry. <a href="#743ec105fe0fb589030466165282db70"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#1daf9cb4e5b4a0abbfee215c144582e4">setContactOffset</a> (PxReal contactOffset)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the distance at which contacts are generated between particles and collision geometry. Immutable when the particle system is part of a scene. <a href="#1daf9cb4e5b4a0abbfee215c144582e4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PxReal </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#18c0ba576f9d7d28b4084e9709794166">getGridSize</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the particle grid size used for internal spatial data structures. <a href="#18c0ba576f9d7d28b4084e9709794166"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#f484aea29669a33f8bf78465d2d2f8b4">setGridSize</a> (PxReal gridSize)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the particle grid size used for internal spatial data structures. Immutable when the particle system is part of a scene. The actual grid size used might differ from the grid size set in the <a class="el" href="classPxParticleBase.html#f484aea29669a33f8bf78465d2d2f8b4" title="Sets the particle grid size used for internal spatial data structures. Immutable...">setGridSize()</a>. <a href="#f484aea29669a33f8bf78465d2d2f8b4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__particles.html#g7eb9d4fd42d62041395fa34b23f56248">PxParticleReadDataFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#8be6672d3d649d24de52db500ffb1a4e">getParticleReadDataFlags</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns particle read data flags. <a href="#8be6672d3d649d24de52db500ffb1a4e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#9fbba67f740bc2b915ce0eb8d5c1b099">setParticleReadDataFlag</a> (<a class="el" href="structPxParticleReadDataFlag.html#e228980b8744bbaa5c1567a17183ae71">PxParticleReadDataFlag::Enum</a> flag, bool val)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets particle read data flags. <a href="#9fbba67f740bc2b915ce0eb8d5c1b099"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#1688c7c5736ab69e7606d419daccfe39">PxParticleBase</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="classPxParticleBase.html#328a22534db4e5585a0b9e17f0e83d05">PxParticleBase</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="classPxParticleBase.html#5c421fed2304bd2bb23cca41760eea19">~PxParticleBase</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleBase.html#61ea48642f847d81588a2c9e442fe8a0">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="#61ea48642f847d81588a2c9e442fe8a0"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The particle base class represents the shared module for particle based simulation. This class can't be instantiated. (deprecated). +<p> +The particle base 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 index 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> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000051">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="classPxParticleCreationData.html" title="Descriptor-like user-side class describing buffers for particle creation. (deprecated)...">PxParticleCreationData</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="structPxShapeFlag.html" title="Flags which affect the behavior of PxShapes.">PxShapeFlag</a>, <a class="el" href="classPxParticleSystem.html" title="The particle system class represents the main module for particle based simulation...">PxParticleSystem</a>, <a class="el" href="classPxParticleFluid.html" title="The particle fluid class represents the main module for particle based fluid simulation...">PxParticleFluid</a> </dd></dl> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="1688c7c5736ab69e7606d419daccfe39"></a><!-- doxytag: member="PxParticleBase::PxParticleBase" ref="1688c7c5736ab69e7606d419daccfe39" args="(PxType concreteType, PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxParticleBase::PxParticleBase </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="328a22534db4e5585a0b9e17f0e83d05"></a><!-- doxytag: member="PxParticleBase::PxParticleBase" ref="328a22534db4e5585a0b9e17f0e83d05" args="(PxBaseFlags baseFlags)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PX_INLINE PxParticleBase::PxParticleBase </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="5c421fed2304bd2bb23cca41760eea19"></a><!-- doxytag: member="PxParticleBase::~PxParticleBase" ref="5c421fed2304bd2bb23cca41760eea19" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxParticleBase::~PxParticleBase </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="f5ed504bf593d85dd50c2838d3d40933"></a><!-- doxytag: member="PxParticleBase::addForces" ref="f5ed504bf593d85dd50c2838d3d40933" args="(PxU32 numParticles, const PxStrideIterator< const PxU32 > &indexBuffer, const PxStrideIterator< const PxVec3 > &forceBuffer, PxForceMode::Enum forceMode)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::addForces </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>numParticles</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td> + <td class="paramname"> <em>indexBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > & </td> + <td class="paramname"> <em>forceBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structPxForceMode.html#adaaafefe0478d829b816154c676e545">PxForceMode::Enum</a> </td> + <td class="paramname"> <em>forceMode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set forces to be applied to the particles when the simulation starts. +<p> +This call is ignored on particle system that aren't assigned to a scene.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>numParticles</em> </td><td>Number of particle updates. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>indexBuffer</em> </td><td>Structure describing indices of particles that should be updated. (Has to be consistent with numParticles). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>forceBuffer</em> </td><td>Structure describing values for particle updates depending on forceMode. (Has to be consistent with numParticles). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>forceMode</em> </td><td>Describes type of update. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="f35d1dfda5ddb3c48855272ac4b702ad"></a><!-- doxytag: member="PxParticleBase::createParticles" ref="f35d1dfda5ddb3c48855272ac4b702ad" args="(const PxParticleCreationData &creationData)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxParticleBase::createParticles </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxParticleCreationData.html">PxParticleCreationData</a> & </td> + <td class="paramname"> <em>creationData</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates new particles. +<p> +The <a class="el" href="classPxParticleCreationData.html" title="Descriptor-like user-side class describing buffers for particle creation. (deprecated)...">PxParticleCreationData</a> descriptor is used to create new particles based on the provided <a class="el" href="classPxParticleCreationData.html" title="Descriptor-like user-side class describing buffers for particle creation. (deprecated)...">PxParticleCreationData</a>. Providing particle indices and positions is mandatory. Indices need to be consistent with the available particle slots within the range [0, maxParticles-1]. The new particles can be immediately read from the application readable particle data, <a class="el" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated).">PxParticleReadData</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>creationData</em> </td><td>specifies particle attributes for the particles to be created. (all buffers set have to be consistent with numParticles). </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>whether the operation was successful.</dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxParticleCreationData.html" title="Descriptor-like user-side class describing buffers for particle creation. (deprecated)...">PxParticleCreationData</a>, <a class="el" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated).">PxParticleReadData</a>, PxParticlesExt.IndexPool </dd></dl> + +</div> +</div><p> +<a class="anchor" name="743ec105fe0fb589030466165282db70"></a><!-- doxytag: member="PxParticleBase::getContactOffset" ref="743ec105fe0fb589030466165282db70" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getContactOffset </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the distance at which contacts are generated between particles and collision geometry. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>contact offset. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="edf534fec3c9ca3008e8eebb718d91bf"></a><!-- doxytag: member="PxParticleBase::getDamping" ref="edf534fec3c9ca3008e8eebb718d91bf" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getDamping </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the particle system damping. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The particle system damping. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="266449d2ac89ed540deeb7187ba59696"></a><!-- doxytag: member="PxParticleBase::getDynamicFriction" ref="266449d2ac89ed540deeb7187ba59696" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getDynamicFriction </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the dynamic friction used for collision with shapes. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The dynamic friction. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7e39c7791bf865d3a12582068ffd997e"></a><!-- doxytag: member="PxParticleBase::getExternalAcceleration" ref="7e39c7791bf865d3a12582068ffd997e" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxVec3.html">PxVec3</a> PxParticleBase::getExternalAcceleration </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the external acceleration applied to each particle at each time step. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The external acceleration applied to particles. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="18c0ba576f9d7d28b4084e9709794166"></a><!-- doxytag: member="PxParticleBase::getGridSize" ref="18c0ba576f9d7d28b4084e9709794166" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getGridSize </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the particle grid size used for internal spatial data structures. +<p> +The actual grid size used might differ from the grid size set in the <a class="el" href="classPxParticleBase.html#f484aea29669a33f8bf78465d2d2f8b4" title="Sets the particle grid size used for internal spatial data structures. Immutable...">setGridSize()</a>.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The grid size. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="243ce7ab61aced90ffe823d5cb9f5dfc"></a><!-- doxytag: member="PxParticleBase::getMaxMotionDistance" ref="243ce7ab61aced90ffe823d5cb9f5dfc" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getMaxMotionDistance </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the maximal motion distance (the particle can move the maximal distance of <a class="el" href="classPxParticleBase.html#243ce7ab61aced90ffe823d5cb9f5dfc" title="Returns the maximal motion distance (the particle can move the maximal distance of...">getMaxMotionDistance()</a> during one timestep). +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>maximum motion distance. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="17ad9d3e2844ae50799e9bd6373eade2"></a><!-- doxytag: member="PxParticleBase::getMaxParticles" ref="17ad9d3e2844ae50799e9bd6373eade2" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> PxParticleBase::getMaxParticles </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the maximum number of particles for this particle system. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Max number of particles for this particle system. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b7b8a318215e2a0a06446753e905bcd1"></a><!-- doxytag: member="PxParticleBase::getParticleBaseFlags" ref="b7b8a318215e2a0a06446753e905bcd1" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__particles.html#gd9a0f233df7019b50efb5fa8833610b9">PxParticleBaseFlags</a> PxParticleBase::getParticleBaseFlags </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns particle system flags. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The current flag values. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="badacdb02db9c5c3088ffec96d8a94fb"></a><!-- doxytag: member="PxParticleBase::getParticleMass" ref="badacdb02db9c5c3088ffec96d8a94fb" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getParticleMass </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the mass of a particle. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Particle mass. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8be6672d3d649d24de52db500ffb1a4e"></a><!-- doxytag: member="PxParticleBase::getParticleReadDataFlags" ref="8be6672d3d649d24de52db500ffb1a4e" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="group__particles.html#g7eb9d4fd42d62041395fa34b23f56248">PxParticleReadDataFlags</a> PxParticleBase::getParticleReadDataFlags </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns particle read data flags. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The particle read data flags. </dd></dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__particles.html#g7eb9d4fd42d62041395fa34b23f56248" title="collection of set bits defined in PxParticleReadDataFlag. (deprecated)">PxParticleReadDataFlags</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9d6cf609acc383d72151ca99e7091054"></a><!-- doxytag: member="PxParticleBase::getProjectionPlane" ref="9d6cf609acc383d72151ca99e7091054" args="(PxVec3 &normal, PxReal &distance) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::getProjectionPlane </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>normal</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal & </td> + <td class="paramname"> <em>distance</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the plane the particles are projected to. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>normal</em> </td><td>Particle projection plane normal </td></tr> + <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>distance</em> </td><td>Particle projection plane constant term </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="f685d7f2c306a42d345fcde35a2bf6fa"></a><!-- doxytag: member="PxParticleBase::getRestitution" ref="f685d7f2c306a42d345fcde35a2bf6fa" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getRestitution </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the restitution used for collision with shapes. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The restitution. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8b52436ee7a5587fff1220954535d261"></a><!-- doxytag: member="PxParticleBase::getRestOffset" ref="8b52436ee7a5587fff1220954535d261" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getRestOffset </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the distance between particles and collision geometry, which is maintained during simulation. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>rest offset. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="12bf74e45c36e867894bc775a83a0593"></a><!-- doxytag: member="PxParticleBase::getSimulationFilterData" ref="12bf74e45c36e867894bc775a83a0593" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="structPxFilterData.html">PxFilterData</a> PxParticleBase::getSimulationFilterData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Retrieves the object's collision filter data. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxParticleBase.html#c9babb704b6400ee1a11b1d17439b362" title="Sets the user definable collision filter data.">setSimulationFilterData()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="490ead77cd5a791537c209c5650a8d0c"></a><!-- doxytag: member="PxParticleBase::getStaticFriction" ref="490ead77cd5a791537c209c5650a8d0c" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual PxReal PxParticleBase::getStaticFriction </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the static friction used for collision with shapes. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The static friction. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="61ea48642f847d81588a2c9e442fe8a0"></a><!-- doxytag: member="PxParticleBase::isKindOf" ref="61ea48642f847d81588a2c9e442fe8a0" args="(const char *name) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool PxParticleBase::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="classPxActor.html#fe6ddb3480f61350f60496c2e903c5c7">PxActor</a>.</p> + +<p>Reimplemented in <a class="el" href="classPxParticleFluid.html#0db52e5bf2c3ba3ee1e4c2eec3a18a74">PxParticleFluid</a>, and <a class="el" href="classPxParticleSystem.html#5ca70971bfaa280a0401152ce3fc5fe6">PxParticleSystem</a>.</p> + +<p>References <a class="el" href="PxActor_8h-source.html#l00376">PxActor::isKindOf()</a>.</p> + +<p>Referenced by <a class="el" href="PxParticleSystem_8h-source.html#l00076">PxParticleSystem::isKindOf()</a>, and <a class="el" href="PxParticleFluid_8h-source.html#l00169">PxParticleFluid::isKindOf()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="83e1673959b4e6f954173368a6c78ef6"></a><!-- doxytag: member="PxParticleBase::lockParticleReadData" ref="83e1673959b4e6f954173368a6c78ef6" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxParticleReadData.html">PxParticleReadData</a>* PxParticleBase::lockParticleReadData </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Locks the particle read data and provides the data descriptor for accessing the particles. +<p> +<dl class="note" compact><dt><b>Note:</b></dt><dd>This method does the same as lockParticleReadData(PxDataAccessFlags::eREADABLE) </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> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a21d6efb9270614ce351db59e6643c51"></a><!-- doxytag: member="PxParticleBase::lockParticleReadData" ref="a21d6efb9270614ce351db59e6643c51" args="(PxDataAccessFlags flags)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classPxParticleReadData.html">PxParticleReadData</a>* PxParticleBase::lockParticleReadData </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classPxFlags.html">PxDataAccessFlags</a> </td> + <td class="paramname"> <em>flags</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Locks the particle data and provides the data descriptor for accessing the particles. After reading from the buffers the application needs to call <a class="el" href="classPxParticleReadData.html#91ffb8c566135b08fca268b2636ffb68" title="Unlocks the data.">PxParticleReadData::unlock()</a> before any SDK operation can access the buffers. Particularly the buffers need to be unlocked before calling <a class="el" href="classPxParticleBase.html#83e1673959b4e6f954173368a6c78ef6" title="Locks the particle read data and provides the data descriptor for accessing the particles...">PxParticleBase::lockParticleReadData()</a>, <a class="el" href="classPxParticleBase.html#f35d1dfda5ddb3c48855272ac4b702ad" title="Creates new particles.">PxParticleBase::createParticles()</a>, <a class="el" href="classPxParticleBase.html#fd32e1e6ffa0647a2c296bc8635ca99c" title="Releases all particles.">PxParticleBase::releaseParticles()</a>, <a class="el" href="classPxScene.html#b34e054ccf428a1cdbd81bf1e2b87fae">PxScene::fetchResults()</a>. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>If <a class="el" href="structPxDataAccessFlag.html#b6bd468adf2809435d24c9fe4882b6beae2ed54d2a15462a9565fbe3554a9024">PxDataAccessFlag::eDEVICE</a> is specified for GPU particles then pointers to GPU memory will be returned otherwise it will be ignored. </td></tr> + </table> +</dl> +<dl class="note" compact><dt><b>Note:</b></dt><dd>PxDataAccessFlag::eWRITEABLE is not supported and will be ignored <p> +If using <a class="el" href="structPxDataAccessFlag.html#b6bd468adf2809435d24c9fe4882b6beae2ed54d2a15462a9565fbe3554a9024">PxDataAccessFlag::eDEVICE</a>, newly created particles will not become visible in the GPU buffers until a subsequent simulation step has completed </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> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fd32e1e6ffa0647a2c296bc8635ca99c"></a><!-- doxytag: member="PxParticleBase::releaseParticles" ref="fd32e1e6ffa0647a2c296bc8635ca99c" args="()=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::releaseParticles </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases all particles. +<p> +Application readable particle data is updated accordingly. +</div> +</div><p> +<a class="anchor" name="318b187bebc71828651f3ffc8b2bd9a9"></a><!-- doxytag: member="PxParticleBase::releaseParticles" ref="318b187bebc71828651f3ffc8b2bd9a9" args="(PxU32 numParticles, const PxStrideIterator< const PxU32 > &indexBuffer)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::releaseParticles </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>numParticles</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td> + <td class="paramname"> <em>indexBuffer</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Releases particles. +<p> +Particles corresponding to passed indices are released. Releasing a particle will immediately mark the particle in the application readable particle data, <a class="el" href="classPxParticleReadData.html" title="Data layout descriptor for reading particle data from the SDK. (deprecated).">PxParticleReadData</a>, as being invalid, removing <a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee2810e71c28b277b60827148913beaadde3" title="Marks a valid particle. The particle data corresponding to these particle flags is...">PxParticleFlag::eVALID</a>. Passing duplicate indices is not allowed.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>numParticles</em> </td><td>Number of particles to be released. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>indexBuffer</em> </td><td>Structure describing indices of particles that should be deleted. (Has to be consistent with numParticles).</td></tr> + </table> +</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> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1daf9cb4e5b4a0abbfee215c144582e4"></a><!-- doxytag: member="PxParticleBase::setContactOffset" ref="1daf9cb4e5b4a0abbfee215c144582e4" args="(PxReal contactOffset)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setContactOffset </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>contactOffset</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the distance at which contacts are generated between particles and collision geometry. Immutable when the particle system is part of a scene. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>contactOffset</em> </td><td>New contactOffset value. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="8fb190deeb6744368762b296d8819eeb"></a><!-- doxytag: member="PxParticleBase::setDamping" ref="8fb190deeb6744368762b296d8819eeb" args="(PxReal damp)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setDamping </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>damp</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the particle system damping (must be nonnegative). +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>damp</em> </td><td>The new particle system damping. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="d95b342c529785ca7e126605804ccfbb"></a><!-- doxytag: member="PxParticleBase::setDynamicFriction" ref="d95b342c529785ca7e126605804ccfbb" args="(PxReal friction)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setDynamicFriction </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>friction</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the dynamic friction used for collision with shapes. +<p> +Must be between 0 and 1.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>friction</em> </td><td>The new dynamic friction </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="b43431b492105e432f1f5eb33fabd0c4"></a><!-- doxytag: member="PxParticleBase::setExternalAcceleration" ref="b43431b492105e432f1f5eb33fabd0c4" args="(const PxVec3 &acceleration)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setExternalAcceleration </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>acceleration</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the external acceleration applied to each particle at each time step. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>acceleration</em> </td><td>External acceleration to apply to particles.</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxParticleBase.html#7e39c7791bf865d3a12582068ffd997e" title="Returns the external acceleration applied to each particle at each time step.">getExternalAcceleration()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f484aea29669a33f8bf78465d2d2f8b4"></a><!-- doxytag: member="PxParticleBase::setGridSize" ref="f484aea29669a33f8bf78465d2d2f8b4" args="(PxReal gridSize)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setGridSize </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>gridSize</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the particle grid size used for internal spatial data structures. Immutable when the particle system is part of a scene. The actual grid size used might differ from the grid size set in the <a class="el" href="classPxParticleBase.html#f484aea29669a33f8bf78465d2d2f8b4" title="Sets the particle grid size used for internal spatial data structures. Immutable...">setGridSize()</a>. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>gridSize</em> </td><td>New gridSize value. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="0e768c7a7e0375b870078d45c890721e"></a><!-- doxytag: member="PxParticleBase::setMaxMotionDistance" ref="0e768c7a7e0375b870078d45c890721e" args="(PxReal distance)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setMaxMotionDistance </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>distance</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the maximal motion distance (the particle can move the maximal distance during one timestep). Immutable when the particle system is part of a scene. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>distance</em> </td><td>New Max motionDistance value. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="4445c7746cfd5cbcda51173d0cf5c93a"></a><!-- doxytag: member="PxParticleBase::setParticleBaseFlag" ref="4445c7746cfd5cbcda51173d0cf5c93a" args="(PxParticleBaseFlag::Enum flag, bool val)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setParticleBaseFlag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxParticleBaseFlag.html#133d603af58af35124b6bea1977b5bc3">PxParticleBaseFlag::Enum</a> </td> + <td class="paramname"> <em>flag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets particle system flags. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>Member of <a class="el" href="structPxParticleBaseFlag.html" title="ParticleBase flags (deprecated).">PxParticleBaseFlag</a>. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>New flag value. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="80881666e5ee6743b6ac2c1f8723ce19"></a><!-- doxytag: member="PxParticleBase::setParticleMass" ref="80881666e5ee6743b6ac2c1f8723ce19" args="(PxReal mass)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setParticleMass </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>mass</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the mass of a particle. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mass</em> </td><td>The particle mass. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="9fbba67f740bc2b915ce0eb8d5c1b099"></a><!-- doxytag: member="PxParticleBase::setParticleReadDataFlag" ref="9fbba67f740bc2b915ce0eb8d5c1b099" args="(PxParticleReadDataFlag::Enum flag, bool val)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setParticleReadDataFlag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structPxParticleReadDataFlag.html#e228980b8744bbaa5c1567a17183ae71">PxParticleReadDataFlag::Enum</a> </td> + <td class="paramname"> <em>flag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets particle read data flags. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>Member of <a class="el" href="structPxParticleReadDataFlag.html">PxParticleReadDataFlag</a>. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>New flag value. </td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__particles.html#g7eb9d4fd42d62041395fa34b23f56248" title="collection of set bits defined in PxParticleReadDataFlag. (deprecated)">PxParticleReadDataFlags</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="4fba51bed2ec1b3445885916350b10d5"></a><!-- doxytag: member="PxParticleBase::setPositions" ref="4fba51bed2ec1b3445885916350b10d5" args="(PxU32 numParticles, const PxStrideIterator< const PxU32 > &indexBuffer, const PxStrideIterator< const PxVec3 > &positionBuffer)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setPositions </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>numParticles</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td> + <td class="paramname"> <em>indexBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > & </td> + <td class="paramname"> <em>positionBuffer</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets particle positions. +<p> +Directly sets the positions of particles. The supplied positions are used to change particles in the order of the indices listed in the index buffer. Duplicate indices are allowed. A position buffer of stride zero is allowed. Application readable particle data is updated accordingly.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>numParticles</em> </td><td>Number of particle updates. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>indexBuffer</em> </td><td>Structure describing indices of particles that should be updated. (Has to be consistent with numParticles). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>positionBuffer</em> </td><td>Structure describing positions for position updates. (Has to be consistent with numParticles). </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="59216c6fd900d478cd1e75b0a34b37af"></a><!-- doxytag: member="PxParticleBase::setProjectionPlane" ref="59216c6fd900d478cd1e75b0a34b37af" args="(const PxVec3 &normal, PxReal distance)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setProjectionPlane </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classPxVec3.html">PxVec3</a> & </td> + <td class="paramname"> <em>normal</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>distance</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the plane the particles are projected to. +<p> +Points p on the plane have to fulfill the equation:<p> +(normal.x * p.x) + (normal.y * p.y) + (normal.z * p.z) + d = 0<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>normal</em> </td><td>Particle projection plane normal </td></tr> + <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>distance</em> </td><td>Particle projection plane constant term </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="7dc8dc59b5032d7e4ebd9d901df20a3d"></a><!-- doxytag: member="PxParticleBase::setRestitution" ref="7dc8dc59b5032d7e4ebd9d901df20a3d" args="(PxReal rest)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setRestitution </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>rest</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the restitution used for collision with shapes. +<p> +Must be between 0 and 1.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>rest</em> </td><td>The new restitution. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="9c5759758c6fcaf61759dacea5d4653d"></a><!-- doxytag: member="PxParticleBase::setRestOffset" ref="9c5759758c6fcaf61759dacea5d4653d" args="(PxReal restOffset)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setRestOffset </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>restOffset</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the distance between particles and collision geometry, which is maintained during simulation. If per particle restOffsets are used, they need to be in the range [0.0f, restOffset]. Immutable when the particle system is part of a scene. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>restOffset</em> </td><td>New restOffset value. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="4b193d290509a4442ed0110580a16447"></a><!-- doxytag: member="PxParticleBase::setRestOffsets" ref="4b193d290509a4442ed0110580a16447" args="(PxU32 numParticles, const PxStrideIterator< const PxU32 > &indexBuffer, const PxStrideIterator< const PxF32 > &restOffsetBuffer)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setRestOffsets </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>numParticles</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td> + <td class="paramname"> <em>indexBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const PxF32 > & </td> + <td class="paramname"> <em>restOffsetBuffer</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets particle rest offsets. +<p> +Directly sets the rest offsets of particles. The supplied rest offsets are used to change particles in the order of the indices listed in the index buffer. The provided offsets need to be in the range [0.0f, restOffset]. Duplicate indices are allowed. A rest offset buffer of stride zero is allowed. Application readable particle data is updated accordingly.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>numParticles</em> </td><td>Number of particle updates. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>indexBuffer</em> </td><td>Structure describing indices of particles that should be updated. (Has to be consistent with numParticles). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>restOffsetBuffer</em> </td><td>Structure describing rest offsets for rest offset updates. (Has to be consistent with numParticles).</td></tr> + </table> +</dl> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxParticleBaseFlag.html#133d603af58af35124b6bea1977b5bc3f96ef7f12e864006b9fd91677a4da28a" title="Enable/disable per particle rest offsets. Per particle rest offsets can be used to...">PxParticleBaseFlag.ePER_PARTICLE_REST_OFFSET</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c9babb704b6400ee1a11b1d17439b362"></a><!-- doxytag: member="PxParticleBase::setSimulationFilterData" ref="c9babb704b6400ee1a11b1d17439b362" args="(const PxFilterData &data)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setSimulationFilterData </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structPxFilterData.html">PxFilterData</a> & </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the user definable collision filter data. +<p> +<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPxParticleBase.html#12bf74e45c36e867894bc775a83a0593" title="Retrieves the object's collision filter data.">getSimulationFilterData()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3fb596178c017ed1c536c152e4fba358"></a><!-- doxytag: member="PxParticleBase::setStaticFriction" ref="3fb596178c017ed1c536c152e4fba358" args="(PxReal friction)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setStaticFriction </td> + <td>(</td> + <td class="paramtype">PxReal </td> + <td class="paramname"> <em>friction</em> </td> + <td> ) </td> + <td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the static friction used for collision with shapes. +<p> +Must be non-negative.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>friction</em> </td><td>The new static friction </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="f73716656e6d6efef3a5650f9e04ffe3"></a><!-- doxytag: member="PxParticleBase::setVelocities" ref="f73716656e6d6efef3a5650f9e04ffe3" args="(PxU32 numParticles, const PxStrideIterator< const PxU32 > &indexBuffer, const PxStrideIterator< const PxVec3 > &velocityBuffer)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void PxParticleBase::setVelocities </td> + <td>(</td> + <td class="paramtype"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td> + <td class="paramname"> <em>numParticles</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > & </td> + <td class="paramname"> <em>indexBuffer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > & </td> + <td class="paramname"> <em>velocityBuffer</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets particle velocities. +<p> +Directly sets the velocities of particles. The supplied velocities are used to change particles in the order of the indices listed in the index buffer. Duplicate indices are allowed. A velocity buffer of stride zero is allowed. Application readable particle data is updated accordingly.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>numParticles</em> </td><td>Number of particle updates. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>indexBuffer</em> </td><td>Structure describing indices of particles that should be updated. (Has to be consistent with numParticles). </td></tr> + <tr><td valign="top"></td><td valign="top"><em>velocityBuffer</em> </td><td>Structure describing velocities for velocity updates. (Has to be consistent with numParticles). </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxParticleBase_8h-source.html">PxParticleBase.h</a></ul> +</div> + +<hr style="width: 100%; height: 2px;"><br> +Copyright © 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> |