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

Synopsis

percent( node [objects] , [addPercent=boolean], [dropoffAxis=[linear, linear, linear]], [dropoffCurve=string], [dropoffDistance=linear], [dropoffPosition=[linear, linear, linear]], [dropoffType=string], [multiplyPercent=boolean], [value=float])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

percent is undoable, queryable, and NOT editable.

This command sets percent values on members of a weighted node such as a cluster or a jointCluster. With no flags specified the command sets the percent value for selected components of the specified node to the specified percent value. A dropoff from the specified percent value to 0 can be specifed from a point, plane or curve using a dropoff distance around that shape. The percent value can also be added or multiplied with existing percent values of the node components.

Return value

None

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

Related

cluster, deformer, flexor, lattice, sculpt, wire, wrinkle

Flags

addPercent, dropoffAxis, dropoffCurve, dropoffDistance, dropoffPosition, dropoffType, multiplyPercent, value
Long name (short name) Argument types Properties
value(v) float createquery
The percent value to be applied. The default is 1. In query mode, returns an array of doubles corresponding to the weights of the selected object components.
dropoffPosition(dp) [linear, linear, linear] create
Specifies the point around which to dropoff the percent value.
dropoffAxis(dax) [linear, linear, linear] create
Specifies the axis along which to dropoff the percent value, starting from the dropoffPosition.
dropoffCurve(dc) string create
Specifies the curve around which to dropoff the percent value.
dropoffDistance(dds) linear create
Specifies the dropoff distance from the point, plane or curve that was specified using the -dp -dax or -dc flags.
dropoffType(dt) string create
Specifies the type of dropoff. Used in conjunction with the -dp, -dax or -dc flags. Default is linear. Valid values are: linear, sine, exponential, linearSquared, none.
addPercent(ap) boolean create
Add the percent value specified with the -v flag to the existing percent values
multiplyPercent(mp) boolean create
Multiply the percent value specified with the -v flag with existing percent values

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

# set percents on the selected items to 0.6
#
cmds.percent( 'cluster1', v=0.6 )

# set percents on the selected items dropping off along the
# z-axis starting at the origin. Dropoff distance is 5, and
# the initial value is 1. Dropoff type is linear.
#
cmds.percent( 'cluster1', dp=(0, 0, 0), dax=(0, 0, 1), dt='linear', dds=5, v=1 )

# set percents on the selected items dropping off along
# curve1. Dropoff distance is 5, and
# the initial value is 0.3.
#
cmds.percent( 'cluster2', dc='curve2', dds=3, v=0.3 )

# add 0.1 to the percents of the selected items
#
cmds.percent( 'cluster1', v=0.1, ap=True )