pymel.core.effects.vortex¶

vortex(*args, **kwargs)¶

For each listed object, the command creates a new field. The field has a shape which lives in the DAG and it has an associated dependency node. The field is added to the list of fields owned by the object. Use connectDynamic to cause the field to affect a dynamic object. Note that if more than one object is listed, a separate field is created for each object. If fields are created, this command returns the names of each owning shape and of the field shapes themselves. If a field was queried, the results of the query are returned. If a field was edited, the field name is returned. If no object names are provided but the active selection list is non-empty, the command creates a field for every object in the list. If the list is empty, the command defaults to -pos 0 0 0. 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
	Attentuation rate of field
axisX / ax		float
	X-component of vortex axis
axisY / ay		float
	Y-component of vortex axis
axisZ / az		float
	Z-component of vortex axis
magnitude / m		float
	Strength of field.
maxDistance / mxd		float
	Maximum distance at which field is exerted. -1 indicates that the field has no maximum distance.
name / n		unicode
	name of field
perVertex / pv		bool
	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 froce is exerted only from the geometric center of the set of points.
position / pos		float, float, float
	Position in space (x,y,z) where you want to place a gravity 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
	Section radius for a torus volume. Applies only to torus. Similar to the section radius in the torus modelling primitive.
volumeExclusion / vex		bool
	Volume exclusion of the field. If true, points outside the volume (defined by the volume shape attribute) are affected, If false, points inside the volume are affected. Has no effect if volumeShape is set to none.
volumeOffset / vof		float, float, float
	Volume offset of the field. Volume offset translates the field’s volume by the specified amount from the actual field location. This is in the field’s local space.
volumeShape / vsh		unicode
	Volume shape of the field. Sets/edits/queries the field’s volume shape attribute. If set to any value other than none, determines a 3-D volume within which the field has effect. Values are: none,cube,sphere,cylinder,cone,torus.
volumeSweep / vsw		float
	Volume sweep of the field. Applies only to sphere, cone, cylinder, and torus. Similar effect to the sweep attribute in modelling. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.vortex

Example:

import pymel.core as pm

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).