Go to: Synopsis. Return value. Related.
Flags. Python
examples.
wire( [objects] , [after=boolean], [before=boolean], [crossingEffect=float], [deformerTools=boolean], [dropoffDistance=[uint, linear]],
[envelope=float], [exclusive=string], [frontOfChain=boolean], [geometry=string], [groupWithBase=boolean], [holder=[uint, string]], [ignoreSelected=boolean], [localInfluence=float], [name=string], [parallel=boolean], [prune=boolean], [remove=boolean], [split=boolean], [wire=string], [wireCount=uint])
Note: Strings representing object names and
arguments must be separated by commas. This is not depicted in the
synopsis.
wire is undoable, queryable, and editable.
This command creates a wire deformer.
In the create mode the selection list is treated as the object(s)
to be deformed, Wires are specified with the -w flag. Each wire can
optionally have a holder which helps define the the regon of the
object that is affected by the deformer.
| string[] |
The wire node name and the wire curve name |
In query mode, return type is based on queried flag.
cluster, deformer, flexor,
lattice, percent, sculpt,
wrinkle
after, before,
crossingEffect, deformerTools, dropoffDistance, envelope, exclusive, frontOfChain, geometry, groupWithBase, holder, ignoreSelected, localInfluence, name, parallel,
prune, remove,
split, wire,
wireCount
| Long name (short name) |
Argument types |
Properties |
name(n) |
string |
 |
|
Used to specify the name of the node being created |
|
geometry(g) |
string |
   |
|
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 |
|
|
Specifies that objects listed after the -g flag should be
removed from this deformer. |
|
before(bf) |
boolean |
|
|
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). |
|
after(af) |
boolean |
|
|
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). |
|
split(sp) |
boolean |
|
|
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). |
|
frontOfChain(foc) |
boolean |
|
|
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). |
|
parallel(par) |
boolean |
|
|
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). |
|
ignoreSelected(ignoreSelected) |
boolean |
|
|
Tells the command to not deform objects on the current
selection list |
|
deformerTools(dt) |
boolean |
|
|
Returns the name of the deformer tool objects (if any) as
string string ... |
|
prune(pr) |
boolean |
|
|
Removes any points not being deformed by the deformer in its
current configuration from the deformer set. |
|
exclusive(ex) |
string |
|
|
Puts the deformation set in a deform partition. |
|
crossingEffect(ce) |
float |
|
|
Set the amount of convolution effect. Varies from fully
convolved at 0 to a simple additive effect at 1 (which is what you
get with the filter off). Default is 0. This filter should make
its way into all blend nodes that deal with combining effects from
multiple sources. |
|
dropoffDistance(dds) |
[uint, linear] |
|
|
Set the dropoff distance (second parameter) for the wire at
index (first parameter). |
|
envelope(en) |
float |
|
|
Set the envelope value for the deformer. Default is 1.0 |
|
holder(ho) |
[uint, string] |
|
|
Set the specified curve or surface (second parameter as a
holder for the wire at index (first parameter). |
|
localInfluence(li) |
float |
|
|
Set the local control a wire has with respect to other wires
irrespective of whether it is deforming the surface. Varies from no
local effect at 0 to full local control at 1. Default is 0. |
|
wire(w) |
string |
|
|
Specify or query the wire curve name. |
|
wireCount(wc) |
uint |
|
|
|
groupWithBase(gw) |
boolean |
|
|
Groups the wire with the base wire so that they can easily be
moved together to create a ripple effect. Default is false. |
|
| 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
# select a surface and a curve that you want to be a wire, then enter
cmds.wire()
# create a wire deformer on surface1 using curve1 and curve2
cmds.wire( 'surface1', 'curve1', 'curve2' )
# modify the dropoff distance and envelope on wire1
cmds.wire( 'wire1', edit=True, en=0.8, dds=[(0, 6),(1, 3.2)] )