class MItSubdVertex

Jump to documentation

public members:

	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 )

Documentation

Description

This class is the iterator for subdiv vertices.

Functions

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

Description

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

Description

Destructor. Frees up storage used by the iterator.

bool MItSubdVertex:: isDone ( MStatus * ReturnStatus )

Description

Indicates if all of the vertices 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.

MStatus MItSubdVertex:: next ()

Description

Advance to the next vertex in the iteration.

Return Value

• Status code

Status Codes

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

MStatus MItSubdVertex:: reset ()

Description

Reset the iterator to the first vertex.

Return Value

• Status code

Status Codes

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

MUint64 MItSubdVertex:: index ( MStatus * ReturnStatus )

Description

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

Arguments

• ReturnStatus Status code

Return Value

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

int MItSubdVertex:: 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 MItSubdVertex:: 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.

bool MItSubdVertex:: 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.

This class has no child classes.