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


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 nonzero the simulation may run a bit slower, due to the
computation of a second turbulence.


directionX(dx)

float



xcomponent of force direction. Used with directional speed.


directionY(dy)

float



ycomponent of force direction. Used with directional speed.


directionZ(dz)

float



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

boolean



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



maxDistance(mxd)

linear



Maximum distance at which field is exerted.
1 indicates that the field has no maximum distance.


name(n)

string



perVertex(pv)

boolean



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

linear linear linear



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)

linear



Section radius for a torus volume. Applies only to torus.
Similar to the section radius in the torus modelling primitive.


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)

boolean



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)

linear linear linear



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)

string



Volume shape of the field. Sets/edits/queries the
field's volume shape attribute. If set to any value other
than "none", determines a 3D volume within which the field has effect.
Values are: "none," "cube," "sphere," "cylinder," "cone," "torus."


volumeSweep(vsw)

angle



Volume sweep of the field. Applies only to sphere, cone,
cylinder, and torus. Similar effect to the sweep attribute
in modelling.

