class MClothEdge

Jump to documentation

public members:

	MClothEdge ()
virtual	~MClothEdge ()
virtual MClothParticle *	getParticle ( unsigned int index, MStatus * ReturnStatus = NULL ) const
virtual MClothTriangle *	getTriangle ( unsigned int index, MStatus * ReturnStatus = NULL ) const
virtual void	setCreaseAngle ( const double theta, MStatus * ReturnStatus = NULL )
virtual double	getCreaseAngle ( MStatus * ReturnStatus = NULL ) const
virtual bool	equals ( MClothEdge *edge) const

Documentation

Description

This class provides interface for cloth edge. Cloth solver writers should derive their edge class from this class. Common convenience methods are available.

Functions

MClothEdge:: MClothEdge ()

Description

Class constructor.

MClothEdge:: ~MClothEdge ()

Description

Class destructor.

bool MClothEdge:: equals ( MClothEdge *edge) const

Description

Compares the two cloth edge objects.

Arguments

• edge The edge to compare.

Return Value

• A boolean true or false.

MClothTriangle * MClothEdge:: getTriangle ( unsigned int index, MStatus * ReturnStatus ) const

Description

This method returns triangle associated with this edge for a given index.

Arguments

• index The triangle index.
• ReturnStatus Status code.

Return Value

• Cloth Triangle.

Status Codes

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

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

Description

This method returns particle associated with this edge 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 MClothEdge:: setCreaseAngle ( const double theta, MStatus * ReturnStatus )

Description

This method sets the crease angle for this edge.

Arguments

• theta The crease angle.
• ReturnStatus Status code.

Return Value

Status Codes

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

double MClothEdge:: getCreaseAngle ( MStatus * ReturnStatus ) const

Description

This method returns the crease angle for this edge.

Arguments

• ReturnStatus Status code.

Return Value

• crease angle.

Status Codes

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

This class has no child classes.