pymel.core.animation.wire

wire(*args, **kwargs)

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.

Flags:

Long name (short name)		Argument Types	Properties
after (af)		bool
	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).
afterReference (ar)		bool
	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.
before (bf)		bool
	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).
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.
deformerTools (dt)		bool
	Returns the name of the deformer tool objects (if any) as string string ...
dropoffDistance (dds)		int, float
	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
exclusive (ex)		unicode
	Puts the deformation set in a deform partition.
frontOfChain (foc)		bool
	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)		unicode
	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)		bool
	Complements the -geometry flag in query mode. Returns the multi index of each geometry.
groupWithBase (gw)		bool
	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 commandFlag can have multiple arguments, passed either as a tuple or a list.
holder (ho)		int, unicode
	Set the specified curve or surface (second parameter as a holder for the wire at index (first parameter).
ignoreSelected (ignoreSelected)		bool
	Tells the command to not deform objects on the current selection list
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.
name (n)		unicode
	Used to specify the name of the node being created
parallel (par)		bool
	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)		bool
	Removes any points not being deformed by the deformer in its current configuration from the deformer set.
remove (rm)		bool
	Specifies that objects listed after the -g flag should be removed from this deformer.
split (sp)		bool
	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).
wire (w)		unicode
	Specify or query the wire curve name.
wireCount (wc)		int
	Set the number of wires.

Derived from mel command maya.cmds.wire

Example:

import pymel.core as pm

# select a surface and a curve that you want to be a wire, then enter
pm.wire()
# Result: [nt.Wire(u'wire1')] #

# create a wire deformer on surface1 using curve1 and curve2
pm.wire( 'surface1', 'curve1', 'curve2' )

# modify the dropoff distance and envelope on wire1
pm.wire( 'wire1', edit=True, en=0.8, dds=[(0, 6),(1, 3.2)] )