pymel.core.nodetypes.VortexField

class VortexField(*args, **kwargs)

class counterpart of mel function vortex

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.

getAxis()

Returns the axis around which the vortex field exerts it’s force.

Return type:Vector

Derived from api method maya.OpenMayaFX.MFnVortexField.axis

getAxisX(**kwargs)

X-component of vortex axis

Derived from mel command maya.cmds.vortex

getAxisY(**kwargs)

Y-component of vortex axis

Derived from mel command maya.cmds.vortex

getAxisZ(**kwargs)

Z-component of vortex axis Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.vortex

getTorusSectionRadius(**kwargs)

Derived from mel command maya.cmds.vortex

getVolumeExclusion(**kwargs)

Derived from mel command maya.cmds.vortex

getVolumeOffset(**kwargs)

Derived from mel command maya.cmds.vortex

getVolumeShape(**kwargs)

Derived from mel command maya.cmds.vortex

getVolumeSweep(**kwargs)

Derived from mel command maya.cmds.vortex

setAxis(axisVector)

Sets the axis around which the vortex field exerts it’s force.

Parameters:

axisVector : Vector

A vector representing an axis.

Derived from api method maya.OpenMayaFX.MFnVortexField.setAxis

setAxisX(val=True, **kwargs)

X-component of vortex axis

Derived from mel command maya.cmds.vortex

setAxisY(val=True, **kwargs)

Y-component of vortex axis

Derived from mel command maya.cmds.vortex

setAxisZ(val=True, **kwargs)

Z-component of vortex axis Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.vortex

setTorusSectionRadius(val=True, **kwargs)

Derived from mel command maya.cmds.vortex

setVolumeExclusion(val=True, **kwargs)

Derived from mel command maya.cmds.vortex

setVolumeOffset(val=True, **kwargs)

Derived from mel command maya.cmds.vortex

setVolumeShape(val=True, **kwargs)

Derived from mel command maya.cmds.vortex

setVolumeSweep(val=True, **kwargs)

Derived from mel command maya.cmds.vortex