aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Include/extensions/PxClothTetherCooker.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/PxClothTetherCooker.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/PxClothTetherCooker.h')
-rw-r--r--PhysX_3.4/Include/extensions/PxClothTetherCooker.h126
1 files changed, 126 insertions, 0 deletions
diff --git a/PhysX_3.4/Include/extensions/PxClothTetherCooker.h b/PhysX_3.4/Include/extensions/PxClothTetherCooker.h
new file mode 100644
index 00000000..5b0301dd
--- /dev/null
+++ b/PhysX_3.4/Include/extensions/PxClothTetherCooker.h
@@ -0,0 +1,126 @@
+// 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_CLOTH_TETHER_COOKER_H
+#define PX_PHYSICS_EXTENSIONS_CLOTH_TETHER_COOKER_H
+
+#include "common/PxPhysXCommonConfig.h"
+#include "PxClothMeshDesc.h"
+
+#if !PX_DOXYGEN
+namespace physx
+{
+#endif
+
+struct PxClothSimpleTetherCookerImpl;
+
+class PxClothSimpleTetherCooker
+{
+public:
+ /**
+ \brief Compute tether data from PxClothMeshDesc with simple distance measure.
+ \details The tether constraint in PxCloth requires rest distance and anchor index to be precomputed during cooking time.
+ This cooker computes a simple Euclidean distance to closest anchor point.
+ The Euclidean distance measure works reasonably for flat cloth and flags and computation time is very fast.
+ With this cooker, there is only one tether anchor point per particle.
+ \see PxClothTetherGeodesicCooker for more accurate distance estimation.
+ \param desc The cloth mesh descriptor prepared for cooking
+ */
+ PxClothSimpleTetherCooker(const PxClothMeshDesc &desc);
+ ~PxClothSimpleTetherCooker();
+
+ /**
+ \brief Returns computed tether data.
+ \details This function returns anchor indices for each particle as well as desired distance between the tether anchor and the particle.
+ The user buffers should be at least as large as number of particles.
+ */
+ void getTetherData(PxU32* userTetherAnchors, PxReal* userTetherLengths) const;
+
+private:
+ PxClothSimpleTetherCookerImpl* mImpl;
+
+};
+
+
+struct PxClothGeodesicTetherCookerImpl;
+
+class PxClothGeodesicTetherCooker
+{
+public:
+ /**
+ \brief Compute tether data from PxClothMeshDesc using geodesic distance.
+ \details The tether constraint in PxCloth requires rest distance and anchor index to be precomputed during cooking time.
+ The provided tether cooker computes optimal tether distance with geodesic distance computation.
+ For curved and complex meshes, geodesic distance provides the best behavior for tether constraints.
+ But the cooking time is slower than the simple cooker.
+ \see PxClothSimpleTetherCooker
+ \param desc The cloth mesh descriptor prepared for cooking
+ \note The geodesic distance is optimized to work for intended use in tether constraint.
+ This is by no means a general purpose geodesic computation code for arbitrary meshes.
+ \note The geodesic cooker does not work with non-manifold input such as edges having more than two incident triangles,
+ or adjacent triangles following inconsitent winding order (e.g. clockwise vs counter-clockwise).
+ */
+ PxClothGeodesicTetherCooker(const PxClothMeshDesc &desc);
+ ~PxClothGeodesicTetherCooker();
+
+ /**
+ \brief Returns cooker status
+ \details This function returns cooker status after cooker computation is done.
+ A non-zero return value indicates a failure, 1 for non-manifold and 2 for inconsistent winding.
+ */
+ PxU32 getCookerStatus() const;
+
+ /**
+ \brief Returns number of tether anchors per particle
+ \note Returned number indicates the maximum anchors.
+ If some particles are assigned fewer anchors, the anchor indices will be PxU32(-1)
+ \note If there is no attached point in the input mesh descriptor, this will return 0 and no tether data will be generated.
+ */
+ PxU32 getNbTethersPerParticle() const;
+
+ /**
+ \brief Returns computed tether data.
+ \details This function returns anchor indices for each particle as well as desired distance between the tether anchor and the particle.
+ The user buffers should be at least as large as number of particles * number of tethers per particle.
+ \see getNbTethersPerParticle()
+ */
+ void getTetherData(PxU32* userTetherAnchors, PxReal* userTetherLengths) const;
+
+private:
+ PxClothGeodesicTetherCookerImpl* mImpl;
+
+};
+
+
+#if !PX_DOXYGEN
+} // namespace physx
+#endif
+
+#endif // PX_PHYSICS_EXTENSIONS_CLOTH_TETHER_COOKER_H