Inheritance diagram for physx::NpPBDMaterial:

Collaboration diagram for physx::NpPBDMaterial:

Public Member Functions
	NpPBDMaterial (PxBaseFlags baseFlags)

virtual void	resolveReferences (PxDeserializationContext &context)

void	preExportDataReset ()

void	exportExtraData (PxSerializationContext &)

void	importExtraData (PxDeserializationContext &)

virtual void	requiresObjects (PxProcessPxBaseCallback &)

	NpPBDMaterial (const PxsPBDMaterialCore &desc)

virtual void	release () PX_OVERRIDE
	Decrements the reference count of the object and releases it if the new reference count is zero.

virtual void	acquireReference () PX_OVERRIDE
	Acquires a counted reference to this object.

virtual PxU32	getReferenceCount () const PX_OVERRIDE
	Returns the reference count of the object.

virtual void	onRefCountZero () PX_OVERRIDE

virtual void	setFriction (PxReal friction) PX_OVERRIDE
	Sets friction.

virtual PxReal	getFriction () const PX_OVERRIDE
	Retrieves the friction value.

virtual void	setDamping (PxReal damping) PX_OVERRIDE
	Sets velocity damping term.

virtual PxReal	getDamping () const PX_OVERRIDE
	Retrieves the velocity damping term.

virtual void	setAdhesion (PxReal adhesion) PX_OVERRIDE
	Sets adhesion term.

virtual PxReal	getAdhesion () const PX_OVERRIDE
	Retrieves the adhesion term.

virtual void	setGravityScale (PxReal scale) PX_OVERRIDE
	Sets gravity scale term.

virtual PxReal	getGravityScale () const PX_OVERRIDE
	Retrieves the gravity scale term.

virtual void	setAdhesionRadiusScale (PxReal scale) PX_OVERRIDE
	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 PX_OVERRIDE
	Retrieves the adhesion radius scale.

virtual void	setViscosity (PxReal viscosity) PX_OVERRIDE
	Sets viscosity.

virtual PxReal	getViscosity () const PX_OVERRIDE
	Retrieves the viscosity value.

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

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

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

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

virtual void	setCohesion (PxReal cohesion) PX_OVERRIDE
	Sets material cohesion coefficient.

virtual PxReal	getCohesion () const PX_OVERRIDE
	Retrieves the cohesion coefficient.

virtual void	setLift (PxReal lift) PX_OVERRIDE
	Sets material lift coefficient.

virtual PxReal	getLift () const PX_OVERRIDE
	Retrieves the lift coefficient.

virtual void	setDrag (PxReal drag) PX_OVERRIDE
	Sets material drag coefficient.

virtual PxReal	getDrag () const PX_OVERRIDE
	Retrieves the drag coefficient.

virtual void	setCFLCoefficient (PxReal coefficient) PX_OVERRIDE
	Sets the CFL coefficient.

virtual PxReal	getCFLCoefficient () const PX_OVERRIDE
	Retrieves the CFL coefficient.

virtual void	setParticleFrictionScale (PxReal scale) PX_OVERRIDE
	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 PX_OVERRIDE
	Retrieves the particle friction scale.

virtual void	setParticleAdhesionScale (PxReal adhesion) PX_OVERRIDE
	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 PX_OVERRIDE
	Retrieves the particle adhesion scale value.

Public Member Functions inherited from physx::PxPBDMaterial
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 NpPBDMaterial *	createObject (PxU8 *&address, PxDeserializationContext &context)

static void	getBinaryMetaData (PxOutputStream &stream)

static PX_FORCE_INLINE void	getMaterialIndices (NpPBDMaterial const materials, PxU16 *materialIndices, PxU32 materialCount)

Public Attributes
PxsPBDMaterialCore	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::PxPBDMaterial
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
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::NpPBDMaterial::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.

◆ getAdhesion()

virtual PxReal physx::NpPBDMaterial::getAdhesion ( ) const

virtual

Retrieves the adhesion term.

Returns: The adhesion term.

See also: setAdhesion()

Implements physx::PxParticleMaterial.

◆ getAdhesionRadiusScale()

virtual PxReal physx::NpPBDMaterial::getAdhesionRadiusScale ( ) const

virtual

Retrieves the adhesion radius scale.

Returns: The adhesion radius scale.

See also: setAdhesionRadiusScale()

Implements physx::PxParticleMaterial.

◆ getCFLCoefficient()

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

virtual

Retrieves the CFL coefficient.

Returns: The CFL coefficient.

See also: setCFLCoefficient()

Implements physx::PxPBDMaterial.

◆ getCohesion()

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

virtual

Retrieves the cohesion coefficient.

Returns: The cohesion coefficient.

See also: setCohesion()

Implements physx::PxPBDMaterial.

◆ getDamping()

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

virtual

Retrieves the velocity damping term.

Returns: The velocity damping term.

See also: setDamping()

Implements physx::PxParticleMaterial.

◆ getDrag()

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

virtual

Retrieves the drag coefficient.

Returns: The drag coefficient.

See also: setDrag()

Implements physx::PxPBDMaterial.

◆ getFriction()

virtual PxReal physx::NpPBDMaterial::getFriction ( ) const

virtual

Retrieves the friction value.

Returns: The friction value.

See also: setFriction()

Implements physx::PxParticleMaterial.

◆ getGravityScale()

virtual PxReal physx::NpPBDMaterial::getGravityScale ( ) const

virtual

Retrieves the gravity scale term.

Returns: The gravity scale term.

See also: setAdhesion()

Implements physx::PxParticleMaterial.

◆ getLift()

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

virtual

Retrieves the lift coefficient.

Returns: The lift coefficient.

See also: setLift()

Implements physx::PxPBDMaterial.

◆ getParticleAdhesionScale()

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

virtual

Retrieves the particle adhesion scale value.

Returns: The particle adhesion scale value.

See also: setParticleAdhesionScale()

Implements physx::PxPBDMaterial.

◆ getParticleFrictionScale()

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

virtual

Retrieves the particle friction scale.

Returns: The particle friction scale.

See also: setParticleFrictionScale()

Implements physx::PxPBDMaterial.

◆ getReferenceCount()

virtual PxU32 physx::NpPBDMaterial::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.

◆ getSurfaceTension()

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

virtual

Retrieves the surface tension coefficient.

Returns: The surface tension coefficient.

See also: setSurfaceTension()

Implements physx::PxPBDMaterial.

◆ getViscosity()

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

virtual

Retrieves the viscosity value.

Returns: The viscosity value.

See also: setViscosity()

Implements physx::PxPBDMaterial.

◆ getVorticityConfinement()

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

virtual

Retrieves the vorticity confinement coefficient.

Returns: The vorticity confinement coefficient.

See also: setVorticityConfinement()

Implements physx::PxPBDMaterial.

◆ onRefCountZero()

virtual void physx::NpPBDMaterial::onRefCountZero ( )

virtual

Reimplemented from physx::PxRefCounted.

◆ release()

virtual void physx::NpPBDMaterial::release ( )

virtual

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

Implements physx::PxRefCounted.

◆ setAdhesion()

virtual void physx::NpPBDMaterial::setAdhesion ( PxReal adhesion )

virtual

Sets adhesion term.

Parameters

[in] adhesion adhesion coefficient. Range: [0, PX_MAX_F32)

See also: getAdhesion

Implements physx::PxParticleMaterial.

◆ setAdhesionRadiusScale()

virtual void physx::NpPBDMaterial::setAdhesionRadiusScale ( PxReal scale )

virtual

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.

Parameters

[in] scale Material adhesion radius scale. Range: [0, PX_MAX_F32)

See also: getAdhesionRadiusScale

Implements physx::PxParticleMaterial.

◆ setCFLCoefficient()

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

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)

Implements physx::PxPBDMaterial.

◆ setCohesion()

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

virtual

Sets material cohesion coefficient.

Parameters

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

See also: getCohesion()

Implements physx::PxPBDMaterial.

◆ setDamping()

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

virtual

Sets velocity damping term.

Parameters

[in] damping Velocity damping term. Range: [0, PX_MAX_F32)

See also: getDamping

Implements physx::PxParticleMaterial.

◆ setDrag()

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

virtual

Sets material drag coefficient.

Parameters

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

See also: getDrag()

Implements physx::PxPBDMaterial.

◆ setFriction()

virtual void physx::NpPBDMaterial::setFriction ( PxReal friction )

virtual

Sets friction.

Parameters

[in] friction Friction. Range: [0, PX_MAX_F32)

See also: getFriction()

Implements physx::PxParticleMaterial.

◆ setGravityScale()

virtual void physx::NpPBDMaterial::setGravityScale ( PxReal scale )

virtual

Sets gravity scale term.

Parameters

[in] scale gravity scale coefficient. Range: (-PX_MAX_F32, PX_MAX_F32)

See also: getAdhesion

Implements physx::PxParticleMaterial.

◆ setLift()

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

virtual

Sets material lift coefficient.

Parameters

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

See also: getLift()

Implements physx::PxPBDMaterial.

◆ setParticleAdhesionScale()

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

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

Implements physx::PxPBDMaterial.

◆ setParticleFrictionScale()

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

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

Implements physx::PxPBDMaterial.

◆ setSurfaceTension()

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

virtual

Sets material surface tension coefficient.

Parameters

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

See also: getSurfaceTension()

Implements physx::PxPBDMaterial.

◆ setViscosity()

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

virtual

Sets viscosity.

Parameters

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

See also: getViscosity()

Implements physx::PxPBDMaterial.

◆ setVorticityConfinement()

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

virtual

Sets material vorticity confinement coefficient.

Parameters

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

See also: getVorticityConfinement()

Implements physx::PxPBDMaterial.

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

RavEngine/deps/physx/physx/source/physx/src/NpPBDMaterial.h
RavEngine/deps/physx/physx/source/physx/src/NpMetaData.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ acquireReference()

◆ getAdhesion()

◆ getAdhesionRadiusScale()

◆ getCFLCoefficient()

◆ getCohesion()

◆ getDamping()

◆ getDrag()

◆ getFriction()

◆ getGravityScale()

◆ getLift()

◆ getParticleAdhesionScale()

◆ getParticleFrictionScale()

◆ getReferenceCount()

◆ getSurfaceTension()

◆ getViscosity()

◆ getVorticityConfinement()

◆ onRefCountZero()

◆ release()

◆ setAdhesion()

◆ setAdhesionRadiusScale()

◆ setCFLCoefficient()

◆ setCohesion()

◆ setDamping()

◆ setDrag()

◆ setFriction()

◆ setGravityScale()

◆ setLift()

◆ setParticleAdhesionScale()

◆ setParticleFrictionScale()

◆ setSurfaceTension()

◆ setViscosity()

◆ setVorticityConfinement()