physx::PxFLIPMaterial Class Reference

Material class to represent a set of FLIP particle material properties. More...

#include <PxFLIPMaterial.h>

Inheritance diagram for physx::PxFLIPMaterial:

Collaboration diagram for physx::PxFLIPMaterial:

Public Member Functions
virtual void	setViscosity (PxReal viscosity)=0
	Sets viscosity.
virtual PxReal	getViscosity () const =0
	Retrieves the viscosity value.
virtual const char *	getConcreteTypeName () const
	Returns string name of dynamic type.
Public Member Functions inherited from physx::PxParticleMaterial
virtual void	setFriction (PxReal friction)=0
	Sets friction.
virtual PxReal	getFriction () const =0
	Retrieves the friction value.
virtual void	setDamping (PxReal damping)=0
	Sets velocity damping term.
virtual PxReal	getDamping () const =0
	Retrieves the velocity damping term.
virtual void	setAdhesion (PxReal adhesion)=0
	Sets adhesion term.
virtual PxReal	getAdhesion () const =0
	Retrieves the adhesion term.
virtual void	setGravityScale (PxReal scale)=0
	Sets gravity scale term.
virtual PxReal	getGravityScale () const =0
	Retrieves the gravity scale term.
virtual void	setAdhesionRadiusScale (PxReal scale)=0
	Sets material adhesion radius scale. This is multiplied by the particle rest offset to compute the fall-off distance at which point adhesion ceases to operate.
virtual PxReal	getAdhesionRadiusScale () const =0
	Retrieves the adhesion radius scale.
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	PxFLIPMaterial (PxType concreteType, PxBaseFlags baseFlags)
PX_INLINE	PxFLIPMaterial (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::PxParticleMaterial
PX_INLINE	PxParticleMaterial (PxType concreteType, PxBaseFlags baseFlags)
PX_INLINE	PxParticleMaterial (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 FLIP particle material properties.

See also

PxPhysics.createFLIPMaterial()

Member Function Documentation

getConcreteTypeName()

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

inlinevirtual

Returns string name of dynamic type.

Returns

Class name of most derived type of this object.

Implements physx::PxBase.

getViscosity()

virtual PxReal physx::PxFLIPMaterial::getViscosity ( ) const

pure virtual

Retrieves the viscosity value.

Returns

The viscosity value.

See also

setViscosity()

isKindOf()

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

inlineprotectedvirtual

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

Reimplemented from physx::PxParticleMaterial.

setViscosity()

virtual void physx::PxFLIPMaterial::setViscosity ( PxReal  viscosity )

pure virtual

Sets viscosity.

Parameters

[in]

viscosity

Viscosity. Range: [0, PX_MAX_F32)

See also

getViscosity()

---

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

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