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.

This command creates a tool that can be used to create a wire deformer.

Return value

string The name of the context created

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

Flags

crossingEffect, deformationOrder, dropoffDistance, envelope, exclusive, exclusivePartition, exists, groupWithBase, history, holder, image1, image2, image3, localInfluence, name
Long name (short name) Argument types Properties
-exists(-ex) create
Returns true or false depending upon whether the specified object exists. Other flags are ignored.
-image1(-i1) string createqueryedit
-image2(-i2) string createqueryedit
-image3(-i3) string createqueryedit
Contexts support up to three icons that represent the tool associated with the context.
-history(-ch) boolean create
If this is a tool command, turn the construction history on for the tool in question.
-name(-n) string create
If this is a tool command, name the tool appropriately.
-crossingEffect(-ce) linear createqueryedit
Set the amount of convolution filter effect. Varies from fully convolved at 0 to a simple additive effect at 1. Default is 0.
-envelope(-en) linear createqueryedit
Set the envelope value for the deformer. Default is 1.0
-dropoffDistance(-dds) linear createqueryedit
Set the dropoff Distance for the wires.
-holder(-ho) boolean createedit
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.
-localInfluence(-li) linear createqueryedit
Set the amount of local influence a wire has with respect to other wires. Default is 0.
-groupWithBase(-gw) boolean createqueryedit
Groups the wire with the base wire so that they can easily be moved together to create a ripple effect. Default is false.
-deformationOrder(-do) string createqueryedit
Set the appropriate flag that determines the position in in the deformation hierarchy.
-exclusive(-exc) boolean createqueryedit
Set exclusive mode on or off
-exclusivePartition(-ep) string createqueryedit
Set the name of an exclusive partition.
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;