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

Synopsis

mlDeformer( object , [exportActive=boolean], [multiIndex=uint], [reloadModel=boolean], [vertexDeltas=string])

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

mlDeformer is undoable, NOT queryable, and NOT editable.

ML deformer utility command.

Return value

None

Flags

exportActive, multiIndex, reloadModel, vertexDeltas
Long name (short name) Argument types Properties
exportActive(exp) boolean create
Set the exportActive state of the deformer. When set to true, the deformer will grab the export settings and prepare for export and the deformer will act like a passThrough deformer. When set to false, the settings stored in trained model will be used and the deformer will act like a normal deformer.
multiIndex(mi) uint createmultiuse
Specifies the multiIndices of the deformer to be used. When this flag is not used it will default to all multiIndices on the deformer.
reloadModel(rm) boolean create
Tells the deformer that the data in the model folder path has changed and that it needs to be reloaded.
vertexDeltas(vd) string create

Get the deltas between base and target geometry. The result is a list of floats, where each group of 3 floats represents the x, y, and z components of the delta for a single vertex.

The deltas can be retrieved in different modes:

  • dbs: deltas in the surface coordinates of the base geometry
  • pos: points derived from the base surface deltas applied to the original geometry surface coordinates
  • dos: deltas on the orginal geometry from the base surface deltas applied to the original geoemtry
  • dbp: deltas to the base geometry points (not using surface coordinates)
  • dop: deltas to the original geometry points (not using surface coordinates)
  • auto: finds the best mode for each multiIndex depending on its export settings
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

# Reload model 0 on the mlDeformer1 node.
cmds.mlDeformer("mlDeformer1", multiIndex=0, reloadModel=True)

# Reload all models on the mlDeformer1 node.
cmds.mlDeformer("mlDeformer1", reloadModel=True)

# Get the surface vertex deltas for index 0 on the mlDeformer1 node.
cmds.mlDeformer("mlDeformer1", multiIndex=0, vertexDeltas="dbs")