physx::PxFEMSoftBodyMaterial Class Reference

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

#include <PxFEMSoftBodyMaterial.h>

Inheritance diagram for physx::PxFEMSoftBodyMaterial:

Collaboration diagram for physx::PxFEMSoftBodyMaterial:

Public Member Functions
virtual void	setDamping (PxReal damping)=0
	Sets material velocity damping term.
virtual PxReal	getDamping () const =0
	Retrieves 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.
virtual PxReal	getDampingScale () const =0
	Retrieves material damping scale.
virtual const char *	getConcreteTypeName () const
	Returns string name of dynamic type.
Public Member Functions inherited from physx::PxFEMMaterial
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
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	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
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 softbody FEM material properties.

See also

PxPhysics.createFEMSoftBodyMaterial

Member Function Documentation

getConcreteTypeName()

virtual const char * physx::PxFEMSoftBodyMaterial::getConcreteTypeName ( ) const

inlinevirtual

Returns string name of dynamic type.

Returns

Class name of most derived type of this object.

Implements physx::PxBase.

getDamping()

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

pure virtual

Retrieves velocity damping.

Returns

The velocity damping.

See also

setDamping()

Implemented in physx::NpFEMSoftBodyMaterial.

getDampingScale()

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

pure virtual

Retrieves material damping scale.

Returns

The damping scale term.

See also

setDamping()

Implemented in physx::NpFEMSoftBodyMaterial.

isKindOf()

virtual bool physx::PxFEMSoftBodyMaterial::isKindOf ( const char *  superClass ) const

inlineprotectedvirtual

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

Reimplemented from physx::PxFEMMaterial.

setDamping()

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

pure virtual

Sets material velocity damping term.

Parameters

[in]

damping

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

See also

getDamping

Implemented in physx::NpFEMSoftBodyMaterial.

setDampingScale()

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

pure 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]

scale

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

See also

getDampingScale

Implemented in physx::NpFEMSoftBodyMaterial.

---

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

• RavEngine/deps/physx/physx/include/PxFEMSoftBodyMaterial.h