Function set for operating on geometryFilter nodes.
geometryFilter is the abstract node type from which all
deformer node types derive.
__init__()
Initializes a new, empty MFnGeometryFilter functionset.
__init__(MObject)
Initializes a new MFnGeometryFilter functionset and attaches it
to a geometryFilter node.
Method resolution order:
- MFnGeometryFilter
- OpenMaya.MFnDependencyNode
- OpenMaya.MFnBase
- __builtin__.object
Constructor & Destructor Documentation
OpenMayaAnim.MFnGeometryFilter.__init__
(
)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Member Function Documentation
OpenMayaAnim.MFnGeometryFilter.getInputGeometry
(
)
getInputGeometry() -> MObjectArray
Returns the DAG nodes which provide input geometry to the deformer.
These are found by traversing the graph to find upstream shape nodes.
It is possible for there to be nodes in between the shape and the
deformer so that the returned shape may have a different topology or
tweaks then the input data to the deformer. If the actual input
geometry data for the deformer is required, this information can be
accessed by using MPlug::getValue() to query the inputGeometry
attribute on the deformer.
OpenMayaAnim.MFnGeometryFilter.getOutputGeometry
(
)
getOutputGeometry() -> MObjectArray
Returns the DAG nodes which receive output geometry from the deformer.
OpenMayaAnim.MFnGeometryFilter.getPathAtIndex
(
)
getPathAtIndex(plugIndex) -> MDagPath
Returns the DAG path of the specified output geometry.
* plugIndex (unsigned int) - Plug index of the desired geometry.
OpenMayaAnim.MFnGeometryFilter.groupIdAtIndex
(
)
groupIdAtIndex(plugIndex) -> long
Returns the groupId associated with the specified geometry.
* plugIndex (unsigned int) - Plug index of the desired geometry.
OpenMayaAnim.MFnGeometryFilter.indexForGroupId
(
)
indexForGroupId(groupId) -> plugIndex
Returns the plug index of the geometry associated with the specified groupId.
* groupId (unsigned int) - groupId of the desired geometry.
indexForOutputConnection(connIndex) -> plugIndex
Returns the plug index corresponding to a connection index. The
connection index is the contiguous (physical) index of the output
connection, ranging from 0 to numOutputConnections()-1. The plug
index is the sparse (logical) index of the connection.
* connIndex (unsigned int) - Connection index of the desired geometry.
indexForOutputShape(shape) -> plugIndex
Returns the plug index for the specified output shape.
* shape (MObject) - Shape for which the plug index is requested.
OpenMayaAnim.MFnGeometryFilter.inputShapeAtIndex
(
)
inputShapeAtIndex(plugIndex) -> MObject
Returns the input shape corresponding to the plug index.
* plugIndex (unsigned int) - Plug index of the desired shape.
numOutputConnections() -> long
Returns the number of output geometries connected to this node. This
is typically equal to the number of input geometries unless an input
or output geometry has been deleted, or a connection to an input or
output geometry has been broken.
This method is useful in conjunction with indexForOutputConnection()
to iterate through the affected objects.
OpenMayaAnim.MFnGeometryFilter.outputShapeAtIndex
(
)
outputShapeAtIndex(index) -> MObject
Returns the DAG path to which this function set is attached, or the first path to the node if the function set is attached to an MObject.
Property Documentation
OpenMayaAnim.MFnGeometryFilter.deformerSet
static
Object set containing the objects that are deformed. Adding new
components to the deformer set will cause them to be deformed.
Removing components from the deformer set will prevent them from
being influenced by the deformer.
Note that the wrap deformer and the skinCluster deformers are
special cases: they allow only a single object to be deformed per
wrap/skinCluster, so adding additional geometries to them will have
no effect.
OpenMayaAnim.MFnGeometryFilter.envelope
static
A global scale factor that is applied to all the values.