Public Member Functions | Static Public Member Functions

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]subdObjectThe subdiv surface
[out]ReturnStatusStatus code
Status Codes:
~MItSubdFace ( ) [virtual]

Destructor.

Frees up storage used by the iterator.


Member Function Documentation

MStatus reset ( )

Reset the iterator to the first face.

Returns:
Status code
Status Codes:
MStatus next ( )

Advance to the next face in the iteration.

Returns:
Status code
Status Codes:
bool isDone ( MStatus ReturnStatus = NULL)

Indicates if all of the faces have been traversed yet.

Parameters:
[out]ReturnStatusStatus code
Returns:
  • true All vertices have been traversed
  • false There are more vertices in the iteration
Status Codes:
bool isValid ( MStatus ReturnStatus = NULL) const

Checks if the iterator is valid.

Parameters:
[out]ReturnStatusStatus code
Returns:
bool Boolean to indicate whether the iterator is valid or not.
Status Codes:
unsigned int level ( MStatus ReturnStatus = NULL) const

Returns the level of the subdiv object.

Parameters:
[out]ReturnStatusStatus code
Returns:
The level.
Status Codes:
void setLevel ( unsigned int  level,
MStatus ReturnStatus = NULL 
)

Sets the level of the subdiv object.

Parameters:
[in]levelNew level.
[out]ReturnStatusStatus code
Returns:
Status Codes:
MUint64 index ( MStatus ReturnStatus = NULL)

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

Parameters:
[out]ReturnStatusStatus code
Returns:
The index in the face list for the current face
Status Codes:
const char * className ( ) [static]

Returns the name of this class.

Returns:
The name of this class.

MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace
MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace MItSubdFace