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

Synopsis

boneLattice( objects , [after=boolean], [before=boolean], [bicep=float], [deformerTools=boolean], [exclusive=string], [frontOfChain=boolean], [geometry=string], [ignoreSelected=boolean], [joint=string], [lengthIn=float], [lengthOut=float], [name=string], [parallel=boolean], [prune=boolean], [remove=boolean], [split=boolean], [transform=string], [tricep=float], [widthLeft=float], [widthRight=float])

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

boneLattice is undoable, queryable, and editable.

This command creates/edits/queries a boneLattice deformer. The name of the created/edited object is returned. Usually you would make use of this functionality through the higher level flexor command.

Return value

stringName of bone lattice algorithm node created/edited.

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

Related

bindSkin, blendShape, copyFlexor, copySkinWeights, flexor, skinCluster, skinPercent, wire, wrinkle

Flags

after, before, bicep, deformerTools, exclusive, frontOfChain, geometry, ignoreSelected, joint, lengthIn, lengthOut, name, parallel, prune, remove, split, transform, tricep, widthLeft, widthRight
Long name (short name) Argument types Properties
name(n) string create
Used to specify the name of the node being created
geometry(g) string queryeditmultiuse
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 ...
remove(rm) boolean editmultiuse
Specifies that objects listed after the -g flag should be removed from this deformer.
before(bf) boolean create
If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick 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
after(af) boolean create
If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick 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
split(sp) boolean create
Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing chain.
frontOfChain(foc) boolean create
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.
parallel(par) boolean create
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.
ignoreSelected(ignoreSelected) boolean create
Tells the command to not deform objects on the current selection list
deformerTools(dt) boolean query
Returns the name of the deformer tool objects (if any) as string string ...
prune(pr) boolean edit
Removes any points not being deformed by the deformer in its current configuration from the deformer set.
exclusive(ex) string createquery
Puts the deformation set in a deform partition.
bicep(bi) float createqueryedit
Affects the bulging of lattice points on the inside of the bend. Positive/negative values cause the points to bulge outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
tricep(tr) float createqueryedit
Affects the bulging of lattice points on the outside of the bend. Positive/negative values cause the points to bulge outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
lengthIn(li) float createqueryedit
Affects the location of lattice points along the upper half of the bone. Positive/negative values cause the points to move away/towards the center of the bone. Changing this parameter also modifies the regions affected by the creasing, rounding and width parameters. Default value is 0.0. When queried, this flag returns a float.
lengthOut(lo) float createqueryedit
Affects the location of lattice points along the lower half of the bone. Positive/negative values cause the points to move away/towards the center of the bone. Changing this parameter also modifies the regions affected by the creasing, rounding and width parameters. Default value is 0.0. When queried, this flag returns a float.
widthLeft(wl) float createqueryedit
Affects the bulging of lattice points on the left side of the bend. Positive/negative values cause the points to bulge outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
widthRight(wr) float createqueryedit
Affects the bulging of lattice points on the right side of the bend. Positive/negative values cause the points to bulge outwards/inwards. Default value is 0.0. When queried, this flag returns a float.
joint(j) string createqueryedit
Specifies which joint will be used to drive the bulging behaviors.
transform(t) string create
Specifies which dag node is being used to rigidly transform the lattice which this node is going to deform. If this flag is not specified an identity matrix will be assumed.
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

# select a lattice that has been added to a rigid skin shape
#
cmds.boneLattice( joint='joint2' )
cmds.boneLattice( transform='joint1', joint='joint2' )
cmds.boneLattice( 'boneLattice1', edit=True, bicep=0.5 )