PxDeformableVolumeMaterial

Defined in include/PxDeformableVolumeMaterial.h

class PxDeformableVolumeMaterial : public PxDeformableMaterial

Material class to represent a set of deformable volume material properties.

See also

PxPhysics.createDeformableVolumeMaterial

Public Functions

virtual void setDamping(PxReal damping) = 0

Sets material velocity damping term.

Deprecated:

Use setElasticityDamping instead.

See also

getDamping

Parameters

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

virtual PxReal getDamping() const = 0

Retrieves velocity damping.

Deprecated:

Use getElasticityDamping instead.

See also

setDamping()

Returns

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.

Deprecated:

Damping scale is deprecated.

See also

getDampingScale

Parameters

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

virtual PxReal getDampingScale() const = 0

Retrieves material damping scale.

Deprecated:

Damping scale is deprecated.

See also

setDamping()

Returns

The damping scale term.

virtual void setMaterialModel(PxDeformableVolumeMaterialModel::Enum model) = 0

Sets the material model.

See also

getMaterialModel

Parameters

model – [in] The material model

virtual PxDeformableVolumeMaterialModel::Enum getMaterialModel() const = 0

Retrieves the material model.

See also

setMaterialModel()

Returns

The material model.

inline virtual const char *getConcreteTypeName() const final override

Gets the concrete type name.

Returns

The name of the concrete type.

virtual void setYoungsModulus(PxReal young) = 0

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

Default: 1.e6

See also

getYoungsModulus()

Parameters

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

virtual PxReal getYoungsModulus() const = 0

Retrieves the young’s modulus value.

See also

setYoungsModulus()

Returns

The young’s modulus value.

virtual void setPoissons(PxReal poisson) = 0

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

Default: 0.45

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.

Default: 0.0

See also

getDynamicFriction()

Parameters

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

virtual PxReal getDynamicFriction() const = 0

Retrieves the dynamic friction value.

See also

setDynamicFriction()

Returns

The dynamic friction value

virtual void setElasticityDamping(PxReal elasticityDamping) = 0

Sets material damping.

See also

getDamping()

Parameters

elasticityDamping – [in] Material damping.

virtual PxReal getElasticityDamping() const = 0

Retrieves the material damping.

See also

setDamping()

Returns

damping.

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.

See also

PxSerialization::isSerializable

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 PxDeformableVolumeMaterial(PxType concreteType, PxBaseFlags baseFlags)

inline PxDeformableVolumeMaterial(PxBaseFlags baseFlags)

inline virtual ~PxDeformableVolumeMaterial()

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