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

Subdiv edge iterator. More...

#include <MItSubdEdge.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Subdiv edge iterator.

This class is the iterator for subdiv edges.

Constructor & Destructor Documentation

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