radial

Go to: Synopsis. Return value. Related. Flags. Python examples.

Synopsis

radial( selectionList , [attenuation=float], [magnitude=float], [maxDistance=linear], [name=string], [perVertex=boolean], [position=[linear, linear, linear]], [type=float])

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.

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.

Return value

In query mode, return type is based on queried flag.

Related

Flags

Long name (short name)	Argument types	Properties
attenuation(att)	float
Attentuation rate of field
magnitude(m)	float
Strength of field.
maxDistance(mxd)	linear
Maximum distance at which field is exerted. -1 indicates that the field has no maximum distance.
name(n)	string
name of field
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 where you want to place a field. The field 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.
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.

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.

Python examples

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