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


vortex [-attenuation float] [-axisX float] [-axisY float] [-axisZ float] [-magnitude float] [-maxDistance linear] [-name string] [-perVertex boolean] [-position linear linear linear] selectionList

vortex is undoable, queryable, and editable.

A vortex field pulls objects in a circular direction, like a whirlpool or tornado. Objects affected by the vortex field tend to rotate around the axis specified by -ax, -ay, and -az.

The transform is the associated dependency node. Use connectDynamic to cause the field to affect a dynamic object.

If fields are created, this command returns the names of each of the fields. If a field was queried, the results of the query are returned. If a field was edited, the field name is returned.

If object names are provided or the active selection list is non-empty, the command creates a field for every object in the list and calls addDynamic to add it to the object. If the list is empty, the command defaults to -pos 0 0 0.

Setting the -pos flag with objects named on the command line is an error.

Return value


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


attenuation, axisX, axisY, axisZ, magnitude, maxDistance, name, perVertex, position
Long name (short name) Argument types Properties
-position(-pos) linear linear linear queryeditmultiuse
Position in space where you want to place a field. The gravity then emanates from this position in space rather than from an object. Note that you can both use -pos (creating a field at a position) and also provide object names.
-magnitude(-m) float queryedit
Strength of field.
-attenuation(-att) float queryedit
Attentuation rate of field
-maxDistance(-mxd) linear queryedit
Maximum distance at which field is exerted. -1 indicates that the field has no maximum distance.
-name(-n) string queryedit
name of field
-perVertex(-pv) boolean queryedit
Per-vertex application. If this flag is set true, then each individual point (CV, particle, vertex,etc.) of the chosen object exerts an identical copy of the force field. If this flag is set to false, then the force is exerted only from the geometric center of the set of points.
-axisX(-ax) float queryedit
X-component of vortex axis
-axisY(-ay) float queryedit
Y-component of vortex axis
-axisZ(-az) float queryedit
Z-component of vortex axis

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

vortex -ax 0 -ay 1.0 -az 0.5;
// Creates a vortex field with axis (0,1,0.5) for every active
// selection. If there is no active
// selection, it creates this field at world position (0,0,0).