Public Member Functions | Static Public Member Functions

MItSubdEdge Class Reference

Search for all occurrences

Detailed Description

Subdiv edge iterator.

This class is the iterator for subdiv edges.

#include <MItSubdEdge.h>

List of all members.

Public Member Functions

 MItSubdEdge (MObject &subdObject, MStatus *ReturnStatus=NULL)
 Constructor.
virtual ~MItSubdEdge ()
 Destructor.
MStatus reset ()
 Reset the iterator to the first edge.
MStatus next ()
 Advance to the next edge in the iteration.
bool isDone (MStatus *ReturnStatus=NULL)
 Indicates if all of the edges have been traversed yet.
bool isValid (MStatus *ReturnStatus=NULL) const
 Checks if the iterator is valid.
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.
MUint64 index (MStatus *ReturnStatus=NULL)
 Returns the index of the current edge in the edge list for this subdiv object.
bool isSharp (MStatus *ReturnStatus=NULL)
 Returns true if the edge is sharp.
void setSharpness (bool sharp, MStatus *ReturnStatus=NULL)
 Marks the edge as sharp.
bool isBoundary (MStatus *ReturnStatus=NULL)
 Checks if the edge is a boundary.

Static Public Member Functions

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

Constructor & Destructor Documentation

MItSubdEdge ( MObject subdObject,
MStatus ReturnStatus = NULL 
)

Constructor.

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

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

Destructor.

Frees up storage used by the iterator.


Member Function Documentation

MStatus reset ( )

Reset the iterator to the first edge.

Returns:
Status code
Status Codes:
MStatus next ( )

Advance to the next edge in the iteration.

Returns:
Status code
Status Codes:
bool isDone ( MStatus ReturnStatus = NULL)

Indicates if all of the edges 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:
bool isValid ( MStatus ReturnStatus = NULL) const

Checks if the iterator is valid.

Parameters:
[out]ReturnStatusStatus code
Returns:
bool Boolean to indicate whether the iterator is valid or not.
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
Returns:
Status Codes:
MUint64 index ( MStatus ReturnStatus = NULL)

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

Parameters:
[out]ReturnStatusStatus code
Returns:
The index in the edge list for the current edge
Status Codes:
bool isSharp ( MStatus ReturnStatus = NULL)

Returns true if the edge is sharp.

Parameters:
[out]ReturnStatusStatus code
Returns:
boolean indicating whether the edge is sharp or not.
Status Codes:
void setSharpness ( bool  sharp,
MStatus ReturnStatus = NULL 
)

Marks the edge as sharp.

Parameters:
[in]sharpBoolean to mark the edge as sharp or not
[out]ReturnStatusStatus code
Status Codes:
bool isBoundary ( MStatus ReturnStatus = NULL)

Checks if the edge is a boundary.

Parameters:
[out]ReturnStatusStatus code
Returns:
Boolean indicating whether the edge is boundary or not.
Status Codes:
const char * className ( ) [static]

Returns the name of this class.

Returns:
The name of this class.

MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge
MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge MItSubdEdge