Public Member Functions | Static Public Member Functions

MItSubdVertex Class Reference

Search for all occurrences

Detailed Description

Subdiv vertex iterator.

This class is the iterator for subdiv vertices.

#include <MItSubdVertex.h>

List of all members.

Public Member Functions

 MItSubdVertex (MObject &subdObject, MStatus *ReturnStatus=NULL)
 Constructor.
virtual ~MItSubdVertex ()
 Destructor.
bool isDone (MStatus *ReturnStatus=NULL)
 Indicates if all of the vertices have been traversed yet.
MStatus next ()
 Advance to the next vertex in the iteration.
MStatus reset ()
 Reset the iterator to the first vertex.
int level (MStatus *ReturnStatus=NULL) const
 Returns the level of the subdiv object.
void setLevel (int level, MStatus *ReturnStatus=NULL)
 Sets the level of the subdiv object.
bool isValid (MStatus *ReturnStatus=NULL) const
 Checks if the iterator is valid.
MUint64 index (MStatus *ReturnStatus=NULL)
 Returns the index of the current vertex in the vertex list for this subdiv object.

Static Public Member Functions

static const char * className ()
 Returns the name of this class.

Constructor & Destructor Documentation

MItSubdVertex ( MObject subdObject,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]subdObjectThe subd surface to iterate over
[out]ReturnStatusStatus code
Status Codes:
~MItSubdVertex ( ) [virtual]

Destructor.

Frees up storage used by the iterator.


Member Function Documentation

bool isDone ( MStatus ReturnStatus = NULL)

Indicates if all of the vertices 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:
MStatus next ( )

Advance to the next vertex in the iteration.

Returns:
Status code
Status Codes:
MStatus reset ( )

Reset the iterator to the first vertex.

Returns:
Status code
Status Codes:
int level ( MStatus ReturnStatus = NULL) const

Returns the level of the subdiv object.

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

Sets the level of the subdiv object.

Parameters:
[in]levelLevel of the subdiv
[out]ReturnStatusStatus code
Status Codes:
bool isValid ( MStatus ReturnStatus = NULL) const

Checks if the iterator is valid.

Parameters:
[out]ReturnStatusStatus code
Returns:
Boolean to indicate whether the iterator is valid or not.
Status Codes:
MUint64 index ( MStatus ReturnStatus = NULL)

Returns the index of the current vertex in the vertex list for this subdiv object.

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

Returns the name of this class.

Returns:
The name of this class.

MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex
MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex MItSubdVertex