C++ API Reference
Public Member Functions | Static Public Member Functions | List of all members
MItSubdVertex Class Reference
OpenMaya - API module for common classes

Subdiv vertex iterator. More...

#include <MItSubdVertex.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Subdiv vertex iterator.

This class is the iterator for subdiv vertices.

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN 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:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
~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:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MStatus next ( )

Advance to the next vertex in the iteration.

Returns
Status code
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MStatus reset ( )

Reset the iterator to the first vertex.

Returns
Status code
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
int level ( MStatus *  ReturnStatus = NULL) const

Returns the level of the subdiv object.

Parameters
[out]ReturnStatusStatus code
Returns
The level.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
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:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
const char * className ( )
static

Returns the name of this class.

Returns
The name of this class.
The documentation for this class was generated from the following files: