class MClothTriangle

Jump to documentation

public members:

	MClothTriangle ()
virtual	~MClothTriangle ()
virtual MClothEdge *	getEdge ( unsigned int index, MStatus * ReturnStatus = NULL ) const
virtual MClothParticle *	getParticle ( unsigned int index, MStatus * ReturnStatus = NULL ) const
virtual MClothMaterial *	getMaterial ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	getUV ( int vertexIndex, double& u, double& v ) const
virtual MStatus	getUVs ( MDoubleArray & uArray, MDoubleArray & vArray ) const
virtual bool	contains ( MClothParticle *n ) const
virtual bool	equals ( MClothTriangle *triangle ) const

Documentation

Description

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

Functions

MClothTriangle:: MClothTriangle ()

Description

Class constructor.

MClothTriangle:: ~MClothTriangle ()

Description

Class destructor.

bool MClothTriangle:: equals ( MClothTriangle *triangle) const

Description

Compares the two cloth triangle objects.

Arguments

• edge The triangle to compare.

Return Value

• A boolean true or false.

bool MClothTriangle:: contains ( MClothParticle *particle) const

Description

Check if given cloth particle is contained in this triangle.

Arguments

• particle The particle to check.

Return Value

• A boolean true or false.

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

Description

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

Arguments

• index The edge index.
• ReturnStatus Status code.

Return Value

• Cloth Edge.

Status Codes

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

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

Description

This method returns particle associated with this triangle 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.

MClothMaterial * MClothTriangle:: getMaterial ( MStatus * ReturnStatus ) const

Description

This method returns the cloth material associated with this triangle.

Arguments

• ReturnStatus Status code.

Return Value

• Cloth Material.

Status Codes

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

MStatus MClothTriangle:: getUV ( int vertexIndex, double& u, double& v ) const

Description

Get the value of the specified texture coordinate from this triangle's uv list. The vertexIndex is the element in the uv list that will be retrieved.

Arguments

• vertexIndex The element in the uv list to examine
• u Storage for the u value
• v Storage for the v value

Return Value

• Status code

Status Codes

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

MStatus MClothTriangle:: getUVs ( MDoubleArray & uArray, MDoubleArray & vArray ) const

Description

This method copies the texture coordinate list for this triangle into the given uv arrays.

Arguments

• uArray Storage for the u texture coordinate list
• vArray Storage for the v texture coordinate list

Return Value

• Status code

Status Codes

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

This class has no child classes.