PxFEMClothMaterial

Defined in include/PxFEMClothMaterial.h

Inheritance Relationships

Base Type

class PxFEMClothMaterial : public PxFEMMaterial

Material class to represent a set of FEM material properties.

Public Functions

virtual void setThickness(PxReal thickness) = 0

Sets material thickness.

See also

getThickness

Parameters

thickness[in] Material thickness.

virtual PxReal getThickness() const = 0

Retrieves the material thickness.

See also

setDamping()

Returns

thickness.

virtual void setElasticityDamping(PxReal damping) = 0

Sets the elasticity damping for the internal cloth solver.

Parameters

damping[in] The elasticity damping term. Range: [0.0, Inf)

virtual PxReal getElasticityDamping() const = 0

Retrieves the elasticity damping term.

Returns

The elasticity damping term.

virtual void setBendingDamping(PxReal damping) = 0

Sets the bending coefficient for bending constraints.

Parameters

damping[in] The bending coefficient. Range: [0.0, Inf)

virtual PxReal getBendingDamping() const = 0

Retrieves the bending coefficient for bending constraints.

Returns

The bending coefficient.

inline virtual const char *getConcreteTypeName() const

Returns string name of dynamic type.

Returns

Class name of most derived type of this object.

virtual void setYoungsModulus(PxReal young) = 0

Sets young’s modulus which defines the body’s stiffness.

Parameters

young[in] Young’s modulus. Range: [0, PX_MAX_F32)

virtual PxReal getYoungsModulus() const = 0

Retrieves the young’s modulus value.

Returns

The young’s modulus value.

virtual void setPoissons(PxReal poisson) = 0

Sets the Poisson’s ratio which defines the body’s volume preservation.

Completely incompressible materials have a poisson ratio of 0.5. Its value should not be set to exactly 0.5 because this leads to numerical problems.

See also

getPoissons()

Parameters

poisson[in] Poisson’s ratio. Range: [0, 0.5)

virtual PxReal getPoissons() const = 0

Retrieves the Poisson’s ratio.

See also

setPoissons()

Returns

The Poisson’s ratio.

virtual void setDynamicFriction(PxReal dynamicFriction) = 0

Sets the dynamic friction value which defines the strength of resistance when two objects slide relative to each other while in contact.

Parameters

dynamicFriction[in] The dynamic friction value. Range: [0, PX_MAX_F32)

virtual PxReal getDynamicFriction() const = 0

Retrieves the dynamic friction value.

Returns

The dynamic friction value

virtual void release() = 0

Decrements the reference count of the object and releases it if the new reference count is zero.

virtual PxU32 getReferenceCount() const = 0

Returns the reference count of the object.

At creation, the reference count of the object is 1. Every other object referencing this object increments the count by 1. When the reference count reaches 0, and only then, the object gets destroyed automatically.

Returns

the current reference count.

virtual void acquireReference() = 0

Acquires a counted reference to this object.

This method increases the reference count of the object by 1. Decrement the reference count by calling release()

template<class T>
inline T *is()
template<class T>
inline const T *is() const
inline PxType getConcreteType() const

Returns concrete type of object.

See also

PxConcreteType

Returns

PxConcreteType::Enum of serialized object

inline void setBaseFlag(PxBaseFlag::Enum flag, bool value)

Set PxBaseFlag

Parameters
  • flag[in] The flag to be set

  • value[in] The flags new value

inline void setBaseFlags(PxBaseFlags inFlags)

Set PxBaseFlags

See also

PxBaseFlags

Parameters

inFlags[in] The flags to be set

inline PxBaseFlags getBaseFlags() const

Returns PxBaseFlags.

See also

PxBaseFlags

Returns

PxBaseFlags

inline virtual bool isReleasable() const

Whether the object is subordinate.

A class is subordinate, if it can only be instantiated in the context of another class.

Returns

Whether the class is subordinate

Public Members

void *userData

user can assign this to whatever, usually to create a 1:1 relationship with a user object.

Protected Functions

inline PxFEMClothMaterial(PxType concreteType, PxBaseFlags baseFlags)
inline PxFEMClothMaterial(PxBaseFlags baseFlags)
inline virtual ~PxFEMClothMaterial()
inline virtual bool isKindOf(const char *name) const

Returns whether a given type name matches with the type of this instance.

inline virtual void onRefCountZero()
template<class T>
inline bool typeMatch() const

Protected Attributes

PxType mConcreteType
PxBaseFlags mBaseFlags
PxU32 mBuiltInRefCount