OpenMaya.MPxGeometryIterator Class Reference

OpenMaya.MPxGeometryIterator Class Reference
+ Related help topics:

Class Description

Base class for user defined geometry iterators.
+ Inheritance diagram for OpenMaya.MPxGeometryIterator:

Public Member Functions

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

Properties

 currentPoint
 
 maxPoints
 

Constructor & Destructor Documentation

OpenMaya.MPxGeometryIterator.__init__ ( )
x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMaya.MPxGeometryIterator.component ( )
component() -> MObject

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

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

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

Returns whether the underlying geometry has point data.
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.
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.
OpenMaya.MPxGeometryIterator.isDone ( )
isDone() -> bool

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

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

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

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

Resets the iterator to the start of the components so that another pass over them may be made.
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.
OpenMaya.MPxGeometryIterator.setPoint ( )
setPoint(point) -> self

Sets the current component's positional data.

* point (MPoint) - the new positional value to set.
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
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
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.