pymel.core.nodetypes.DragField

class DragField(*args, **kwargs)

class counterpart of mel function drag

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.

getDirection()

Returns the direction of the drag force’s influence along the x, y, and z axes. You must have the Use Direction setting turned on for this attribute to take effect.

Return type:Vector

Derived from api method maya.OpenMayaFX.MFnDragField.direction

getDirectionX(**kwargs)

X-component of direction.

Derived from mel command maya.cmds.drag

getDirectionY(**kwargs)

Y-component of direction.

Derived from mel command maya.cmds.drag

getDirectionZ(**kwargs)

Z-component of direction

Derived from mel command maya.cmds.drag

getTorusSectionRadius(**kwargs)

Derived from mel command maya.cmds.drag

getUseDirection()

Returns true if the braking force is exerted only against the component of the object’s velocity that lies along the direction of the drag force.

Return type:bool

Derived from api method maya.OpenMayaFX.MFnDragField.useDirection

getVolumeExclusion(**kwargs)

Derived from mel command maya.cmds.drag

getVolumeOffset(**kwargs)

Derived from mel command maya.cmds.drag

getVolumeShape(**kwargs)

Derived from mel command maya.cmds.drag

getVolumeSweep(**kwargs)

Derived from mel command maya.cmds.drag

setDirection(dragDirection)

Sets the direction of the drag force’s influence along the x, y, and z axes. You must have the Use Direction setting turned on for this attribute to take effect.

Parameters:

dragDirection : Vector

A vector representing direction.

Derived from api method maya.OpenMayaFX.MFnDragField.setDirection

setDirectionX(val=True, **kwargs)

X-component of direction.

Derived from mel command maya.cmds.drag

setDirectionY(val=True, **kwargs)

Y-component of direction.

Derived from mel command maya.cmds.drag

setDirectionZ(val=True, **kwargs)

Z-component of direction

Derived from mel command maya.cmds.drag

setTorusSectionRadius(val=True, **kwargs)

Derived from mel command maya.cmds.drag

setUseDirection(enable)

Enables the braking force to be exerted only against the component of the object’s velocity that lies along the direction setting of the drag force.

Parameters:

enable : bool

Flag to enable or disable direction setting.

Derived from api method maya.OpenMayaFX.MFnDragField.setUseDirection

setVolumeExclusion(val=True, **kwargs)

Derived from mel command maya.cmds.drag

setVolumeOffset(val=True, **kwargs)

Derived from mel command maya.cmds.drag

setVolumeShape(val=True, **kwargs)

Derived from mel command maya.cmds.drag

setVolumeSweep(val=True, **kwargs)

Derived from mel command maya.cmds.drag