pymel.core.nodetypes.GeometryFilter¶
digraph inheritance197b610f7f { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "DependNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DependNode.html#pymel.core.nodetypes.DependNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" -> "DependNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "GeometryFilter" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.GeometryFilter",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DependNode" -> "GeometryFilter" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProxyUnicode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.util.utilitytypes/pymel.util.utilitytypes.ProxyUnicode.html#pymel.util.utilitytypes.ProxyUnicode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.core.general/pymel.core.general.PyNode.html#pymel.core.general.PyNode",style="setlinewidth(0.5)",tooltip="Abstract class that is base for all pymel nodes classes.",height=0.25,shape=box,fontsize=8]; "ProxyUnicode" -> "PyNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
- class GeometryFilter(*args, **kwargs)¶
- deformerSet()¶
Returns the 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.
Return type: PyNode Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.deformerSet
- getEnvelope()¶
Returns the envelope value.
Return type: float Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.envelope
- getInputGeometry()¶
This method returns the input geometry for the deformer 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.
Return type: PyNode list Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.getInputGeometry
- getOutputGeometry()¶
The output geometry is packed into the provided list of MObjects. Each of the MObjects will be a DAG node.
Return type: PyNode list Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.getOutputGeometry
- getPathAtIndex(index)¶
The DAG path of the output geometry at the specified plug index is put in the dagPath argument.
Parameters: - index : int
the plug index
Return type: PyNode
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.getPathAtIndex
- groupIdAtIndex(index)¶
Returns the groupId at the specified plug index.
Parameters: - index : int
the plug index for which the groupId is requested
Return type: int
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.groupIdAtIndex
- indexForGroupId(groupId)¶
Returns the plug index corresponding to the groupId.
Parameters: - groupId : int
the groupId for the plug index
Return type: int
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.indexForGroupId
- indexForOutputConnection(connectionIndex)¶
Returns the plug index corresponding to the connection index. The connection index is the index specifying the nth output connection. The plug index (logical index) is the sparse array index used by many of MFnGeometryFilter’s methods and in MEL scripts. The connection index is 0-based, hence, the maximum value of the connection index is numOutputs - 1.
Parameters: - connectionIndex : int
the connection index
Return type: int
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.indexForOutputConnection
- indexForOutputShape(shape)¶
Returns the plug index for the specified output shape.
Parameters: - shape : PyNode
the shape for which the plug index is requested
Return type: int
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.indexForOutputShape
- inputShapeAtIndex(index)¶
Returns the input shape corresponding to the plug index.
Parameters: - index : int
the plug index for the input shape
Return type: PyNode
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.inputShapeAtIndex
- numOutputConnections()¶
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.
Return type: int Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.numOutputConnections
- outputShapeAtIndex(index)¶
Returns the output shape corresponding to the plug index
Parameters: - index : int
the plug index for the output shape
Return type: PyNode
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.outputShapeAtIndex
- setEnvelope(envelope)¶
Sets the envelope value.
Parameters: - envelope : float
envelope value
Derived from api method maya.OpenMayaAnim.MFnGeometryFilter.setEnvelope