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

#include <MItSubdEdge.h>

List of all members.

---

Detailed Description

Subdiv edge iterator.

This class is the iterator for subdiv edges.

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

---

Constructor & Destructor Documentation

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

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

Parameters:

[in]	subdObject	The surface to iterate over
[out]	ReturnStatus	Status code

Status Codes:

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

MItSubdEdge::~MItSubdEdge

(

)

[virtual]

Destructor. Frees up storage used by the iterator.

---

Member Function Documentation

MStatus MItSubdEdge::reset

(

)

Reset the iterator to the first edge.

Returns:

Status code

Status Codes:

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

MStatus MItSubdEdge::next

(

)

Advance to the next edge in the iteration.

Returns:

Status code

Status Codes:

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

bool MItSubdEdge::isDone

(

MStatus *

ReturnStatus = NULL

)

Indicates if all of the edges 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:

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

bool MItSubdEdge::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:

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

int MItSubdEdge::level

(

MStatus *

ReturnStatus = NULL

)

const

Returns the level of the subdiv object.

Parameters:

[out]

ReturnStatus

Status code

Returns:

The level.

Status Codes:

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

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

Sets the level of the subdiv object

Parameters:

[in]	level	Level of the subdiv
[out]	ReturnStatus	Status code

Returns:

Status Codes:

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

MUint64 MItSubdEdge::index

(

MStatus *

ReturnStatus = NULL

)

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

Parameters:

[out]

ReturnStatus

Status code

Returns:

The index in the edge list for the current edge

Status Codes:

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

bool MItSubdEdge::isSharp

(

MStatus *

ReturnStatus = NULL

)

Returns true if the edge is sharp.

Parameters:

[out]

ReturnStatus

Status code

Returns:

boolean indicating whether the edge is sharp or not.

Status Codes:

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

void MItSubdEdge::setSharpness	(	bool	sharp,
		MStatus *	ReturnStatus = NULL
	)

Marks the edge as sharp.

Parameters:

[in]	sharp	Boolean to mark the edge as sharp or not
[out]	ReturnStatus	Status code

Status Codes:

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

bool MItSubdEdge::isBoundary

(

MStatus *

ReturnStatus = NULL

)

Checks if the edge is a boundary.

Parameters:

[out]

ReturnStatus

Status code

Returns:

Boolean indicating whether the edge is boundary or not.

Status Codes:

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