MItSubdFace Class Reference
[OpenMaya - API module for common classes]

#include <MItSubdFace.h>

List of all members.


Detailed Description

Subdiv face iterator.

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

Public Member Functions

 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)


Constructor & Destructor Documentation

MItSubdFace::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:

MItSubdFace::~MItSubdFace (  )  [virtual]

Destructor. Frees up storage used by the iterator.


Member Function Documentation

MStatus MItSubdFace::reset (  ) 

Reset the iterator to the first face.

Returns:
Status code
Status Codes:

MStatus MItSubdFace::next (  ) 

Advance to the next face in the iteration.

Returns:
Status code
Status Codes:

bool MItSubdFace::isDone ( MStatus ReturnStatus = NULL  ) 

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:

bool MItSubdFace::isValid ( MStatus ReturnStatus = NULL  )  const

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:

unsigned int MItSubdFace::level ( MStatus ReturnStatus = NULL  )  const

Returns the level of the subdiv object.

Parameters:
[out] ReturnStatus Status code
Returns:
The level.
Status Codes:

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

Sets the level of the subdiv object

Parameters:
[out] ReturnStatus Status code
Returns:
Status Codes:

MUint64 MItSubdFace::index ( MStatus ReturnStatus = NULL  ) 

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:


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6