pymel.core.animation.deltaMush — PyMEL 1.0.7 documentation

pymel.core.animation.deltaMush

deltaMush(*args, **kwargs)

This command is used to create, edit and query deltaMush nodes.

Flags:

Long Name / Short Name Argument Types Properties
after / af bool ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 the -after mode is used when adding the new deformer, otherwise the -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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/query.gif
 
Returns the name of the deformer tool objects (if any) as string string ...
envelope / en float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Envelope of the delta mush node. The envelope determines the percent of deformation. Value is clamped between to [0, 1] range. Defaults to 1.
exclusive / ex unicode ../../../_images/create.gif ../../../_images/query.gif
 
Puts the deformation set in a deform partition.
frontOfChain / foc bool ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/query.gif
 
Complements the -geometry flag in query mode. Returns the multi index of each geometry.
ignoreSelected / ignoreSelected bool ../../../_images/create.gif
 
Tells the command to not deform objects on the current selection list
includeHiddenSelections / ihs bool ../../../_images/create.gif
 
Apply the deformer to any visible and hidden objects in the selection list. Default is false.
name / n unicode ../../../_images/create.gif
 
Used to specify the name of the node being created
parallel / par bool ../../../_images/create.gif ../../../_images/edit.gif
 

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

pinBorderVertices / pbv bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

If enabled, vertices on mesh borders will be pinned to their current position during smoothing. Defaults to true. Flag can have multiple arguments, passed either as a tuple or a list.

prune / pr bool ../../../_images/edit.gif
 
Removes any points not being deformed by the deformer in its current configuration from the deformer set.
remove / rm bool ../../../_images/edit.gif
 
Specifies that objects listed after the -g flag should be removed from this deformer.
smoothingIterations / si int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Number of smoothing iterations performed by the delta mush node. Defaults to 10.
smoothingStep / ss float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Step amount used per smoothing iteration. Value is clamped between [0, 1] range. A higher value may lead to instabilities but converges faster compared to a lower value. Defaults to 0.5.

split / sp bool ../../../_images/create.gif ../../../_images/edit.gif
 

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

Derived from mel command maya.cmds.deltaMush