MItSubdFace Class Reference

Search for all occurrences

---

Detailed Description

Subdiv face iterator.

This class is the iterator for subdiv faces. It will iterate over all of the surface's faces.

#include <MItSubdFace.h>

List of all members.

Public Member Functions
	MItSubdFace (MObject &subdObject, MStatus *ReturnStatus=NULL)
	Constructor.
virtual	~MItSubdFace ()
	Destructor.
MStatus	reset ()
	Reset the iterator to the first face.
MStatus	next ()
	Advance to the next face in the iteration.
bool	isDone (MStatus *ReturnStatus=NULL)
	Indicates if all of the faces have been traversed yet.
bool	isValid (MStatus *ReturnStatus=NULL) const
	Checks if the iterator is valid.
unsigned int	level (MStatus *ReturnStatus=NULL) const
	Returns the level of the subdiv object.
void	setLevel (unsigned int level, MStatus *ReturnStatus=NULL)
	Sets the level of the subdiv object.
MUint64	index (MStatus *ReturnStatus=NULL)
	Returns the index of the current face for this subdiv object.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class.

---

Constructor & Destructor Documentation

MItSubdFace	(	MObject &	subdObject,
		MStatus *	ReturnStatus = NULL
	)

Constructor.

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

Parameters:

[in]	subdObject	The subdiv surface
[out]	ReturnStatus	Status code

Status Codes:

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

~MItSubdFace

(

)

[virtual]

Destructor.

Frees up storage used by the iterator.

---

Member Function Documentation

MStatus reset

(

)

Search for all occurrences

Reset the iterator to the first face.

Returns:

Status code

Status Codes:

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

MStatus next

(

)

Search for all occurrences

Advance to the next face in the iteration.

Returns:

Status code

Status Codes:

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

bool isDone

(

MStatus *

ReturnStatus = NULL

)

Search for all occurrences

Indicates if all of the faces have been traversed yet.

Parameters:

[out]

ReturnStatus

Status code

Returns:

• 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 isValid

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Checks if the iterator is valid.

Parameters:

[out]

ReturnStatus

Status code

Returns:

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 level

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

Returns the level of the subdiv object.

Parameters:

[out]

ReturnStatus

Status code

Returns:

The level.

Status Codes:

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

void setLevel	(	unsigned int	level,
		MStatus *	ReturnStatus = NULL
	)

Search for all occurrences

Sets the level of the subdiv object.

Parameters:

[in]	level	New level.
[out]	ReturnStatus	Status code

Returns:

Status Codes:

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

MUint64 index

(

MStatus *

ReturnStatus = NULL

)

Search for all occurrences

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

Parameters:

[out]

ReturnStatus

Status code

Returns:

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.

const char * className

(

)

[static]

Search for all occurrences

Returns the name of this class.

Returns:

The name of this class.