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

Synopsis

convertUnit( string , [fromUnit=boolean], [toUnit=boolean])

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

convertUnit is undoable, queryable, and editable.

This command converts values between different units of measure. The command takes a string, because a string can incorporate unit names as well as values (see examples).

Flags

fromUnit, toUnit
Long name (short name) [argument types] Properties
fromUnit(f) boolean create
The unit to convert from. If not supplied, it is assumed to be the system default. The from unit may also be supplied as part of the value e.g. 11.2m (11.2 meters).
toUnit(t) boolean create
The unit to convert to. If not supplied, it is assumed to be the system default
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.

Return value


float or string

Python examples

import maya.cmds as cmds

# Returns string "4.80315in", which is 12.2cm in inches.
cmds.convertUnit( '12.2', fromUnit='cm', toUnit='in' )

# Returns string "3.499563yd", which is 3.2m in yards.
cmds.convertUnit( '3.2m', toUnit='yard' )

# Returns float value 13.716, which is 5.4 inches in cm (default system units).
cmds.convertUnit( '5.4', fromUnit='inch' )