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

Synopsis

proximityWrap [-addDrivers string] [-applyUserDefaults boolean] [-canBeAdded string] [-driverIndices] [-dumpInfo] [-freeDriverIndex] [-removeDrivers string] [objects]

proximityWrap is undoable, queryable, and editable.

This command creates a proximityWrap deformer, which deforms geometry based on the distance from its drivers.

Return value

string[](the proximityWrap node name)

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

Flags

addDrivers, applyUserDefaults, canBeAdded, driverIndices, dumpInfo, freeDriverIndex, removeDrivers
Long name (short name) Argument types Properties
-addDrivers(-ad) string editmultiuse
Add connect new drivers to the proximityWrap node
-applyUserDefaults(-aud) boolean edit
Flag used in with the addDriver flag. When set, new drivers will set the user default attributes from the option var settings. When the flag is not set, the user default attributes will not be set. Default is on.
-canBeAdded(-cba) string querymultiuse
Returns true if all listed shapes can be added as drivers. The reason for an item returning false would be that it is already connected as a driver, it is connected as the deformed geometry or it represents in invalid object.
-driverIndices(-di) query
List connected driver indices
-dumpInfo(-dui) query
Return a python dictionary containing information relating to the proximityWrap node. Some information is returned in string form in mel but the flag is meant to be used in python.
-freeDriverIndex(-fdi) query
Returns the first index which has no driver connected
-removeDrivers(-rd) string editmultiuse
Remove connected drivers

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

// Add drivers to the proximityWrap
proximityWrap -edit -addDrivers driverShape1 -addDrivers driverShape2 proximityWrap1;

// Add driver to the proximityWrap and skip setting the initial attributes
proximityWrap -edit -applyUserDefaults -addDrivers driverShape2 proximityWrap1;

// Remove drivers
proximityWrap -edit -removeDrivers driverShape1 -removeDrivers driverShape2 proximityWrap1;

// List driver indices (returns [0, 1])
proximityWrap -query driverIndices proximityWrap1;

// List free driver index (returns 2)
proximityWrap -query -freeDriverIndex proximityWrap1;

// Query can be added
proximityWrap -query -canBeAdded driverShape1 proximityWrap1; // return true
proximityWrap -query -canBeAdded newDriverShape3 proximityWrap1; // return true

// Dump info
proximityWrap -query -dumpInfo proximityWrap1;