RavEngine
Loading...
Searching...
No Matches
physx::PxFEMMaterial Class Referenceabstract

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

#include <PxFEMMaterial.h>

Inheritance diagram for physx::PxFEMMaterial:
[legend]
Collaboration diagram for physx::PxFEMMaterial:
[legend]

Public Member Functions

virtual void setYoungsModulus (PxReal young)=0
 Sets young's modulus which defines the body's stiffness.
 
virtual PxReal getYoungsModulus () const =0
 Retrieves 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.
 
virtual PxReal getPoissons () const =0
 Retrieves 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.
 
virtual PxReal getDynamicFriction () const =0
 Retrieves the dynamic friction value.
 
- 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::PxRefCounted
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.
 
virtual void acquireReference ()=0
 Acquires a counted reference to this object.
 
- Public Member Functions inherited from physx::PxBase
virtual const char * getConcreteTypeName () const =0
 Returns string name of dynamic type.
 
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.
 

Protected Member Functions

PX_INLINE PxFEMMaterial (PxType concreteType, PxBaseFlags baseFlags)
 
PX_INLINE PxFEMMaterial (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::PxRefCounted
virtual void onRefCountZero ()
 
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
 

Additional Inherited Members

- 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.
 
- Protected Attributes inherited from physx::PxBase
PxType mConcreteType
 
PxBaseFlags mBaseFlags
 
PxU32 mBuiltInRefCount
 

Detailed Description

Material class to represent a set of FEM material properties.

See also
PxPhysics.createFEMSoftBodyMaterial

Member Function Documentation

◆ getDynamicFriction()

virtual PxReal physx::PxFEMMaterial::getDynamicFriction ( ) const
pure virtual

Retrieves the dynamic friction value.

Returns
The dynamic friction value
See also
setDynamicFriction()

Implemented in physx::NpFEMSoftBodyMaterial.

◆ getPoissons()

virtual PxReal physx::PxFEMMaterial::getPoissons ( ) const
pure virtual

Retrieves the Poisson's ratio.

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

Implemented in physx::NpFEMSoftBodyMaterial.

◆ getYoungsModulus()

virtual PxReal physx::PxFEMMaterial::getYoungsModulus ( ) const
pure virtual

Retrieves the young's modulus value.

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

Implemented in physx::NpFEMSoftBodyMaterial.

◆ isKindOf()

virtual bool physx::PxFEMMaterial::isKindOf ( const char *  superClass) const
inlineprotectedvirtual

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

Reimplemented from physx::PxBaseMaterial.

Reimplemented in physx::PxFEMClothMaterial, and physx::PxFEMSoftBodyMaterial.

◆ setDynamicFriction()

virtual void physx::PxFEMMaterial::setDynamicFriction ( PxReal  dynamicFriction)
pure 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()

Implemented in physx::NpFEMSoftBodyMaterial.

◆ setPoissons()

virtual void physx::PxFEMMaterial::setPoissons ( PxReal  poisson)
pure 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()

Implemented in physx::NpFEMSoftBodyMaterial.

◆ setYoungsModulus()

virtual void physx::PxFEMMaterial::setYoungsModulus ( PxReal  young)
pure virtual

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

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

Implemented in physx::NpFEMSoftBodyMaterial.


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