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

Synopsis

arclen( curve , [constructionHistory=boolean])

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

arclen is undoable, queryable, and editable.

This command returns the arclength of a curve if the history flag is not set (the default). If the history flag is set, a node is created that can produce the arclength, and is connected and its name returned. Having the construction history option on makes this command useful for expressions.

Return value

floatLength in non history mode
stringNode name, in history mode

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

Flags

constructionHistory
Long name (short name) Argument types Properties
constructionHistory(ch) boolean create
Turn the construction history on or off (where applicable)

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.arclen( 'curve1' )
# This command returns a float value that is the length of curve1 in
# the current linear units.

curveInfoNode = cmds.arclen('curve1', ch=True)
cmds.expression( s= 'surface1.sx = %s.arcLength' %  curveInfoNode )
# The first command produces a curve info node for curve1 and returns
# the name of the curve info node.  The second command shows how the
# arc length attribute of the curve info node can be used to set up
# an expression, ie. it drives one of the scale factors of surface1.
#
# Note the expression command still only creates MEL expressions, although they can
# be called from Python.