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

#include <PxPBDMaterial.h>

Inheritance diagram for physx::PxPBDMaterial:

Collaboration diagram for physx::PxPBDMaterial:

Public Member Functions
virtual void	setViscosity (PxReal viscosity)=0
	Sets viscosity.

virtual PxReal	getViscosity () const =0
	Retrieves the viscosity value.

virtual void	setVorticityConfinement (PxReal vorticityConfinement)=0
	Sets material vorticity confinement coefficient.

virtual PxReal	getVorticityConfinement () const =0
	Retrieves the vorticity confinement coefficient.

virtual void	setSurfaceTension (PxReal surfaceTension)=0
	Sets material surface tension coefficient.

virtual PxReal	getSurfaceTension () const =0
	Retrieves the surface tension coefficient.

virtual void	setCohesion (PxReal cohesion)=0
	Sets material cohesion coefficient.

virtual PxReal	getCohesion () const =0
	Retrieves the cohesion coefficient.

virtual void	setLift (PxReal lift)=0
	Sets material lift coefficient.

virtual PxReal	getLift () const =0
	Retrieves the lift coefficient.

virtual void	setDrag (PxReal drag)=0
	Sets material drag coefficient.

virtual PxReal	getDrag () const =0
	Retrieves the drag coefficient.

virtual void	setCFLCoefficient (PxReal coefficient)=0
	Sets the CFL coefficient.

virtual PxReal	getCFLCoefficient () const =0
	Retrieves the CFL coefficient.

virtual void	setParticleFrictionScale (PxReal scale)=0
	Sets material particle friction scale. This allows the application to scale up/down the frictional effect between particles independent of the friction coefficient, which also defines frictional behavior between the particle and rigid bodies/soft bodies/cloth etc.

virtual PxReal	getParticleFrictionScale () const =0
	Retrieves the particle friction scale.

virtual void	setParticleAdhesionScale (PxReal adhesion)=0
	Sets material particle adhesion scale value. This is the adhesive value between particles defined as a scaled multiple of the adhesion parameter.

virtual PxReal	getParticleAdhesionScale () const =0
	Retrieves the particle adhesion scale 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	PxPBDMaterial (PxType concreteType, PxBaseFlags baseFlags)

PX_INLINE	PxPBDMaterial (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 PBD particle material properties.

See also: PxPhysics.createPBDMaterial

Member Function Documentation

◆ getCFLCoefficient()

virtual PxReal physx::PxPBDMaterial::getCFLCoefficient ( ) const

pure virtual

Retrieves the CFL coefficient.

Returns: The CFL coefficient.

See also: setCFLCoefficient()

Implemented in physx::NpPBDMaterial.

◆ getCohesion()

virtual PxReal physx::PxPBDMaterial::getCohesion ( ) const

pure virtual

Retrieves the cohesion coefficient.

Returns: The cohesion coefficient.

See also: setCohesion()

Implemented in physx::NpPBDMaterial.

◆ getConcreteTypeName()

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

inlinevirtual

Returns string name of dynamic type.

Returns: Class name of most derived type of this object.

Implements physx::PxBase.

◆ getDrag()

virtual PxReal physx::PxPBDMaterial::getDrag ( ) const

pure virtual

Retrieves the drag coefficient.

Returns: The drag coefficient.

See also: setDrag()

Implemented in physx::NpPBDMaterial.

◆ getLift()

virtual PxReal physx::PxPBDMaterial::getLift ( ) const

pure virtual

Retrieves the lift coefficient.

Returns: The lift coefficient.

See also: setLift()

Implemented in physx::NpPBDMaterial.

◆ getParticleAdhesionScale()

virtual PxReal physx::PxPBDMaterial::getParticleAdhesionScale ( ) const

pure virtual

Retrieves the particle adhesion scale value.

Returns: The particle adhesion scale value.

See also: setParticleAdhesionScale()

Implemented in physx::NpPBDMaterial.

◆ getParticleFrictionScale()

virtual PxReal physx::PxPBDMaterial::getParticleFrictionScale ( ) const

pure virtual

Retrieves the particle friction scale.

Returns: The particle friction scale.

See also: setParticleFrictionScale()

Implemented in physx::NpPBDMaterial.

◆ getSurfaceTension()

virtual PxReal physx::PxPBDMaterial::getSurfaceTension ( ) const

pure virtual

Retrieves the surface tension coefficient.

Returns: The surface tension coefficient.

See also: setSurfaceTension()

Implemented in physx::NpPBDMaterial.

◆ getViscosity()

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

pure virtual

Retrieves the viscosity value.

Returns: The viscosity value.

See also: setViscosity()

Implemented in physx::NpPBDMaterial.

◆ getVorticityConfinement()

virtual PxReal physx::PxPBDMaterial::getVorticityConfinement ( ) const

pure virtual

Retrieves the vorticity confinement coefficient.

Returns: The vorticity confinement coefficient.

See also: setVorticityConfinement()

Implemented in physx::NpPBDMaterial.

◆ isKindOf()

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

inlineprotectedvirtual

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

Reimplemented from physx::PxParticleMaterial.

◆ setCFLCoefficient()

virtual void physx::PxPBDMaterial::setCFLCoefficient ( PxReal coefficient )

pure virtual

Sets the CFL coefficient.

Parameters

[in] coefficient CFL coefficient. This coefficient scales the CFL term used to limit relative motion between fluid particles. Range: [1.f, PX_MAX_F32)

Implemented in physx::NpPBDMaterial.

◆ setCohesion()

virtual void physx::PxPBDMaterial::setCohesion ( PxReal cohesion )

pure virtual

Sets material cohesion coefficient.

Parameters

[in] cohesion Material cohesion coefficient. Range: [0, PX_MAX_F32)

See also: getCohesion()

Implemented in physx::NpPBDMaterial.

◆ setDrag()

virtual void physx::PxPBDMaterial::setDrag ( PxReal drag )

pure virtual

Sets material drag coefficient.

Parameters

[in] drag Material drag coefficient. Range: [0, PX_MAX_F32)

See also: getDrag()

Implemented in physx::NpPBDMaterial.

◆ setLift()

virtual void physx::PxPBDMaterial::setLift ( PxReal lift )

pure virtual

Sets material lift coefficient.

Parameters

[in] lift Material lift coefficient. Range: [0, PX_MAX_F32)

See also: getLift()

Implemented in physx::NpPBDMaterial.

◆ setParticleAdhesionScale()

virtual void physx::PxPBDMaterial::setParticleAdhesionScale ( PxReal adhesion )

pure virtual

Sets material particle adhesion scale value. This is the adhesive value between particles defined as a scaled multiple of the adhesion parameter.

Parameters

[in] adhesion particle adhesion scale value. Range: [0, PX_MAX_F32)

See also: getParticleAdhesionScale()

Implemented in physx::NpPBDMaterial.

◆ setParticleFrictionScale()

virtual void physx::PxPBDMaterial::setParticleFrictionScale ( PxReal scale )

pure virtual

Sets material particle friction scale. This allows the application to scale up/down the frictional effect between particles independent of the friction coefficient, which also defines frictional behavior between the particle and rigid bodies/soft bodies/cloth etc.

Parameters

[in] scale particle friction scale. Range: [0, PX_MAX_F32)

See also: getParticleFrictionScale()

Implemented in physx::NpPBDMaterial.

◆ setSurfaceTension()

virtual void physx::PxPBDMaterial::setSurfaceTension ( PxReal surfaceTension )

pure virtual

Sets material surface tension coefficient.

Parameters

[in] surfaceTension Material surface tension coefficient. Range: [0, PX_MAX_F32)

See also: getSurfaceTension()

Implemented in physx::NpPBDMaterial.

◆ setViscosity()

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

pure virtual

Sets viscosity.

Parameters

[in] viscosity Viscosity. Range: [0, PX_MAX_F32)

See also: getViscosity()

Implemented in physx::NpPBDMaterial.

◆ setVorticityConfinement()

virtual void physx::PxPBDMaterial::setVorticityConfinement ( PxReal vorticityConfinement )

pure virtual

Sets material vorticity confinement coefficient.

Parameters

[in] vorticityConfinement Material vorticity confinement coefficient. Range: [0, PX_MAX_F32)

See also: getVorticityConfinement()

Implemented in physx::NpPBDMaterial.

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

RavEngine/deps/physx/physx/include/PxPBDMaterial.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCFLCoefficient()

◆ getCohesion()

◆ getConcreteTypeName()

◆ getDrag()

◆ getLift()

◆ getParticleAdhesionScale()

◆ getParticleFrictionScale()

◆ getSurfaceTension()

◆ getViscosity()

◆ getVorticityConfinement()

◆ isKindOf()

◆ setCFLCoefficient()

◆ setCohesion()

◆ setDrag()

◆ setLift()

◆ setParticleAdhesionScale()

◆ setParticleFrictionScale()

◆ setSurfaceTension()

◆ setViscosity()

◆ setVorticityConfinement()