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

Synopsis

latticeDeformKeyCtx [-envelope float] [-exists] [-history boolean] [-image1 string] [-image2 string] [-image3 string] [-latticeColumns uint] [-latticeRows uint] [-name string] [-scaleLatticePts boolean] contextName

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.

Return value

stringContext name

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

Flags

envelope, exists, history, image1, image2, image3, latticeColumns, latticeRows, name, scaleLatticePts
Long name (short name) Argument types Properties
-envelope(-ev) float queryedit
Specifies the influence of the lattice.
-exists(-ex) create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
-history(-ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
-image1(-i1) string createqueryedit
First of three possible icons representing the tool associated with the context.
-image2(-i2) string createqueryedit
Second of three possible icons representing the tool associated with the context.
-image3(-i3) string createqueryedit
Third of three possible icons representing the tool associated with the context.
-latticeColumns(-lc) uint queryedit
Specifies the number column points the lattice contains.
-latticeRows(-lr) uint queryedit
Specifies the number of rows the lattice contains.
-name(-n) string create
If this is a tool command, name the tool appropriately.
-scaleLatticePts(-slp) boolean queryedit
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 be used more than once in a command.

MEL examples

// Create a lattice manipulator with 4 x 4 lattice.
//
latticeDeformKeyCtx -latticeColumns 4 -latticeRows 4 latticeContex;