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

#include <MItSubdVertex.h>

List of all members.

---

Detailed Description

Subdiv vertex iterator.

This class is the iterator for subdiv vertices.

Public Member Functions
	MItSubdVertex (MObject &subdObject, MStatus *ReturnStatus=NULL)
virtual	~MItSubdVertex ()
bool	isDone (MStatus *ReturnStatus=NULL)
MStatus	next ()
MStatus	reset ()
int	level (MStatus *ReturnStatus=NULL) const
void	setLevel (int level, MStatus *ReturnStatus=NULL)
bool	isValid (MStatus *ReturnStatus=NULL) const
MUint64	index (MStatus *ReturnStatus=NULL)

---

Constructor & Destructor Documentation

MItSubdVertex::MItSubdVertex	(	MObject &	subdObject,
		MStatus *	ReturnStatus = NULL
	)

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

Arguments

• subdObject The subd surface to iterate over
• ReturnStatus Status code

Status Codes

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

MItSubdVertex::~MItSubdVertex

(

)

[virtual]

Destructor. Frees up storage used by the iterator.

---

Member Function Documentation

bool MItSubdVertex::isDone

(

MStatus *

ReturnStatus = NULL

)

Indicates if all of the vertices have been traversed yet.

Arguments

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

MStatus MItSubdVertex::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 MItSubdVertex::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 MItSubdVertex::level

(

MStatus *

ReturnStatus = NULL

)

const

Returns the level of the subdiv object.

Arguments

• ReturnStatus Status code

Returns:

The level.

Status Codes

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

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

Sets the level of the subdiv object

Arguments

• level Level of the subdiv
• ReturnStatus Status code

Returns:

Status Codes

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

bool MItSubdVertex::isValid

(

MStatus *

ReturnStatus = NULL

)

const

Checks if the iterator is valid.

Arguments

• ReturnStatus Status 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 MItSubdVertex::index

(

MStatus *

ReturnStatus = NULL

)

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

Arguments

• ReturnStatus Status 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.