pymel.core.nodetypes.BoneLattice

class BoneLattice(*args, **kwargs)

class counterpart of mel function boneLattice

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.

after(val=True, **kwargs)

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. Works in create mode (and edit mode if the deformer has no geometry added yet).

Derived from mel command maya.cmds.boneLattice

afterReference(val=True, **kwargs)

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 -after mode is used in adding the new deformer otherwise -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.

Derived from mel command maya.cmds.boneLattice

before(val=True, **kwargs)

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. Works in create mode (and edit mode if the deformer has no geometry added yet).

Derived from mel command maya.cmds.boneLattice

frontOfChain(val=True, **kwargs)

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).

Derived from mel command maya.cmds.boneLattice

getBicep(**kwargs)

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.

Derived from mel command maya.cmds.boneLattice

getDeformerTools(**kwargs)

Returns the name of the deformer tool objects (if any) as string string ...

Derived from mel command maya.cmds.boneLattice

getExclusive(**kwargs)

Puts the deformation set in a deform partition.

Derived from mel command maya.cmds.boneLattice

getGeometry(**kwargs)

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 ...

Derived from mel command maya.cmds.boneLattice

getGeometryIndices(**kwargs)

Complements the -geometry flag in query mode. Returns the multi index of each geometry.

Derived from mel command maya.cmds.boneLattice

getJoint(**kwargs)

Specifies which joint will be used to drive the bulging behaviors.

Derived from mel command maya.cmds.boneLattice

getLengthIn(**kwargs)

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.

Derived from mel command maya.cmds.boneLattice

getLengthOut(**kwargs)

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.

Derived from mel command maya.cmds.boneLattice

getTricep(**kwargs)

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.

Derived from mel command maya.cmds.boneLattice

getWidthLeft(**kwargs)

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.

Derived from mel command maya.cmds.boneLattice

getWidthRight(**kwargs)

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.

Derived from mel command maya.cmds.boneLattice

parallel(val=True, **kwargs)

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).

Derived from mel command maya.cmds.boneLattice

prune(val=True, **kwargs)

Removes any points not being deformed by the deformer in its current configuration from the deformer set.

Derived from mel command maya.cmds.boneLattice

remove(val=True, **kwargs)

Specifies that objects listed after the -g flag should be removed from this deformer.

Derived from mel command maya.cmds.boneLattice

setBicep(val=True, **kwargs)

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.

Derived from mel command maya.cmds.boneLattice

setGeometry(val=True, **kwargs)

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 ...

Derived from mel command maya.cmds.boneLattice

setJoint(val=True, **kwargs)

Specifies which joint will be used to drive the bulging behaviors.

Derived from mel command maya.cmds.boneLattice

setLengthIn(val=True, **kwargs)

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.

Derived from mel command maya.cmds.boneLattice

setLengthOut(val=True, **kwargs)

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.

Derived from mel command maya.cmds.boneLattice

setTricep(val=True, **kwargs)

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.

Derived from mel command maya.cmds.boneLattice

setWidthLeft(val=True, **kwargs)

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.

Derived from mel command maya.cmds.boneLattice

setWidthRight(val=True, **kwargs)

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.

Derived from mel command maya.cmds.boneLattice