pymel.core.effects.volumeAxis

static effects.volumeAxis(*args, **kwargs)

A volume axis field can push particles in four directions, defined with respect to a volume: along the axis, away from the axis or center, around the axis, and in a user-specified direction. These are analogous to the emission speed controls of volume emitters. The volume axis field also contains a wind turbulence model (different from the turbulence field) that simulates an evolving flow of liquid or gas. The turbulence has a build in animation that is driven by a connection to a time node. 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
alongAxis (alx)		float
	Initial velocity multiplier in the direction along the central axis of the volume. See the diagrams in the documentation.
aroundAxis (arx)		float
	Initial velocity multiplier in the direction around the central axis of the volume. See the diagrams in the documentation.
attenuation (att)		float
	Attentuation rate of field with distance. For sphere volumes, distance is computed from the center of the sphere. For cone, cylinder, and cube volumes, it is computed from the vertical axis of the volume. For torus volumes, it is computed from the ring in the middle of the solid portion of the torus.
awayFromAxis (afx)		float
	Initial velocity multiplier in the direction away from the central axis of the volume. See the diagrams in the documentation. Used only with the cylinder, cone, and torus volumes.
awayFromCenter (afc)		float
	Initial velocity multiplier in the direction away from the center point of a cube or sphere volume. Used only with the cube and sphere volumes.
detailTurbulence (dtr)		float
	The relative intensity of a second higher frequency turbulence. This can be used to create fine features in large scale flows. Both the speed and the frequency on this second turbulence are higher than the primary turbulence. When the detailTurbulence is non-zero the simulation may run a bit slower, due to the computation of a second turbulence. Flag can have multiple arguments, passed either as a tuple or a list.
directionX (dx)		float
	x-component of force direction. Used with directional speed.
directionY (dy)		float
	y-component of force direction. Used with directional speed.
directionZ (dz)		float
	z-component of force direction. Used with directional speed.
directionalSpeed (drs)		float
	Adds a component of speed in the direction specified by the directionX, Y, and Z attributes.
invertAttenuation (ia)		bool
	If this attribute is FALSE, the default, then the attenuation makes the field’s effect decrease as the affected point is further from the volume’s axis and closer to its edge. If the is set to TRUE, then the effect of the field increases in this case, making the full effect of the field felt at the volume’s edge.
magnitude (m)		float
	Strength of field.
maxDistance (mxd)		float
	Maximum distance at which field is exerted. A zero or negative value will turn off the field effect completely. For sphere volumes, distance is computed from the center of the sphere. For cone, cylinder, and cube volumes, it is computed from the vertical axis of the volume. For torus volumes, it is computed from the ring in the middle of the solid portion of the torus.
name (n)		unicode
	name of field
perVertex (pv)		bool
	No effect for this type of field.
position (pos)		float, float, float
	Position in space where you want to place the volume.
torusSectionRadius (tsr)		float
turbulence (trb)		float
	Adds a force simulating a turbulent wind that evolves over time.
turbulenceFrequencyX (tfx)		float
	The repeats of the turbulence function in X.
turbulenceFrequencyY (tfy)		float
	The repeats of the turbulence function in Y.
turbulenceFrequencyZ (tfz)		float
	The repeats of the turbulence function in Z.
turbulenceOffsetX (tox)		float
	The translation of the turbulence function in X.
turbulenceOffsetY (toy)		float
	The translation of the turbulence function in Y.
turbulenceOffsetZ (toz)		float
	The translation of the turbulence function in Z.
turbulenceSpeed (trs)		float
	The rate of change of the turbulence over time. The turbulence loops seamlessly every 1.0/turbulenceSpeed seconds. To animate this rate attach a new time node to the time input on the volumeAxisNode then animate the time value on the time node.
volumeExclusion (vex)		bool
volumeOffset (vof)		float, float, float
volumeShape (vsh)		unicode
volumeSweep (vsw)		float

Derived from mel command maya.cmds.volumeAxis

Example:

import pymel.core as pm

pm.volumeAxis( pos=(0, 0, 0), afc=1.0, afx=2.0, arx=3.0, alx=4.0, drs=6.0 )
# Result: nt.VolumeAxisField(u'volumeAxisField1') #

# Creates a volume axis field with the following attribute values:
# awayFromCenter = 1.0, awayFromAxis = 2.0, aroundAxis = 3.0, alongAxis = 4.0,
# directionalSpeed = 6.0.