OpenMayaAnim.MFnGeometryFilter Class Reference

Inheritance diagram for OpenMayaAnim.MFnGeometryFilter:

Public Member Functions
def	__init__ ()
def	getComponentAtIndex ()
def	getInputGeometry ()
def	getOutputGeometry ()
def	getPathAtIndex ()
def	groupIdAtIndex ()
def	indexForGroupId ()
def	indexForOutputConnection ()
def	indexForOutputShape ()
def	inputShapeAtIndex ()
def	numOutputConnections ()
def	outputShapeAtIndex ()
Public Member Functions inherited from OpenMaya.MFnDependencyNode
def	__init__ ()
def	absoluteName ()
def	addAttribute ()
def	addExternalContentForFileAttr ()
def	affectsAnimation ()
def	attribute ()
def	attributeClass ()
def	attributeCount ()
def	canBeWritten ()
def	create ()
def	dgCallbackIds ()
def	dgCallbacks ()
def	dgTimer ()
def	dgTimerOff ()
def	dgTimerOn ()
def	dgTimerQueryState ()
def	dgTimerReset ()
def	findAlias ()
def	findPlug ()
def	getAffectedAttributes ()
def	getAffectingAttributes ()
def	getAliasAttr ()
def	getAliasList ()
def	getConnections ()
def	getExternalContent ()
def	hasAttribute ()
def	hasUniqueName ()
def	isFlagSet ()
def	isNewAttribute ()
def	isTrackingEdits ()
def	name ()
def	plugsAlias ()
def	removeAttribute ()
def	reorderedAttribute ()
def	setAffectsAnimation ()
def	setAlias ()
def	setDoNotWrite ()
def	setExternalContent ()
def	setExternalContentForFileAttr ()
def	setFlag ()
def	setName ()
def	setUuid ()
def	uniqueName ()
def	userNode ()
def	uuid ()
Public Member Functions inherited from OpenMaya.MFnBase
def	__init__ ()
def	hasObj ()
def	object ()
def	setObject ()
def	type ()

Static Public Member Functions
def	__new__ ()
Static Public Member Functions inherited from OpenMaya.MFnDependencyNode
def	__new__ ()
def	allocateFlag ()
def	classification ()
def	deallocateAllFlags ()
def	deallocateFlag ()
Static Public Member Functions inherited from OpenMaya.MFnBase
def	__new__ ()

Properties
	deformerSet = property(...)
	envelope = property(...)
Properties inherited from OpenMaya.MFnDependencyNode
	isDefaultNode = property(...)
	isFromReferencedFile = property(...)
	isLocked = property(...)
	isShared = property(...)
	namespace = property(...)
	pluginName = property(...)
	typeId = property(...)
	typeName = property(...)

Additional Inherited Members
Static Public Attributes inherited from OpenMaya.MFnDependencyNode
int	kTimerMetrics = 9
int	kTimerTypes = 3
int	kExtensionAttr = 3
int	kInvalidAttr = 4
int	kLocalDynamicAttr = 1
int	kNormalAttr = 2
int	kTimerInvalidState = 3
int	kTimerOff = 0
int	kTimerOn = 1
int	kTimerUninitialized = 2
int	kTimerMetric_callback = 0
int	kTimerMetric_callbackNotViaAPI = 6
int	kTimerMetric_callbackViaAPI = 5
int	kTimerMetric_compute = 1
int	kTimerMetric_computeDuringCallback = 7
int	kTimerMetric_computeNotDuringCallback = 8
int	kTimerMetric_dirty = 2
int	kTimerMetric_draw = 3
int	kTimerMetric_fetch = 4
int	kTimerType_count = 2
int	kTimerType_inclusive = 1
int	kTimerType_self = 0

Detailed Description

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
-   builtins.object

Constructor & Destructor Documentation

def OpenMayaAnim.MFnGeometryFilter.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaAnim.MFnGeometryFilter.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def OpenMayaAnim.MFnGeometryFilter.getComponentAtIndex

(

)

getComponentAtIndex(index) -> MObject

Returns the component which contains the members of the deformer
at the given index.

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

def OpenMayaAnim.MFnGeometryFilter.getOutputGeometry

(

)

getOutputGeometry() -> MObjectArray

Returns the DAG nodes which receive output geometry from the deformer.

def OpenMayaAnim.MFnGeometryFilter.getPathAtIndex

(

)

getPathAtIndex(plugIndex) -> MDagPath

Returns the DAG path of the specified output geometry.

* plugIndex (unsigned int) - Plug index of the desired geometry.

def OpenMayaAnim.MFnGeometryFilter.groupIdAtIndex

(

)

groupIdAtIndex(plugIndex) -> long

Returns the groupId associated with the specified geometry.

* plugIndex (unsigned int) - Plug index of the desired geometry.

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

def OpenMayaAnim.MFnGeometryFilter.indexForOutputConnection

(

)

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.

def OpenMayaAnim.MFnGeometryFilter.indexForOutputShape

(

)

indexForOutputShape(shape) -> plugIndex

Returns the plug index for the specified output shape.

* shape (MObject) - Shape for which the plug index is requested.

def OpenMayaAnim.MFnGeometryFilter.inputShapeAtIndex

(

)

inputShapeAtIndex(plugIndex) -> MObject

Returns the input shape corresponding to the plug index.

* plugIndex (unsigned int) - Plug index of the desired shape.

def OpenMayaAnim.MFnGeometryFilter.numOutputConnections

(

)

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.

def 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 = property(...)

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 = property(...)

static

 A global scale factor that is applied to all the values.