pymel.core.effects.vortex

vortex(*args, **kwargs)

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.

Flags:
Long name (short name) Argument Types Properties
attenuation (att) float ../../../_images/query.gif ../../../_images/edit.gif
 
Attentuation rate of field
axisX (ax) float ../../../_images/query.gif ../../../_images/edit.gif
 
X-component of vortex axis
axisY (ay) float ../../../_images/query.gif ../../../_images/edit.gif
 
Y-component of vortex axis
axisZ (az) float ../../../_images/query.gif ../../../_images/edit.gif
 
Z-component of vortex axisFlag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
magnitude (m) float ../../../_images/query.gif ../../../_images/edit.gif
 
Strength of field.
maxDistance (mxd) float ../../../_images/query.gif ../../../_images/edit.gif
 
Maximum distance at which field is exerted. -1 indicates that the field has no maximum distance.
name (n) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
name of field
perVertex (pv) bool ../../../_images/query.gif ../../../_images/edit.gif
 

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.

position (pos) float, float, float ../../../_images/query.gif ../../../_images/edit.gif
 

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.

torusSectionRadius (tsr) float ../../../_images/query.gif ../../../_images/edit.gif
   
volumeExclusion (vex) bool ../../../_images/query.gif ../../../_images/edit.gif
   
volumeOffset (vof) float, float, float ../../../_images/query.gif ../../../_images/edit.gif
   
volumeShape (vsh) unicode ../../../_images/query.gif ../../../_images/edit.gif
   
volumeSweep (vsw) float ../../../_images/query.gif ../../../_images/edit.gif
   

Derived from mel command maya.cmds.vortex

Example:

import pymel.core as pm

import maya.cmds as cmds

pm.vortex( ax=0, ay=1.0, az=0.5 )
# Result: nt.VortexField(u'vortexField1') #
# 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).

Previous topic

pymel.core.effects.volumeAxis

Next topic

pymel.core.general

Core

Core Modules

Other Modules

This Page