diff options
Diffstat (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html')
| -rw-r--r-- | PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html | 202 |
1 files changed, 202 insertions, 0 deletions
diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html new file mode 100644 index 00000000..c52249b5 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxParticleCreationData.html @@ -0,0 +1,202 @@ +<html> + <head> + <title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxParticleCreationData 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>PxParticleCreationData Class Reference<br> +<small> +[<a class="el" href="group__particles.html">particles (deprecated)</a>]</small> +</h1><!-- doxytag: class="PxParticleCreationData" -->Descriptor-like user-side class describing buffers for particle creation. (deprecated). +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="PxParticleCreationData_8h-source.html">PxParticleCreationData.h</a>></code> +<p> +<div class="dynheader"> +Collaboration diagram for PxParticleCreationData:</div> +<div class="dynsection"> +<p><center><img src="classPxParticleCreationData__coll__graph.png" border="0" usemap="#PxParticleCreationData__coll__map" alt="Collaboration graph"></center> +<map name="PxParticleCreationData__coll__map"> +<area shape="rect" href="classPxStrideIterator.html" title="PxStrideIterator\< const PxF32 \>" alt="PxStrideIterator\< const PxF32 \>" coords="165,16,357,37"><area shape="rect" href="classPxStrideIterator.html" title="PxStrideIterator\< const PxU32 \>" alt="PxStrideIterator\< const PxU32 \>" coords="165,101,357,123"><area shape="rect" href="classPxStrideIterator.html" title="PxStrideIterator\< const PxVec3 \>" alt="PxStrideIterator\< const PxVec3 \>" coords="163,187,360,208"><area shape="rect" href="classPxVec3.html" title="3 Element vector class." alt="PxVec3" coords="19,187,72,208"></map> +<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div> + +<p> +<a href="classPxParticleCreationData-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">PX_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#g565e686111afbbdaf07c2bd8b149efb6">setToDefault</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(Re)sets the structure to the default. <a href="group__particles.html#g565e686111afbbdaf07c2bd8b149efb6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PX_INLINE bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__particles.html#g4704c9569fda58e36cd791d9b106247b">isValid</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the current settings are valid. <a href="group__particles.html#g4704c9569fda58e36cd791d9b106247b"></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="group__particles.html#g8946abea4ff273cbecd459cd74e83f79">PxParticleCreationData</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor sets to default. <a href="group__particles.html#g8946abea4ff273cbecd459cd74e83f79"></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="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleCreationData.html#c47b71e518d2ccea3e2b8ef45533f5b8">numParticles</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The number of particles stored in the buffer. <a href="#c47b71e518d2ccea3e2b8ef45533f5b8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleCreationData.html#16fe55135333e1d4826736dc7464afd2">indexBuffer</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Particle index data. <a href="#16fe55135333e1d4826736dc7464afd2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleCreationData.html#358108779dca1956c3870171162fb5c3">positionBuffer</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Particle position data. <a href="#358108779dca1956c3870171162fb5c3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="classPxVec3.html">PxVec3</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleCreationData.html#0591920455dcc59ecb328c38ba128c05">velocityBuffer</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Particle velocity data. <a href="#0591920455dcc59ecb328c38ba128c05"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const PxF32 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleCreationData.html#ced8208b2ab0e000b72050e1cb9562cc">restOffsetBuffer</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Particle rest offset data. <a href="#ced8208b2ab0e000b72050e1cb9562cc"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a>< const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classPxParticleCreationData.html#f3865a2e362b57f573c5b82f73748a41">flagBuffer</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Particle flags. <a href="#f3865a2e362b57f573c5b82f73748a41"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Descriptor-like user-side class describing buffers for particle creation. (deprecated). +<p> +<a class="el" href="classPxParticleCreationData.html" title="Descriptor-like user-side class describing buffers for particle creation. (deprecated)...">PxParticleCreationData</a> is used to create particles within the SDK. The SDK copies the particle data referenced by <a class="el" href="classPxParticleCreationData.html" title="Descriptor-like user-side class describing buffers for particle creation. (deprecated)...">PxParticleCreationData</a>, it may therefore be deallocated right after the creation call returned.<p> +<dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000054">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#f35d1dfda5ddb3c48855272ac4b702ad" title="Creates new particles.">PxParticleBase::createParticles()</a> </dd></dl> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="f3865a2e362b57f573c5b82f73748a41"></a><!-- doxytag: member="PxParticleCreationData::flagBuffer" ref="f3865a2e362b57f573c5b82f73748a41" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a><const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>> <a class="el" href="classPxParticleCreationData.html#f3865a2e362b57f573c5b82f73748a41">PxParticleCreationData::flagBuffer</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Particle flags. +<p> +<a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee2810e71c28b277b60827148913beaadde3" title="Marks a valid particle. The particle data corresponding to these particle flags is...">PxParticleFlag.eVALID</a>, <a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee282f77fb097dca88d65fbb9d7f87e1e3e2" title="Marks a particle that has collided with a static actor shape.">PxParticleFlag.eCOLLISION_WITH_STATIC</a>, <a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee284a5303fc77ded8ca71227fe5f6ef2f4e" title="Marks a particle that has collided with a dynamic actor shape.">PxParticleFlag.eCOLLISION_WITH_DYNAMIC</a>, <a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee283354f1caf9554a034998b786f7e107da" title="Marks a particle that has collided with a shape that has been flagged as a drain...">PxParticleFlag.eCOLLISION_WITH_DRAIN</a>, <a class="el" href="structPxParticleFlag.html#289f88fd89d3d5224d74e5a72c7eee28b0f3e5d769b6680d41a98bfecb8e2ee4" title="Marks a particle that had to be ignored for simulation, because the spatial data...">PxParticleFlag.eSPATIAL_DATA_STRUCTURE_OVERFLOW</a> are all flags that can't be set on particle creation. They are written by the SDK exclusively.<p> +Providing flag data is optional. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="structPxParticleFlag.html">PxParticleFlag</a> </dd></dl> + +<p>Referenced by <a class="el" href="PxParticleCreationData_8h-source.html#l00123">PxParticleCreationData()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="16fe55135333e1d4826736dc7464afd2"></a><!-- doxytag: member="PxParticleCreationData::indexBuffer" ref="16fe55135333e1d4826736dc7464afd2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a><const <a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a>> <a class="el" href="classPxParticleCreationData.html#16fe55135333e1d4826736dc7464afd2">PxParticleCreationData::indexBuffer</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Particle index data. +<p> +When creating particles, providing the particle indices is mandatory. +<p>Referenced by <a class="el" href="PxParticleCreationData_8h-source.html#l00137">isValid()</a>, and <a class="el" href="PxParticleCreationData_8h-source.html#l00123">PxParticleCreationData()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c47b71e518d2ccea3e2b8ef45533f5b8"></a><!-- doxytag: member="PxParticleCreationData::numParticles" ref="c47b71e518d2ccea3e2b8ef45533f5b8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="group__foundation.html#gcce5749db3dcfb916e98c253374264ed">PxU32</a> <a class="el" href="classPxParticleCreationData.html#c47b71e518d2ccea3e2b8ef45533f5b8">PxParticleCreationData::numParticles</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The number of particles stored in the buffer. +<p> + +<p>Referenced by <a class="el" href="PxParticleCreationData_8h-source.html#l00137">isValid()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="358108779dca1956c3870171162fb5c3"></a><!-- doxytag: member="PxParticleCreationData::positionBuffer" ref="358108779dca1956c3870171162fb5c3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a><const <a class="el" href="classPxVec3.html">PxVec3</a>> <a class="el" href="classPxParticleCreationData.html#358108779dca1956c3870171162fb5c3">PxParticleCreationData::positionBuffer</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Particle position data. +<p> +When creating particles, providing the particle positions is mandatory. +<p>Referenced by <a class="el" href="PxParticleCreationData_8h-source.html#l00137">isValid()</a>, and <a class="el" href="PxParticleCreationData_8h-source.html#l00123">PxParticleCreationData()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ced8208b2ab0e000b72050e1cb9562cc"></a><!-- doxytag: member="PxParticleCreationData::restOffsetBuffer" ref="ced8208b2ab0e000b72050e1cb9562cc" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a><const PxF32> <a class="el" href="classPxParticleCreationData.html#ced8208b2ab0e000b72050e1cb9562cc">PxParticleCreationData::restOffsetBuffer</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Particle rest offset data. +<p> +Values need to be in the range [0.0f, restOffset]. If <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> is set, providing per particle rest offset data is mandatory. <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> + +<p>Referenced by <a class="el" href="PxParticleCreationData_8h-source.html#l00123">PxParticleCreationData()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0591920455dcc59ecb328c38ba128c05"></a><!-- doxytag: member="PxParticleCreationData::velocityBuffer" ref="0591920455dcc59ecb328c38ba128c05" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classPxStrideIterator.html">PxStrideIterator</a><const <a class="el" href="classPxVec3.html">PxVec3</a>> <a class="el" href="classPxParticleCreationData.html#0591920455dcc59ecb328c38ba128c05">PxParticleCreationData::velocityBuffer</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Particle velocity data. +<p> +Providing velocity data is optional. +<p>Referenced by <a class="el" href="PxParticleCreationData_8h-source.html#l00123">PxParticleCreationData()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="PxParticleCreationData_8h-source.html">PxParticleCreationData.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> |