pymel.core.animation.deformer

deformer(*args, **kwargs)

This command creates a deformer of the specified type. The deformer will deform the selected objects.

Flags:

Long name (short name)		Argument Types	Properties
after (af)		bool
	If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
afterReference (ar)		bool
	The -afterReference flag is used to specify deformer ordering in a hybrid way that choses between -before and -after automatically. If the geometry being deformed is referenced then -after mode is used in adding the new deformer otherwise -before mode is used. The net effect when using -afterReference to build deformer chains is that internal shape nodes in the deformer chain will only appear at reference file boundaries, leading to lightweight deformer networks that may be more amicable to reference swapping.
before (bf)		bool
	If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
deformerTools (dt)		bool
	Returns the name of the deformer tool objects (if any) as string string ...
exclusive (ex)		unicode
	Puts the deformation set in a deform partition.
frontOfChain (foc)		bool
	This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and skin nodes in the shape’s history (but not ahead of existing tweak nodes). The input to the deformer will be the upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and edit mode if the deformer has no geometry added yet).
geometry (g)		unicode
	The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is also specified. When queried, this flag returns string string string ...
geometryIndices (gi)		bool
	Complements the -geometry flag in query mode. Returns the multi index of each geometry.
ignoreSelected (ignoreSelected)		bool
	Tells the command to not deform objects on the current selection list
name (n)		unicode
	Used to specify the name of the node being created
parallel (par)		bool
	Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry added yet).
prune (pr)		bool
	Removes any points not being deformed by the deformer in its current configuration from the deformer set.
remove (rm)		bool
	Specifies that objects listed after the -g flag should be removed from this deformer.
split (sp)		bool
	Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
type (typ)		unicode
	Specify the type of deformer to create. This flag is required in create mode. Typically the type should specify a loaded plugin deformer. This command should typically not be used to create one of the standard deformers such as sculpt, lattice, blendShape, wire and cluster, since they have their own customized commands which perform useful specialized functionality.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.deformer

Example:

import pymel.core as pm

import maya.cmds as cmds

# To create a plugin of type "squash" on the selected object.
# First, load the plugin. The deformer command will not autoload
# your plugin. Then, select the geometries that you'd like to deform,
# and use the deformer command as follows. For example, to deform a
# cylinder with a squash:
#
pm.cylinder( ax=(0, 1, 0), r=1, hr=10, d=3, s=8, nsp=20, ch=1 )
# Result: [nt.Transform(u'nurbsCylinder1'), nt.MakeNurbCylinder(u'makeNurbCylinder1')] #
pm.select( 'nurbsCylinder1', r=True )
pm.deformer( type="squash" )

# To query the membership of the deformer
#
pm.deformer( 'squash1',q=True, g=True )

# To add additional geometries from your deformer, type:
#
pm.select( 'nurbsCylinder1', r=True )
pm.duplicate()
nurbsCylinder2
pm.move( -2.749017, 0, 0, r=True )
pm.deformer( 'squash1', e=True, g='nurbsCylinder2' )

# To remove a geometry from your deformer, type:
#
pm.deformer( 'squash1', e=True, rm=True, g='nurbsCylinder2' )