pymel.core.effects.drag

drag(*args, **kwargs)

Drag exerts a friction, or braking force proportional to the speed of a moving object. If direction is not enabled, the drag acts opposite to the current velocity of the object. If direction is enabled, it acts opposite to the component of the velocity in the specified direction. The force is independent of the position of the affected object. 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
directionX (dx)		float
	X-component of direction.
directionY (dy)		float
	Y-component of direction.
directionZ (dz)		float
	Z-component of direction
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 force is exerted only from the geometric center of the set of points.
position (pos)		float, float, float
	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
useDirection (ud)		bool
	Enable/disable direction. Drag will use -dx/-dy/-dz arguments if and only if this flag is set true. Flag can have multiple arguments, passed either as a tuple or a list.
volumeExclusion (vex)		bool
volumeOffset (vof)		float, float, float
volumeShape (vsh)		unicode
volumeSweep (vsw)		float

Derived from mel command maya.cmds.drag

Example:

import pymel.core as pm

# Creates a drag field resisting in direction (0,1,0.5).
pm.drag( name='myDrag', dx=0, dy=1.0, dz=0.5, useDirection=1 )
# Result: nt.DragField(u'myDrag') #

# Edits the acceleration value of the field myDrag
pm.drag( 'myDrag', e=True, m=0.75 )
# Result: nt.DragField(u'myDrag') #

# Queries myDrag for its magnitude
pm.drag( 'myDrag', q=True, m=True )
# Result: 0.75 #