RavEngine
Loading...
Searching...
No Matches
physx::NpFEMSoftBodyMaterial Class Reference
Inheritance diagram for physx::NpFEMSoftBodyMaterial:
[legend]
Collaboration diagram for physx::NpFEMSoftBodyMaterial:
[legend]

Public Member Functions

 NpFEMSoftBodyMaterial (PxBaseFlags baseFlags)
 
virtual void resolveReferences (PxDeserializationContext &context)
 
void preExportDataReset ()
 
void exportExtraData (PxSerializationContext &)
 
void importExtraData (PxDeserializationContext &)
 
virtual void requiresObjects (PxProcessPxBaseCallback &)
 
 NpFEMSoftBodyMaterial (const PxsFEMSoftBodyMaterialCore &desc)
 
virtual void onRefCountZero ()
 
virtual void release ()
 Decrements the reference count of the object and releases it if the new reference count is zero.

 
virtual void acquireReference ()
 Acquires a counted reference to this object.
 
virtual PxU32 getReferenceCount () const
 Returns the reference count of the object.
 
virtual void setYoungsModulus (PxReal young) PX_OVERRIDE
 Sets young's modulus which defines the body's stiffness.
 
virtual PxReal getYoungsModulus () const PX_OVERRIDE
 Retrieves the young's modulus value.
 
virtual void setPoissons (PxReal poisson) PX_OVERRIDE
 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.
 
virtual PxReal getPoissons () const PX_OVERRIDE
 Retrieves the Poisson's ratio.
 
virtual void setDynamicFriction (PxReal threshold) PX_OVERRIDE
 Sets the dynamic friction value which defines the strength of resistance when two objects slide relative to each other while in contact.
 
virtual PxReal getDynamicFriction () const PX_OVERRIDE
 Retrieves the dynamic friction value.
 
virtual void setDamping (PxReal damping) PX_OVERRIDE
 Sets material velocity damping term.
 
virtual PxReal getDamping () const PX_OVERRIDE
 Retrieves velocity damping.
 
virtual void setDampingScale (PxReal scale)
 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.
 
virtual PxReal getDampingScale () const
 Retrieves material damping scale.
 
virtual void setDeformThreshold (PxReal threshold)
 
virtual PxReal getDeformThreshold () const
 
virtual void setDeformLowLimitRatio (PxReal threshold)
 
virtual PxReal getDeformLowLimitRatio () const
 
virtual void setDeformHighLimitRatio (PxReal threshold)
 
virtual PxReal getDeformHighLimitRatio () const
 
- Public Member Functions inherited from physx::PxFEMSoftBodyMaterial
virtual const char * getConcreteTypeName () const
 Returns string name of dynamic type.
 
- Public Member Functions inherited from physx::PxBaseMaterial
PX_INLINE PxBaseMaterial (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxBaseMaterial (PxBaseFlags baseFlags)
 
- Public Member Functions inherited from physx::PxBase
template<class T >
T * is ()
 
template<class T >
const T * is () const
 
PX_FORCE_INLINE PxType getConcreteType () const
 Returns concrete type of object.
 
PX_FORCE_INLINE void setBaseFlag (PxBaseFlag::Enum flag, bool value)
 Set PxBaseFlag

 
PX_FORCE_INLINE void setBaseFlags (PxBaseFlags inFlags)
 Set PxBaseFlags

 
PX_FORCE_INLINE PxBaseFlags getBaseFlags () const
 Returns PxBaseFlags.
 
virtual bool isReleasable () const
 Whether the object is subordinate.
 
- Public Member Functions inherited from physx::PxUserAllocated
PX_INLINE void * operator new (size_t, void *address)
 
PX_INLINE void operator delete (void *, void *)
 
template<typename Alloc >
PX_INLINE void * operator new (size_t size, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void * operator new (size_t size, size_t, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void * operator new[] (size_t size, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void * operator new[] (size_t size, size_t, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void operator delete (void *ptr, Alloc alloc, const char *fileName, int line)
 
template<typename Alloc >
PX_INLINE void operator delete[] (void *ptr, Alloc alloc, const char *fileName, int line)
 
PX_INLINE void operator delete (void *ptr)
 
PX_INLINE void operator delete[] (void *ptr)
 

Static Public Member Functions

static NpFEMSoftBodyMaterial * createObject (PxU8 *&address, PxDeserializationContext &context)
 
static void getBinaryMetaData (PxOutputStream &stream)
 
static PX_FORCE_INLINE void getMaterialIndices (PxFEMSoftBodyMaterial *const *materials, PxU16 *materialIndices, PxU32 materialCount)
 

Public Attributes

PxsFEMSoftBodyMaterialCore mMaterial
 
- Public Attributes inherited from physx::PxBaseMaterial
void * userData
 user can assign this to whatever, usually to create a 1:1 relationship with a user object.
 

Additional Inherited Members

- Protected Member Functions inherited from physx::PxFEMSoftBodyMaterial
PX_INLINE PxFEMSoftBodyMaterial (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxFEMSoftBodyMaterial (PxBaseFlags baseFlags)
 
virtual bool isKindOf (const char *name) const
 Returns whether a given type name matches with the type of this instance.
 
- Protected Member Functions inherited from physx::PxFEMMaterial
PX_INLINE PxFEMMaterial (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxFEMMaterial (PxBaseFlags baseFlags)
 
- Protected Member Functions inherited from physx::PxRefCounted
PX_INLINE PxRefCounted (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxRefCounted (PxBaseFlags baseFlags)
 
- Protected Member Functions inherited from physx::PxBase
PX_INLINE PxBase (PxType concreteType, PxBaseFlags baseFlags)
 Constructor setting concrete type and base flags.
 
PX_INLINE PxBase (PxBaseFlags baseFlags)
 Deserialization constructor setting base flags.
 
virtual ~PxBase ()
 Destructor.
 
template<class T >
bool typeMatch () const
 
- Protected Attributes inherited from physx::PxBase
PxType mConcreteType
 
PxBaseFlags mBaseFlags
 
PxU32 mBuiltInRefCount
 

Member Function Documentation

◆ acquireReference()

virtual void physx::NpFEMSoftBodyMaterial::acquireReference ( )
virtual

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()

Implements physx::PxRefCounted.

◆ getDamping()

virtual PxReal physx::NpFEMSoftBodyMaterial::getDamping ( ) const
virtual

Retrieves velocity damping.

Returns
The velocity damping.
See also
setDamping()

Implements physx::PxFEMSoftBodyMaterial.

◆ getDampingScale()

virtual PxReal physx::NpFEMSoftBodyMaterial::getDampingScale ( ) const
virtual

Retrieves material damping scale.

Returns
The damping scale term.
See also
setDamping()

Implements physx::PxFEMSoftBodyMaterial.

◆ getDynamicFriction()

virtual PxReal physx::NpFEMSoftBodyMaterial::getDynamicFriction ( ) const
virtual

Retrieves the dynamic friction value.

Returns
The dynamic friction value
See also
setDynamicFriction()

Implements physx::PxFEMMaterial.

◆ getPoissons()

virtual PxReal physx::NpFEMSoftBodyMaterial::getPoissons ( ) const
virtual

Retrieves the Poisson's ratio.

Returns
The Poisson's ratio.
See also
setPoissons()

Implements physx::PxFEMMaterial.

◆ getReferenceCount()

virtual PxU32 physx::NpFEMSoftBodyMaterial::getReferenceCount ( ) const
virtual

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.

Implements physx::PxRefCounted.

◆ getYoungsModulus()

virtual PxReal physx::NpFEMSoftBodyMaterial::getYoungsModulus ( ) const
virtual

Retrieves the young's modulus value.

Returns
The young's modulus value.
See also
setYoungsModulus()

Implements physx::PxFEMMaterial.

◆ onRefCountZero()

virtual void physx::NpFEMSoftBodyMaterial::onRefCountZero ( )
virtual

Reimplemented from physx::PxRefCounted.

◆ release()

virtual void physx::NpFEMSoftBodyMaterial::release ( )
virtual

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

Implements physx::PxRefCounted.

◆ setDamping()

virtual void physx::NpFEMSoftBodyMaterial::setDamping ( PxReal  damping)
virtual

Sets material velocity damping term.

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

See also
getDamping

Implements physx::PxFEMSoftBodyMaterial.

◆ setDampingScale()

virtual void physx::NpFEMSoftBodyMaterial::setDampingScale ( PxReal  scale)
virtual

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.

Parameters
[in]scaleDamping scale term. Default: 1 Range: [0, 1]
See also
getDampingScale

Implements physx::PxFEMSoftBodyMaterial.

◆ setDynamicFriction()

virtual void physx::NpFEMSoftBodyMaterial::setDynamicFriction ( PxReal  dynamicFriction)
virtual

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

Parameters
[in]dynamicFrictionThe dynamic friction value. Range: [0, PX_MAX_F32)
See also
getDynamicFriction()

Implements physx::PxFEMMaterial.

◆ setPoissons()

virtual void physx::NpFEMSoftBodyMaterial::setPoissons ( PxReal  poisson)
virtual

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.

Parameters
[in]poissonPoisson's ratio. Range: [0, 0.5)
See also
getPoissons()

Implements physx::PxFEMMaterial.

◆ setYoungsModulus()

virtual void physx::NpFEMSoftBodyMaterial::setYoungsModulus ( PxReal  young)
virtual

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

Parameters
[in]youngYoung's modulus. Range: [0, PX_MAX_F32)
See also
getYoungsModulus()

Implements physx::PxFEMMaterial.


The documentation for this class was generated from the following files: