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

Deprecated:

The PhysX cloth feature has been deprecated in PhysX version 3.4.1

---

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:

• PxCloth.h