vortex is undoable, queryable, and editable.
For each listed object, the command creates a new field.
The field has a shape which lives in the DAG and it has an associated
dependency node. The field is added to the list of fields owned
by the object. Use connectDynamic to cause the field to affect a dynamic
object. Note that if more than one object is listed, a separate field is
created for each object.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
|
-attenuation(-att)
|
float
|
|
|
Attentuation rate of field
|
|
-axisX(-ax)
|
float
|
|
|
X-component of vortex axis
|
|
-axisY(-ay)
|
float
|
|
|
Y-component of vortex axis
|
|
-axisZ(-az)
|
float
|
|
|
Z-component of vortex axis
|
|
-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
|
|
|
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 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.
|
|
-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 3-D 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.
|
|