Go to: Synopsis. Return value. Flags. Python examples.
texLatticeDeformContext(
contextName
, [envelope=float], [exists=boolean], [history=boolean], [image1=string], [image2=string], [image3=string], [latticeColumns=uint], [latticeRows=uint], [name=string], [snapPixelMode=boolean], [useBoundingRect=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
texLatticeDeformContext is undoable, queryable, and editable.
This command creates a context which may be used to
deform UV maps with lattice manipulator. This context
only works in the texture UV editor.
int | Number of column divisions, when querying the latticeColumns flag. |
int | Number of row divisions, when querying the latticeRows flag. |
float | Value of the deform envelope, when querying the envelope flag. |
boolean | Whether snapping to pixels is on, when querying the snapPixelMode flag. |
boolean | Whether the bounding rectangle is to be used for deforemation, when querying the useBoundingRect flag. |
In query mode, return type is based on queried flag.
envelope, exists, history, image1, image2, image3, latticeColumns, latticeRows, name, snapPixelMode, useBoundingRect
Long name (short name) |
Argument types |
Properties |
|
envelope(ev)
|
float
|
|
|
Specifies the influence of the lattice.
|
|
exists(ex)
|
boolean
|
|
|
Returns true or false depending upon whether the
specified object exists. Other flags are ignored.
|
|
history(ch)
|
boolean
|
|
|
If this is a tool command, turn the construction history on
for the tool in question.
|
|
image1(i1)
|
string
|
|
|
First of three possible icons representing the tool
associated with the context.
|
|
image2(i2)
|
string
|
|
|
Second of three possible icons representing the tool
associated with the context.
|
|
image3(i3)
|
string
|
|
|
Third of three possible icons representing the tool
associated with the context.
|
|
latticeColumns(lc)
|
uint
|
|
|
Specifies the number column points the lattice contains. The
maximum size lattice is restricted to 8 columns.
|
|
latticeRows(lr)
|
uint
|
|
|
Specifies the number of rows the lattice contains. The
maximum size lattice is restricted to 8 rows.
|
|
name(n)
|
string
|
|
|
If this is a tool command, name the tool appropriately.
|
|
snapPixelMode(spm)
|
boolean
|
|
|
Specifies the influenced uv points should be snapped to a pixel
center or corner.
|
|
useBoundingRect(ubr)
|
boolean
|
|
|
When constructing the lattice use the bounding box of the
selected UVs for the extents of the lattice. When this is
disabled the extents of the marquee selections are used as the
extents for the lattice.
|
|
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.texLatticeDeformContext( 'latticeContext', latticeColumns=4, latticeRows=4 )