Go to: Synopsis. Return value. Flags. Python examples.
latticeDeformKeyCtx( contextName , [envelope=float], [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [latticeColumns=uint], [latticeRows=uint], [name=string], [scaleLatticePts=boolean])
Note: Strings representing object names and
arguments must be separated by commas. This is not depicted in the
synopsis.
latticeDeformKeyCtx is undoable, queryable, and editable.
This command creates a context which may be used to deform key
frames with lattice manipulator. This context only works in the
graph editor.
In query mode, return type is based on queried flag.
envelope, exists, history,
image1, image2,
image3, latticeColumns, latticeRows, name,
scaleLatticePts
Long name (short name) |
Argument types |
Properties |
exists(ex) |
boolean |
 |
|
Returns true or false depending upon whether the specified
object exists. Other flags are ignored. |
|
image1(i1) |
string |
   |
|
image2(i2) |
string |
   |
|
image3(i3) |
string |
   |
|
Contexts support up to three icons that represent the tool
associated with the context. |
|
history(ch) |
boolean |
 |
|
If this is a tool command, turn the construction history on for
the tool in question. |
|
name(n) |
string |
 |
|
If this is a tool command, name the tool appropriately. |
|
latticeColumns(lc) |
uint |
  |
|
Specifies the number column points the lattice contains. |
|
latticeRows(lr) |
uint |
  |
|
Specifies the number of rows the lattice contains. |
|
envelope(ev) |
float |
  |
|
Specifies the influence of the lattice. |
|
scaleLatticePts(slp) |
boolean |
  |
|
Specifies if the selected lattice points should scale around
the pick point. If this value is false the the default operation is
'move' |
|
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. |
import maya.cmds as cmds
# Create a lattice manipulator with 4 x 4 lattice.
#
cmds.latticeDeformKeyCtx( 'latticeContex', latticeColumns=4, latticeRows=4 )