Python API 2.0 Reference
OpenMaya.MPxGeometryIterator Class Reference
+ Inheritance diagram for OpenMaya.MPxGeometryIterator:

Public Member Functions

def __init__ ()
 
def __iter__ ()
 
def __next__ ()
 
def component ()
 
def geometry ()
 
def hasNormals ()
 
def hasPoints ()
 
def index ()
 
def indexUnsimplified ()
 
def isDone ()
 
def iteratorCount ()
 
def next ()
 
def point ()
 
def reset ()
 
def setObject ()
 
def setPoint ()
 
def setPointGetNext ()
 

Static Public Member Functions

def __new__ ()
 

Properties

 currentPoint = property(...)
 
 maxPoints = property(...)
 

Detailed Description

Base class for user defined geometry iterators.

Constructor & Destructor Documentation

def OpenMaya.MPxGeometryIterator.__init__ ( )
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMaya.MPxGeometryIterator.__iter__ ( )
Implement iter(self).
def OpenMaya.MPxGeometryIterator.__new__ ( )
static
Create and return a new object.  See help(type) for accurate signature.
def OpenMaya.MPxGeometryIterator.__next__ ( )
Implement next(self).
def OpenMaya.MPxGeometryIterator.component ( )
component() -> MObject

Returns a component for the current item in the iteration.
def OpenMaya.MPxGeometryIterator.geometry ( )
geometry() -> long/object

Returns the user geometry that this iterator is iterating over.
def OpenMaya.MPxGeometryIterator.hasNormals ( )
hasNormals() -> bool

Returns whether the underlying geometry has normals.
def OpenMaya.MPxGeometryIterator.hasPoints ( )
hasPoints() -> bool

Returns whether the underlying geometry has point data.
def OpenMaya.MPxGeometryIterator.index ( )
index() -> int

Returns a unique index for the current item in the iteration.
If the iteration is over the whole geometry then this index is the same as current point. If the iteration is over some elements of the geometry specified by a component then this index is the index in your geometry.
def OpenMaya.MPxGeometryIterator.indexUnsimplified ( )
indexUnsimplified() -> int

Returns a unique index for the current item in the iteration.
Rather than being the iterator index this is the index for the actual item when simplification is skipping items. This index will be equal to index() if no simplification, otherwise it will be larger.
def OpenMaya.MPxGeometryIterator.isDone ( )
isDone() -> bool

Returns whether all the items have been traversed yet.
def OpenMaya.MPxGeometryIterator.iteratorCount ( )
iteratorCount() -> int

Returns an estimate of how many items will be iterated over.
def OpenMaya.MPxGeometryIterator.next ( )
next() -> self

Advances to the next component.
def OpenMaya.MPxGeometryIterator.point ( )
point() -> MPoint

Returns the current component's positional data.
def OpenMaya.MPxGeometryIterator.reset ( )
reset() -> self

Resets the iterator to the start of the components so that another pass over them may be made.
def OpenMaya.MPxGeometryIterator.setObject ( )
setObject(shape) -> self

Optional method to set a shape object to iterate over to allow tweaking of the shape's history (input geometry).

* shape (MPxSurfaceShape) - a user defined shape object.
def OpenMaya.MPxGeometryIterator.setPoint ( )
setPoint(point) -> self

Sets the current component's positional data.

* point (MPoint) - the new positional value to set.
def OpenMaya.MPxGeometryIterator.setPointGetNext ( )
setPointGetNext(point) -> int

Sets the current component's positional data, and returns the next index value.

* point (MPoint) - the positional value to set.

Property Documentation

OpenMaya.MPxGeometryIterator.currentPoint = property(...)
static
 The current index of the iteration.
 This value is used when iterating over all elements of your geometry, i.e. when there are no components specified.
OpenMaya.MPxGeometryIterator.maxPoints = property(...)
static
 The largest index that will be iterated over.
 This value is used when iterating over all elements of your geometry, i.e. when there are no components specified.