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

Synopsis

boneLattice( objects , [after=boolean], [afterReference=boolean], [before=boolean], [bicep=float], [components=boolean], [deformerTools=boolean], [exclusive=string], [frontOfChain=boolean], [geometry=string], [geometryIndices=boolean], [ignoreSelected=boolean], [includeHiddenSelections=boolean], [joint=string], [lengthIn=float], [lengthOut=float], [name=string], [parallel=boolean], [prune=boolean], [remove=boolean], [selectedComponents=boolean], [split=boolean], [transform=string], [tricep=float], [useComponentTags=boolean], [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, afterReference, before, bicep, components, deformerTools, exclusive, frontOfChain, geometry, geometryIndices, ignoreSelected, includeHiddenSelections, joint, lengthIn, lengthOut, name, parallel, prune, remove, selectedComponents, split, transform, tricep, useComponentTags, widthLeft, widthRight
Long name (short name) Argument types Properties
after(af) boolean createedit
If the default behavior for insertion/appending into/onto the existing chain is not the desired behavior then this flag can be used to force the command to place 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. Works in create mode (and edit mode if the deformer has no geometry added yet).
afterReference(ar) boolean createedit
The -afterReference flag is used to specify deformer ordering in a hybrid way that choses between -before and -after automatically. If the geometry being deformed is referenced then the -after mode is used when adding the new deformer, otherwise the -before mode is used. The net effect when using -afterReference to build deformer chains is that internal shape nodes in the deformer chain will only appear at reference file boundaries, leading to lightweight deformer networks that may be more amicable to reference swapping.
before(bf) boolean createedit
If the default behavior for insertion/appending into/onto the existing chain is not the desired behavior then this flag can be used to force the command to place 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. Works in create mode (and edit mode if the deformer has no geometry added yet).
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.
components(cmp) boolean query
Returns the components used by the deformer
deformerTools(dt) boolean query
Returns the name of the deformer tool objects (if any) as string string ...
exclusive(ex) string createquery
Puts the deformation set in a deform partition.
frontOfChain(foc) boolean createedit
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. Works in create mode (and edit mode if the deformer has no geometry added yet).
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 ...
geometryIndices(gi) boolean query
Complements the -geometry flag in query mode. Returns the multi index of each geometry.
ignoreSelected(ignoreSelected) boolean create
Tells the command to not deform objects on the current selection list
includeHiddenSelections(ihs) boolean create
Apply the deformer to any visible and hidden objects in the selection list. Default is false.
joint(j) string createqueryedit
Specifies which joint will be used to drive the bulging behaviors.
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.
name(n) string create
Used to specify the name of the node being created.
parallel(par) boolean createedit
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. Works in create mode (and edit mode if the deformer has no geometry added yet).
prune(pr) boolean edit
Removes any points not being deformed by the deformer in its current configuration from the deformer set.
remove(rm) boolean editmultiuse
Specifies that objects listed after the -g flag should be removed from this deformer.
selectedComponents(cms) boolean query
Returns the components used by the deformer that are currently selected. This intersects the current selection with the components affected by the deformer.
split(sp) boolean createedit
Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
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.
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.
useComponentTags(uct) boolean create
When this flag is specified a setup using componentTags will be created. This means no groupId, groupParts, tweak or objectSet nodes will be created and connected to the new deformer.
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.
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 )