wireContext

Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

wireContext [-crossingEffect linear] [-deformationOrder string] [-dropoffDistance linear] [-envelope linear] [-exclusive boolean] [-exclusivePartition string] [-exists] [-groupWithBase boolean] [-history boolean] [-holder boolean] [-image1 string] [-image2 string] [-image3 string] [-localInfluence linear] [-name string] string

wireContext is undoable, queryable, and editable.

Return value

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

Flags

Long name (short name)	Argument types	Properties
-crossingEffect(-ce)	linear
Set the amount of convolution filter effect. Varies from fully convolved at 0 to a simple additive effect at 1. Default is 0.
-deformationOrder(-do)	string
Set the appropriate flag that determines the position in in the deformation hierarchy.
-dropoffDistance(-dds)	linear
Set the dropoff Distance for the wires.
-envelope(-en)	linear
Set the envelope value for the deformer. Default is 1.0
-exclusive(-exc)	boolean
Set exclusive mode on or off.
-exclusivePartition(-ep)	string
Set the name of an exclusive partition.
-exists(-ex)
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
-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.
-history(-ch)	boolean
If this is a tool command, turn the construction history on for the tool in question.
-holder(-ho)	boolean
Controls whether the user can specify holders for the wires from the wire context. A holder is a curve that you can use to limit the wire's deformation region. Default is false.
-image1(-i1)	string
First of three possible icons representing the tool associated with the context.
-image2(-i2)	string
Second of three possible icons representing the tool associated with the context.
-image3(-i3)	string
Third of three possible icons representing the tool associated with the context.
-localInfluence(-li)	linear
Set the amount of local influence a wire has with respect to other wires. Default is 0.
-name(-n)	string
If this is a tool command, name the tool appropriately.

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 be used more than once in a command.

MEL examples

wireContext wireCtx;