Go to: Synopsis. Return value. Related. Flags. Python examples.
radial(
selectionList
, [attenuation=float], [magnitude=float], [maxDistance=linear], [name=string], [perVertex=boolean], [position=[linear, linear, linear]], [torusSectionRadius=linear], [type=float], [volumeExclusion=boolean], [volumeOffset=[linear, linear, linear]], [volumeShape=string], [volumeSweep=angle])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
radial 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.
If fields are created, this command returns the names of each
owning shape and of the field shapes themselves. If a field was queried,
the results of the query are returned. If a field was edited, the field
name is returned.
If no object names are provided but the active selection list is non-empty,
the command creates a field for every object in the list. If the
list is empty, the command defaults to -pos 0 0 0.
A radial field pushes objects directly towards or directly away from it,
like a magnet.
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.
In query mode, return type is based on queried flag.
addDynamic, connectDynamic, particle
attenuation, magnitude, maxDistance, name, perVertex, position, torusSectionRadius, type, volumeExclusion, volumeOffset, volumeShape, volumeSweep
| Long name (short name) |
Argument types |
Properties |
|
attenuation(att)
|
float
|
 
|
|
Attentuation rate of field
|
|
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.
|
|
type(typ)
|
float
|
|
|
Type of radial field (0 - 1). This controls the algorithm by
which the field is attenuated. Type 1, provided for backward
compatibility, specifies the same algorithm as Alias |
Wavefront Dynamation. A value between 0 and 1 yields a linear blend.
|
|
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.
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
cmds.radial( 'particle1', m=5.0, mxd=2.0 )
# Creates a radial field with magnitude 5.0 and maximum distance 2.0,
# and adds it to the list of fields particle1 owns.
cmds.radial( pos=(2, 0, 4 ))
# Creates a radial field at position (0,2,4) in world coordinates,
# with default magnitude(1.0), attentuation (1.0),
# and max distance (5.0).
cmds.radial( 'radialField1', e=True, att=0.98 )
# Edits the attenuation value of the field named radialField1
cmds.radial( 'radialField1', q=True, m=True )
# Queries radialField1 for its magnitude.
cmds.radial( 'radialField1', e=True, mxd=10.0 )
# Changes the maximum distance of the field called
# "radialField1" to 10.0.
cmds.radial( m=2.0 )
# Creates a radial field with magnitude 2.0 for every active selection.
# If no there are active
# selections, creates such a field at world position (0,0,0).