aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Include/extensions/PxParticleExt.h
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Include/extensions/PxParticleExt.h
downloadphysx-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/Include/extensions/PxParticleExt.h')
-rw-r--r--PhysX_3.4/Include/extensions/PxParticleExt.h172
1 files changed, 172 insertions, 0 deletions
diff --git a/PhysX_3.4/Include/extensions/PxParticleExt.h b/PhysX_3.4/Include/extensions/PxParticleExt.h
new file mode 100644
index 00000000..14bbefb4
--- /dev/null
+++ b/PhysX_3.4/Include/extensions/PxParticleExt.h
@@ -0,0 +1,172 @@
+// This code contains NVIDIA Confidential Information and is disclosed to you
+// under a form of NVIDIA software license agreement provided separately to you.
+//
+// Notice
+// NVIDIA Corporation and its licensors retain all intellectual property and
+// proprietary rights in and to this software and related documentation and
+// any modifications thereto. Any use, reproduction, disclosure, or
+// distribution of this software and related documentation without an express
+// license agreement from NVIDIA Corporation is strictly prohibited.
+//
+// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+//
+// Information and code furnished is believed to be accurate and reliable.
+// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+// information or for any infringement of patents or other rights of third parties that may
+// result from its use. No license is granted by implication or otherwise under any patent
+// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+// This code supersedes and replaces all information previously supplied.
+// NVIDIA Corporation products are not authorized for use as critical
+// components in life support devices or systems without express written approval of
+// NVIDIA Corporation.
+//
+// Copyright (c) 2008-2016 NVIDIA Corporation. All rights reserved.
+// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
+// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+
+
+#ifndef PX_PHYSICS_EXTENSIONS_PARTICLEEXT_H
+#define PX_PHYSICS_EXTENSIONS_PARTICLEEXT_H
+/** \addtogroup extensions
+ @{
+*/
+
+#include "PxPhysXConfig.h"
+#include "foundation/PxStrideIterator.h"
+#include "foundation/PxBounds3.h"
+
+#if !PX_DOXYGEN
+namespace physx
+{
+#endif
+
+/**
+\brief extensions for the partice feature (deprecated)
+\deprecated The PhysX particle feature has been deprecated in PhysX version 3.4
+*/
+class PX_DEPRECATED PxParticleExt
+{
+public:
+
+ struct ParticleBounds
+ {
+ PxBounds3 bounds;
+ PxU32 firstParticle;
+ PxU32 numParticles;
+ };
+
+ /**
+ \brief Computes particle bounds by sorting particle positions into a spatial hash grid.
+
+ Given a strided array of particle positions, this function partitions the particles into
+ subsets of nearby particles by mapping the particle positions onto a 3-dimensional grid
+ and creating ParticleBounds data structures for each occupied grid cell.
+
+ Each returned ParticleBounds data structure can be used to determine the indices of the particles
+ belonging to the same grid cell. Particle indices of one grid cell are returned as contiguous
+ blocks in the sortedParticleIndices buffer and can be found within the range
+ [firstParticle, firstParticle + numParticles - 1]. Each returned ParticleBounds further contains
+ an AABB "bounds" that tightly fits all particle positions within the grid cell.
+
+ The number of created ParticleBounds can be retrieved via the return value. The user can cap the
+ maximum amount of generated ParticleBounds via the maxBounds parameter. Particles that would cause
+ this maximum to be exceeded will be skipped over and will not be part of any returned ParticleBounds.
+ (Note that this also hold when maxBounds is equal to hashSize. Thus, in the worst case, if no particle
+ should ever be skipped over by the algorithm "hashSize" must be at least equal to numParticles)
+
+ The user is responsible for allocating the output buffers sortedParticleIndices
+ (for at least numParticles entries) and particleBounds (for at least maxBounds entries).
+
+ The size of a cubical grid cell can be tuned by setting the gridSpacing parameter.
+
+ The user supplied hashSize must be a power of two.
+
+ \param[out] sortedParticleIndices Pointer to user allocated array of size numParticles where the sorted particle indices will be written to.
+ \param[out] particleBounds Pointer to user allocated array of size maxBounds where the ParticleBounds will be written to.
+ \param[in] positionBuffer Strided data of input particle positions.
+ \param[in] validParticleRange Range of valid particles within validParticleBitmap. (See PxParticleReadData.validParticleRange).
+ \param[in] validParticleBitmap Bitmap specifying valid slots in positionBuffer. (See PxParticleReadData.validParticleBitmap).
+ \param[in] hashSize Hash size used internally by the hashing algorithm. Must be a power of two.
+ \param[in] maxBounds Maximum number of bounds to be returned. Must be smaller or equal than hashSize.
+ \param[in] gridSpacing Side length of each cubical grid cell.
+ \return PxU32. Number of ParticleBounds data structures written to the particleBounds buffer. Smaller or equal than maxBounds.
+
+ */
+ static PxU32 buildBoundsHash(PxU32* sortedParticleIndices,
+ ParticleBounds* particleBounds,
+ const PxStrideIterator<const PxVec3>& positionBuffer,
+ const PxU32 validParticleRange,
+ const PxU32* validParticleBitmap,
+ const PxU32 hashSize,
+ const PxU32 maxBounds,
+ const PxReal gridSpacing);
+
+ /**
+ \brief Class to manage particle indices.
+ Extension particle index management can be useful if no application side particle index allocation
+ functionality is available. An PxParticleExt::IndexPool instance is meant to be used for one
+ PxParticleSystem/PxParticleFluid instance.
+ The instance can be created with PxParticleExt::createIndexPool().
+
+ @see PxParticleExt::createIndexPool()
+ */
+ class IndexPool
+ {
+ public:
+ /**
+ \brief Allocates a requested number of indices if possible.
+ \param[in] num Number of indices that should be allocated.
+ \param[out] indexBuffer Strided data to which allocated indices are written.
+ \return PxU32. Number of indices that where allocated by the operation.
+ */
+ virtual PxU32 allocateIndices(PxU32 num, const PxStrideIterator<PxU32>& indexBuffer) = 0;
+
+ /**
+ \brief Deallocates a requested number of indices.
+ \param[in] num Number of indices that should be freed.
+ \param[in] indexBuffer Strided data describing the indices that need to be freed. It's a requirement
+ to specify unique indices, that where previously allocated by PxParticlesExt::allocateIndices()
+ */
+ virtual void freeIndices(PxU32 num, const PxStrideIterator<const PxU32>& indexBuffer) = 0;
+
+ /**
+ \brief Deallocates all previously allocated indices.
+ */
+ virtual void freeIndices() = 0;
+
+ /**
+ \brief Releases IndexPool instance.
+ */
+ virtual void release() = 0;
+
+ /**
+ \brief virtual destructor
+ */
+ virtual ~IndexPool() {}
+ };
+
+ /**
+ \brief Creates a PxParticlesExt::IndexPool instance.
+ \param[in] maxParticles Maximum number of available indices.
+ */
+ static IndexPool* createIndexPool(PxU32 maxParticles);
+
+ /**
+ \brief Creates a PxParticlesExt::IndexPool instance initialized with a preallocated set of indices specified with a bitmap.
+ \param[in] maxParticles Maximum number of available indices.
+ \param[in] validParticleRange Range of indices represented in validParticleBitmap. (See PxParticleReadData.validParticleRange).
+ \param[in] validParticleBitmap Bitmap specifying the valid particle indices that should be preallocated. (See PxParticleReadData.validParticleBitmap).
+ */
+ static IndexPool* createIndexPool(PxU32 maxParticles, PxU32 validParticleRange, const PxU32* validParticleBitmap);
+
+};
+
+#if !PX_DOXYGEN
+} // namespace physx
+#endif
+
+/** @} */
+#endif