class MItSubdEdge

Jump to documentation

public members:

	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 )

Documentation

Description

This class is the iterator for subdiv edges.

Functions

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

Description

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

Arguments

• subdObject The surface to iterate over
• ReturnStatus Status code

Status Codes

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

MItSubdEdge:: ~MItSubdEdge ()

Description

Destructor. Frees up storage used by the iterator.

MStatus MItSubdEdge:: reset ()

Description

Reset the iterator to the first edge.

Return Value

• Status code

Status Codes

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

MStatus MItSubdEdge:: next ()

Description

Advance to the next edge in the iteration.

Return Value

• Status code

Status Codes

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

bool MItSubdEdge:: isDone ( MStatus * ReturnStatus )

Description

Indicates if all of the edges have been traversed yet.

Arguments

• ReturnStatus Status code

Return Value

• 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) const

Description

Checks if the iterator is valid.

Arguments

• ReturnStatus Status code

Return Value

• 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 ) const

Description

Returns the level of the subdiv object.

Arguments

• ReturnStatus Status code

Return Value

• The level.

Status Codes

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

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

Description

Sets the level of the subdiv object

Arguments

• level Level of the subdiv
• ReturnStatus Status code

Return Value

Status Codes

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

MUint64 MItSubdEdge:: index ( MStatus * ReturnStatus )

Description

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

Arguments

• ReturnStatus Status code

Return Value

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

Description

Returns true if the edge is sharp.

Arguments

• ReturnStatus Status code

Return Value

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

Description

Marks the edge as sharp.

Arguments

• sharp Boolean to mark the edge as sharp or not
• ReturnStatus Status code

Return Value

Status Codes

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

bool MItSubdEdge:: isBoundary ( MStatus * ReturnStatus )

Description

Checks if the edge is a boundary.

Arguments

• ReturnStatus Status code

Return Value

• Boolean indicating whether the edge is boundary or not.

Status Codes

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

This class has no child classes.