From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/structPxClothStretchConfig.html | 178 +++++++++++++++++++++ 1 file changed, 178 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html b/PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html new file mode 100644 index 00000000..4ba92335 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/structPxClothStretchConfig.html @@ -0,0 +1,178 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxClothStretchConfig Struct Reference + + + + + + + +
+

PxClothStretchConfig Struct Reference
+ +[Cloth] +

Solver configuration parameters for the vertical and horizontal stretch phase types. +More... +

+#include <PxCloth.h> +

+ +

+List of all members. + + + + + + + + + + + + + + + + + + +

Public Member Functions

PX_INLINE PxClothStretchConfig (PxReal stiffness_=1.0f, PxReal stiffnessMultiplier_=1.0f, PxReal compressionLimit_=1.0f, PxReal stretchLimit_=1.0f)
 Constructor initializes to default values.

Public Attributes

PxReal stiffness
 Stiffness of the stretch constraints.
PxReal stiffnessMultiplier
 Stiffness multiplier of the cloth solver under certain limits.
PxReal compressionLimit
 Limit to control when stiffnessMultiplier has to be applied.
PxReal stretchLimit
 Limit to control when stiffnessMultiplier has to be applied.
+

Detailed Description

+Solver configuration parameters for the vertical and horizontal stretch phase types. +

+

See also:
PxCloth.setStretchConfig()

+PxClothFabric for information on actual phase data in Cloth fabric

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PX_INLINE PxClothStretchConfig::PxClothStretchConfig (PxReal  stiffness_ = 1.0f,
PxReal  stiffnessMultiplier_ = 1.0f,
PxReal  compressionLimit_ = 1.0f,
PxReal  stretchLimit_ = 1.0f 
) [inline]
+
+
+ +

+Constructor initializes to default values. +

+ +

+

+

Member Data Documentation

+ +
+
+ + + + +
PxReal PxClothStretchConfig::compressionLimit
+
+
+ +

+Limit to control when stiffnessMultiplier has to be applied. +

+stiffnessMultiplier multiplies the normal stiffness if the ratio between constraint edge length and rest length lies in the [compressionLimit, 1] range. The valid range is [0, 1], the default limit is 1.0. +

+

+ +

+
+ + + + +
PxReal PxClothStretchConfig::stiffness
+
+
+ +

+Stiffness of the stretch constraints. +

+Defines for the constraint edges how much of the distance error between current length and rest length to correct per stiffness period (see PxCloth::setStiffnessFrequency). A value of 0 means no correction, a value of 1 corrects to rest length. The default is 1. +

+

+ +

+
+ + + + +
PxReal PxClothStretchConfig::stiffnessMultiplier
+
+
+ +

+Stiffness multiplier of the cloth solver under certain limits. +

+The valid range is [0, 1], the default multiplier is 1.0.

See also:
stretchLimit
+ +
+

+ +

+
+ + + + +
PxReal PxClothStretchConfig::stretchLimit
+
+
+ +

+Limit to control when stiffnessMultiplier has to be applied. +

+stiffnessMultiplier multiplies the normal stiffness if the ratio between constraint edge length and rest length lies in the [1, stretchLimit] range. The valid range is [1, PX_MAX_F32), the default limit is 1.0. +

+

+

The documentation for this struct was generated from the following file: +
+ +

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3