Defined in include/PxFEMSoftBodyMaterial.h

Inheritance Relationships

Base Type

class PxFEMSoftBodyMaterial : public PxFEMMaterial

Material class to represent a set of softbody FEM material properties.

Public Functions

virtual void setDamping(PxReal damping) = 0

Sets material velocity damping term.

See also



damping[in] Material velocity damping term. Range: [0, PX_MAX_F32)

virtual PxReal getDamping() const = 0

Retrieves velocity damping.

See also



The velocity damping.

virtual void setDampingScale(PxReal scale) = 0

Sets material damping scale.

A scale of 1 corresponds to default damping, a value of 0 will only apply damping to certain motions leading to special effects that look similar to water filled softbodies.

See also



scale[in] Damping scale term. Default: 1 Range: [0, 1]

virtual PxReal getDampingScale() const = 0

Retrieves material damping scale.

See also



The damping scale term.

inline virtual const char *getConcreteTypeName() const

Returns string name of dynamic type.


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.


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

virtual PxReal getYoungsModulus() const = 0

Retrieves the young’s modulus value.


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



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

virtual PxReal getPoissons() const = 0

Retrieves the Poisson’s ratio.

See also



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.


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

virtual PxReal getDynamicFriction() const = 0

Retrieves the dynamic friction value.


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.


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::Enum of serialized object

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

Set PxBaseFlag

  • flag[in] The flag to be set

  • value[in] The flags new value

inline void setBaseFlags(PxBaseFlags inFlags)

Set PxBaseFlags

See also



inFlags[in] The flags to be set

inline PxBaseFlags getBaseFlags() const

Returns PxBaseFlags.

See also




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.


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 PxFEMSoftBodyMaterial(PxType concreteType, PxBaseFlags baseFlags)
inline PxFEMSoftBodyMaterial(PxBaseFlags baseFlags)
inline virtual ~PxFEMSoftBodyMaterial()
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