deltaMush

Go to: Synopsis. Return value. Related. Flags. Python examples.

Synopsis

deltaMush( selectionList , [after=boolean], [afterReference=boolean], [before=boolean], [components=boolean], [deformerTools=boolean], [envelope=float], [exclusive=string], [frontOfChain=boolean], [geometry=string], [geometryIndices=boolean], [ignoreSelected=boolean], [includeHiddenSelections=boolean], [inwardConstraint=float], [name=string], [outwardConstraint=float], [parallel=boolean], [pinBorderVertices=boolean], [prune=boolean], [remove=boolean], [selectedComponents=boolean], [smoothingIterations=uint], [smoothingStep=float], [split=boolean], [useComponentTags=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

deltaMush is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Related

Flags

Long name (short name)	Argument types	Properties
after(af)	boolean
If the default behavior for insertion/appending into/onto the existing chain is not the desired behavior then this flag can be used to force the command to place 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)	boolean
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)	boolean
If the default behavior for insertion/appending into/onto the existing chain is not the desired behavior then this flag can be used to force the command to place 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).
components(cmp)	boolean
Returns the components used by the deformer
deformerTools(dt)	boolean
Returns the name of the deformer tool objects (if any) as string string ...
envelope(en)	float
Envelope of the delta mush node. The envelope determines the percent of deformation. Value is clamped to [0, 1] range. Default is 1.
exclusive(ex)	string
Puts the deformation set in a deform partition.
frontOfChain(foc)	boolean
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)	string
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)	boolean
Complements the -geometry flag in query mode. Returns the multi index of each geometry.
ignoreSelected(ignoreSelected)	boolean
Tells the command to not deform objects on the current selection list
includeHiddenSelections(ihs)	boolean
Apply the deformer to any visible and hidden objects in the selection list. Default is false.
inwardConstraint(iwc)	float
Constrains the movement of the vertex to not move inward from the input deforming shape to preserve the contour. Value is in the [0,1] range. Default is 0.0.
name(n)	string
Used to specify the name of the node being created.
outwardConstraint(owc)	float
Constrains the movement of the vertex to not move outward from the input deforming shape to preserve the contour. Value is in the [0,1] range. Default is 0.0.
parallel(par)	boolean
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)	boolean
If enabled, vertices on mesh borders will be pinned to their current position during smoothing. Default is true.
prune(pr)	boolean
Removes any points not being deformed by the deformer in its current configuration from the deformer set.
remove(rm)	boolean
Specifies that objects listed after the -g flag should be removed from this deformer.
selectedComponents(cms)	boolean
Returns the components used by the deformer that are currently selected. This intersects the current selection with the components affected by the deformer.
smoothingIterations(si)	uint
Number of smoothing iterations performed by the delta mush node. Default is 10.
smoothingStep(ss)	float
Step amount used per smoothing iteration. Value is clamped to [0, 1] range. A higher value may lead to instabilities but converges faster compared to a lower value. Default is 0.5.
split(sp)	boolean
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).
useComponentTags(uct)	boolean
When this flag is specified a setup using componentTags will be created. This means no groupId, groupParts, tweak or objectSet nodes will be created and connected to the new deformer.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

import maya.cmds as cmds

# Create a poly sphere
cmds.polySphere()

# Attach a deltaMush deformer to the sphere performing
# 20 smoothing iterations with a step of 0.8
cmds.deltaMush( smoothingIterations=20, smoothingStep=0.8 )