Python API 2.0 Reference: OpenMaya.MItMeshEdge Class Reference

+ Inheritance diagram for OpenMaya.MItMeshEdge:

Public Member Functions

__init__ ()
 
__iter__ ()
 
center ()
 
connectedToEdge ()
 
connectedToFace ()
 
count ()
 
currentItem ()
 
geomChanged ()
 
getConnectedEdges ()
 
getConnectedFaces ()
 
index ()
 
isDone ()
 
iter ()
 
iternext ()
 
length ()
 
next ()
 
numConnectedEdges ()
 
numConnectedFaces ()
 
onBoundary ()
 
point ()
 
reset ()
 
setIndex ()
 
setPoint ()
 
updateSurface ()
 
vertexId ()
 

Properties

 isSmooth
 

Detailed Description

An iterator for traversing a mesh's edges.

Constructor & Destructor Documentation

OpenMaya.MItMeshEdge.__init__ ( )
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Member Function Documentation

OpenMaya.MItMeshEdge.__iter__ ( )
x.__iter__() <==> iter(x)
OpenMaya.MItMeshEdge.center ( )
center(space=kObject) -> MPoint

Returns the center point of the edge, in the given transformation space.

* space (MSpace constant) - The  transformation space
OpenMaya.MItMeshEdge.connectedToEdge ( )
connectedToEdge(index) -> bool

Determines whether the given edge is connected to the current edge.

* index (int) - Index of edge to check.
OpenMaya.MItMeshEdge.connectedToFace ( )
connectedToFace(index) -> bool

Determines whether the given face contains the current edge.

* index (int) - Index of face to check.
OpenMaya.MItMeshEdge.count ( )
count() -> int

Return the number of edges in the iteration
OpenMaya.MItMeshEdge.currentItem ( )
currentItem() -> MObject

Returns the current edge in the iteration as a component.

Components are used to specify one or more edges and are useful in operating on groups of non-contiguous edges for a surface.
Components do not contain any information about the surface that they refer to so an MDagPath must be specified when dealing with components.
OpenMaya.MItMeshEdge.geomChanged ( )
geomChanged() -> self

Resets the geom pointer in the MItMeshEdge. If you're using MFnMesh to
update Normals or Color per vertex while iterating, you must call geomChanged
on the iterator immediately after the MFnMesh call to make sure that your
geometry is up to date. A crash may result if this method is not called.
A similar approach must be taken for updating upstream vertex tweaks
with an MPlug. After the update, call this method.
OpenMaya.MItMeshEdge.getConnectedEdges ( )
getConnectedEdges() -> MIntArray

Returns the indices of edges connected to the current edge.
OpenMaya.MItMeshEdge.getConnectedFaces ( )
getConnectedFaces() -> MIntArray

Returns the indices of the faces connected to the current edge.
Normally a boundary edge will only have one face connected to it and
an internal edge will have two, but if the mesh has manifold geometry
then the edge may have three or more faces connected to it.
OpenMaya.MItMeshEdge.index ( )
index() -> int

Returns the index of the current edge in the iteration.
OpenMaya.MItMeshEdge.isDone ( )
isDone() -> bool

Indicates if all of the edges have been traversed yet.
OpenMaya.MItMeshEdge.iter ( )
iter() -> self

Initializes the iterator object for pythonic iteration.
OpenMaya.MItMeshEdge.iternext ( )
iternext() -> self

Used in pythonic iteration to move the iterator
OpenMaya.MItMeshEdge.length ( )
length(space=kObject) -> float

Returns the length of the edge, in the given transformation space.

* space (MSpace constant) - The  transformation space
OpenMaya.MItMeshEdge.next ( )
x.next() -> the next value, or raise StopIteration
OpenMaya.MItMeshEdge.numConnectedEdges ( )
numConnectedEdges() -> int

Returns the number of edges connected to the current edge.
OpenMaya.MItMeshEdge.numConnectedFaces ( )
numConnectedFaces() -> int

Returns the number of faces connected to the current edge.
OpenMaya.MItMeshEdge.onBoundary ( )
onBoundary() -> bool

Determines if the current edge is a border edge.
OpenMaya.MItMeshEdge.point ( )
point(whichVertex, space=kObject) -> MPoint

Returns the position of one of the current edge's vertices, int the
given transformation space.

* whichVertex    (0 or 1) - Which of the edge's two vertices to return
* space (MSpace constant) - The transformation space
OpenMaya.MItMeshEdge.reset ( )
reset() -> self
reset(mesh) -> self
reset(mesh, component=None) -> self

Reset the iterator to the first edge of the mesh.

Reset the iterator to the first edge of the specified mesh

* mesh (MObject) - The polygon for the iteration

Reset the iterator with the given mesh and component.
If component is None then the iteration will be for all edges in the mesh.

* mesh (MDagPath) - The mesh to iterate over
* component (MObject) - The edges of the mesh to iterate over
OpenMaya.MItMeshEdge.setIndex ( )
setIndex(index) -> int

Sets the index of the current edge to be accessed. The current edge
will no longer be in sync with any previous iteration.

Returns the index of the edge which was current before the change.


* index (int) - The index of desired edge to access.
OpenMaya.MItMeshEdge.setPoint ( )
setPoint(point, whichVertex, space=kObject) -> self

Sets the position of one of the current edge's vertices, in the given
transformation space.

* point       (MPoint) - The new position for the specified vertex
* whichVertex (0 or 1) - Which of the edge's 2 vertices to set.
* space (MSpace constant) - The transformation space
OpenMaya.MItMeshEdge.updateSurface ( )
updateSurface() -> self

Tells Maya that mesh has been changed and needs to redraw itself.
OpenMaya.MItMeshEdge.vertexId ( )
vertexId(whichVertex) -> int

Returns the global index (as opposed to face-relative index) of one of
the edge's vertices.

* whichVertex (0 or 1) - Which of the edge's 2 vertices to use.

Property Documentation

OpenMaya.MItMeshEdge.isSmooth
static
 True if the edge is smooth, False if it is hard.