class MItSubdFace

Jump to documentation

public members:

	MItSubdFace ( MObject & subdObject, MStatus * ReturnStatus = NULL)
virtual	~MItSubdFace ()
MStatus	reset ()
MStatus	next ()
bool	isDone ( MStatus * ReturnStatus = NULL)
bool	isValid ( MStatus * ReturnStatus = NULL) const
unsigned int	level ( MStatus * ReturnStatus = NULL) const
void	setLevel (unsigned int level , MStatus * ReturnStatus = NULL)
MUint64	index ( MStatus * ReturnStatus = NULL)

Documentation

Description

This class is the iterator for subdiv faces.

The iterator functions in two modes depending on whether a component is specified. When a component is not given or is NULL the iteration will be over all vertices for the subdiv.

Functions

MItSubdFace:: MItSubdFace ( MObject & subdObject, MStatus * ReturnStatus )

Description

Constructor. Creates an iterator for all faces of the given subdiv surface.

Arguments

• subdObject The subdiv surface
• ReturnStatus Status code

Status Codes

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

MItSubdFace:: ~MItSubdFace ()

Description

Destructor.
Frees up storage used by the iterator.

MStatus MItSubdFace:: reset ()

Description

Reset the iterator to the first face.

Return Value

• Status code

Status Codes

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

MStatus MItSubdFace:: next ()

Description

Advance to the next face in the iteration.

Return Value

• Status code

Status Codes

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

bool MItSubdFace:: isDone ( MStatus * ReturnStatus )

Description

Indicates if all of the faces have been traversed yet.

Arguments

• ReturnStatus Status code

Return Value

• true All vertices have been traversed
• false There are more vertices in the iteration

Status Codes

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

bool MItSubdFace:: isValid ( MStatus * ReturnStatus) const

Description

Checks if the iterator is valid.

Arguments

• ReturnStatus Status code

Return Value

• bool Boolean to indicate whether the iterator is valid or not.

Status Codes

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

unsigned int MItSubdFace:: level ( MStatus * ReturnStatus ) const

Description

Returns the level of the subdiv object.

Arguments

• ReturnStatus Status code

Return Value

• The level.

Status Codes

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

void MItSubdFace:: setLevel ( unsigned int level , MStatus * ReturnStatus )

Description

Sets the level of the subdiv object

Arguments

• ReturnStatus Status code

Return Value

Status Codes

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

MUint64 MItSubdFace:: index ( MStatus * ReturnStatus )

Description

Returns the index of the current face for this subdiv object.

Arguments

• ReturnStatus Status code

Return Value

• The index in the face list for the current face

Status Codes

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

This class has no child classes.