class MClothForce

Jump to documentation

public members:

	MClothForce ()
virtual	~MClothForce ()
virtual void	setStrength ( double shear, double damp, MStatus * ReturnStatus = NULL )
virtual void	setOffset ( double offset, MStatus * ReturnStatus = NULL )
virtual MClothParticle *	getParticle ( unsigned int index, MStatus * ReturnStatus = NULL ) const

Documentation

Description

This class provides interface for cloth force system.

Functions

MClothForce:: MClothForce ()

Description

Class constructor.

MClothForce:: ~MClothForce ()

Description

Class destructor.

MClothParticle * MClothForce:: getParticle ( unsigned int index, MStatus * ReturnStatus ) const

Description

This method returns particle for a given index.

Arguments

• index The particle index.
• ReturnStatus Status code.

Return Value

• Cloth Particle.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

void MClothForce:: setStrength ( double shear, double damp, MStatus * ReturnStatus )

Description

This method sets the shear and damp values for this cloth force.

Arguments

• shear The shear value.
• shear The damp value.
• ReturnStatus Status code.

Return Value

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

void MClothForce:: setOffset ( double offset, MStatus * ReturnStatus )

Description

This method sets the offset value for this cloth force.

Arguments

• offset The offset value.
• ReturnStatus Status code.

Return Value

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

This class has no child classes.