Autodesk Maya

https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/
Admin
Autodesk Maya is a professional 3D computer graphics software for modeling, animation, simulation,...
Tokens:5,284,506
Snippets:36,916
Trust Score:9.7
Update:4 days ago
Show doc for...
Tokens:
Raw
### mayaHasRenderSetup Python Examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/mayaHasRenderSetup.html

Examples demonstrating how to query and edit the render setup state using the mayaHasRenderSetup command.

```python
import maya.cmds as cmds


#Returns whether render setup mode is enabled or disabled
cmds.mayaHasRenderSetup()

#Query the state renderSetupEnableDuringTests
cmds.mayaHasRenderSetup(query = True, enableCurrentSession = True)

#Query the state renderSetupEnableDuringTests
cmds.mayaHasRenderSetup(query = True, enableDuringTests = True)

#Enable renderSetupEnableCurrentSession
cmds.mayaHasRenderSetup(edit = True, enableCurrentSession = True)

#Disable renderSetupEnableCurrentSession
cmds.mayaHasRenderSetup(edit = True, enableCurrentSession = False)

#Enable enableDuringTests
cmds.mayaHasRenderSetup(edit = True, enableDuringTests = True)

#Disable enableDuringTests
cmds.mayaHasRenderSetup(edit = True, enableDuringTests = False)
```

--------------------------------

### MEL examples for mayaHasRenderSetup

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/mayaHasRenderSetup.html

Examples demonstrating how to query and edit the render setup states using the mayaHasRenderSetup command in MEL.

```MEL
//Returns whether render setup mode is enabled or disabled
mayaHasRenderSetup

//Query the state renderSetupEnableCurrentSession
mayaHasRenderSetup -query -enableCurrentSession

//Query the state renderSetupEnableDuringTests
mayaHasRenderSetup -query -enableDuringTests

//Enable renderSetupEnableCurrentSession
mayaHasRenderSetup -edit -enableCurrentSession true

//Disable renderSetupEnableCurrentSession
mayaHasRenderSetup -edit -enableCurrentSession false

//Enable renderSetupEnableDuringTests
mayaHasRenderSetup -edit -enableDuringTests true

//Disable renderSetupEnableDuringTests
mayaHasRenderSetup -edit -enableDuringTests false
```

--------------------------------

### partition Command Examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/partition.html

Examples demonstrating how to create partitions, add or remove sets, and query partition properties using maya.cmds.

```python
import maya.cmds as cmds

# To create a partition calls p1 which contains set1 and set2 ...
cmds.partition( 'set1', 'set2', n='p1' )

# To create an empty render partition ...
cmds.partition( render=True )

# To add/remove sets from partition p1 ...
cmds.partition( 'set3', add='p1' )
cmds.partition( 'set1', rm='p1' )

# To get a list of all sets in a partition ...
cmds.partition( 'p1', q=True )

# To check if the partition is a render partition
cmds.partition( 'p1', q=True, re=True )
```

--------------------------------

### Python: Basic timer usage and named timers for nesting

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/timer.html

Demonstrates cmds.timer with start (s=True) and end (e=True) flags, and shows how named timers enable nesting. The example times a loop and uses lapTime to get intermediate times.

```Python
import maya.cmds as cmds


cmds.timer( s=True )
# code being timed
print "START: time this"
for i in range (0, 50):
	print ("time this "+str(i))
print "END: time this"
cmds.timer( e=True )

# Named timers can be used for nesting
cmds.timer( s=True, name="outerLoop" )
print "START: macro loop timing"
for i in range(0,50):
	cmds.timer( s=True )
	for j in range(5,50):
		newObjs = cmds.sphere( spans=j )
		cmds.delete( newObjs )
	innerTime = cmds.timer( e=True )
	lapTime = cmds.timer( lap=True, name="outerLoop" )
	print "\tInner loop %d = %g" % (i, innerTime)
	print "\t       SUB = %g" % lapTime
fullTime = cmds.timer( e=True, name="outerLoop" )
print "END: Full timing was %g" % fullTime

```

--------------------------------

### nBase Python examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/nBase.html

Python examples using maya.cmds.nBase to stuff start state, clear start state, and transfer texture map data on nCloth1.

```python
import maya.cmds as cmds

# Stuff the current positions and velocities into nCloth1's startPositions and
# startVelocities.
#
cmds.nBase( 'nCloth1', e=True, stuffStart=True )

# Clear nCloth1's startPositions and startVelocities.
#
cmds.nBase( 'nCloth1', e=True, clearStart=True )

# Transfer the texture map data for the thicknessMap attribute into the
# thicknessPerVertex attribute.
#
cmds.nBase( 'nCloth1', e=True, textureToVertex='thicknessMap' )
```

--------------------------------

### Initialize and configure iprEngine

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/iprEngine.html

Demonstrates creating an iprEngine, defining an update region, and starting the tuning process to watch for changes.

```python
import maya.cmds as cmds

# Create a iprEngine and tell it about an already created ipr image.
cmds.iprEngine(ipr='iprImages/persp_scene1_ipr.iff')

# Tell the iprEngine about the region to update.
cmds.iprEngine( 'iprEngine1', e=True, region=(10, 10, 100, 100))

# Tell the iprEngine to watch changes and update pixels.
cmds.iprEngine( 'iprEngine1', e=True, startTuning=True )
```

--------------------------------

### Python example: Using hitTest in a drop callback

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/hitTest.html

Shows how to call cmds.hitTest with a dropControl and coordinates (x, y) inside a drop callback to get DAG objects underneath the drop-point. The example attaches the callback to a model editor's control using cmds.control with the dropCallback edit flag, and wraps the setup in a try/except RuntimeError to handle missing editor or control.

```Python
import maya.cmds as cmds

#    Let's say that you have the name of a model editor that was
#    created elsewhere.
#
editor = "MyModelEditor"

#    Here's your drop callback:
#
def myModelEditorDropCallback( dragControl,
							   dropControl,
							   msgs,
							   x,
							   y,
							   type ):
	#	Inside the callback we can hit-test the (x,y) drop-point
	#	against the control. This will return a list of DAG objects
	#	underneath the drop-point.
	#
	objects = cmds.hitTest( dropControl, x, y )
	if len( objects ):
		#	The hit-test returned something. You can now do something
		#	with these objects.
		pass

#
#	Attach a drop callback to this model editor.
#
try:
	control = cmds.editor( editor ,query=True, control=True )
	if cmds.control( control, exists=True ):
		cmds.control( control, edit=True, dropCallback=myModelEditorDropCallback )
except RuntimeError:
	pass
```

--------------------------------

### Create and configure a cameraSet

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/cameraSet.html

This example demonstrates creating objects, setting up a stereo camera rig, and adding them to a new cameraSet node.

```python
import maya.cmds as cmds

# create some objects
cmds.sphere(n='sphere1')
cmds.cone(n='cone1')

# create a set with whatever is currently active
cmds.select( 'sphere1', 'cone1')
newSet2 = cmds.sets()

cmds.loadPlugin( "stereoCamera", qt=True )
from maya.app.stereo import stereoCameraRig
rig = stereoCameraRig.createStereoCameraRig('StereoCamera')

# Create a new cameraSet node.
cmds.cameraSet()

# Add the cam & object set to the set
cmds.cameraSet( 'cameraSet1', edit=True, appendTo=True, cam=rig[0], objectSet=newSet2 )
```

--------------------------------

### polyInstallAction MEL Examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/polyInstallAction.html

Various examples demonstrating how to install and uninstall constraints and display attributes using polyInstallAction.

```MEL
// Will set pickmask to edges, install internal constraint
// so that only border edges may be selected.
polyInstallAction -ic polyCloseBorder;

// Same as previous, plus force the display of borders if the
// user didn't asked explicitely for it before.
polyInstallAction -ic -id polyCloseBorder;

// Shortcut for polyInstallAction -ic -id polyCloseBorder;
polyInstallAction polyCloseBorder;

// Assuming the previous install was for closeBorder,
// will release internal border constraint, but go on displaying
// borders if the user didn't asked explicitely for it before.
polyInstallAction -uc;

// Assuming the previous install was for closeBorder,
// will release internal border constraint, stop displaying
// borders if the user didn't asked explicitely for it before.
polyInstallAction -uc -ud;

// Shortcut for polyInstallAction -uc -ud;
polyInstallAction;
```

--------------------------------

### Create and configure a cameraSet

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/cameraSet.html

This example demonstrates creating objects, setting up a stereo camera rig, and adding them to a new cameraSet.

```MEL
// create some objects
sphere -n sphere1;
cone -n cone1;

// create a set with whatever is currently active
select sphere1 cone1;
string $newSet2 = `sets`;

loadPlugin -qt "stereoCamera";
python("from maya.app.stereo import stereoCameraRig")
string $rig[] = python("stereoCameraRig.createStereoCameraRig('StereoCamera')")

// create a cameraSet
cameraSet ;
// cameraSet1

// add the cam & object set to the set
cameraSet -e -appendTo -cam $rig[0] -objectSet $newSet2 cameraSet1;
```

--------------------------------

### MEL partition command examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/partition.html

Examples demonstrating how to create partitions, add or remove sets, and query partition information using MEL.

```MEL
// To create a partition called p1 which contains set1 and set2 ...
partition -n "p1" set1 set2;

// To create an empty render partition ...
partition -render;

// To add/remove sets from partition p1 ...
partition -add p1 set3;
partition -rm p1 set1;

// To get a list of all sets in a partition ...
partition -q p1;

// To check if the partition is a render partition
partition -q -re p1;
```

--------------------------------

### Create a Window with Menus

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/menu.html

This example demonstrates how to create a window with a menu bar containing a 'File' menu with items and a 'Help' menu.

```MEL
window -menuBar true -width 200;
menu -label "File" -tearOff true;
    menuItem -label "New";
    menuItem -label "Open";
    menuItem -label "Save";
    menuItem -divider true;
    menuItem -label "Quit";
menu -label "Help" -helpMenu true;
    menuItem -label "About Application...";
columnLayout;
    button; button; button;
showWindow;
```

--------------------------------

### timer

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/timer.html

Starts, stops, or gets lap time for a timer. Use startTimer to begin, endTimer to stop and get elapsed time, and lapTime to get elapsed time without stopping.

```APIDOC
## timer

### Description
Starts, stops, or gets lap time for a timer. Use startTimer to begin, endTimer to stop and get elapsed time, and lapTime to get elapsed time without stopping.

### Method
Python command

### Signature
`timer([endTimer=boolean], [lapTime=boolean], [name=string], [startTimer=boolean])`

### Parameters
- **endTimer** (boolean) - Optional - Stop the timer and return the time elapsed since the timer was started (in seconds). Once a timer is turned off it no longer exists, though it can be recreated with a new start.
- **lapTime** (boolean) - Optional - Get the lap time of the timer (time elapsed since start in seconds). Unlike the end flag this keeps the timer running.
- **name** (string) - Optional - Use a named timer for the operation. If this is omitted then the default timer is assumed.
- **startTimer** (boolean) - Optional - Start the timer.

### Return Value
None

### Notes
- The command is not undoable, not queryable, and not editable.
- The resolution is at the level of the OS's gettimeofday() function.
- This command does not handle stacked calls. For example, the following code will give an incorrect answer on the second timer -e call:
  ```
  timer -s;
  timer -s;
  timer -e;
  timer -e;
  ```
- The -e flag or -lap flag return the time elapsed since the last 'timer -s' call.
- The -s flag has no return value.

### Python Example
```python
import maya.cmds as cmds

cmds.timer( s=True )
# code being timed
print "START: time this"
for i in range (0, 50):
	print ("time this "+str(i))
print "END: time this"
cmds.timer( e=True )

# Named timers can be used for nesting
cmds.timer( s=True, name="outerLoop" )
print "START: macro loop timing"
for i in range(0,50):
	cmds.timer( s=True )
	for j in range(5,50):
		newObjs = cmds.sphere( spans=j )
		cmds.delete( newObjs )
	innerTime = cmds.timer( e=True )
	lapTime = cmds.timer( lap=True, name="outerLoop" )
	print "\tInner loop %d = %g" % (i, innerTime)
	print "\t       SUB = %g" % lapTime
fullTime = cmds.timer( e=True, name="outerLoop" )
print "END: Full timing was %g" % fullTime
```
```

--------------------------------

### Create a window with File and Help menus using cmds.menu

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/menu.html

This example creates a window with a menu bar, adds a File menu with menu items (New, Open, Save, Quit) and a divider, adds a Help menu with an About item, and then adds a column layout with three buttons before showing the window. It uses cmds.window, cmds.menu, cmds.menuItem, cmds.columnLayout, cmds.button, and cmds.showWindow.

```Python
import maya.cmds as cmds

cmds.window( menuBar=True, width=200 )
cmds.menu( label='File', tearOff=True )
cmds.menuItem( label='New' )
cmds.menuItem( label='Open' )
cmds.menuItem( label='Save' )
cmds.menuItem( divider=True )
cmds.menuItem( label='Quit' )
cmds.menu( label='Help', helpMenu=True )
cmds.menuItem( 'Application..."', label='"About' )
cmds.columnLayout()
cmds.button()
cmds.button()
cmds.button()
cmds.showWindow()

```

--------------------------------

### MEL examples for arclen

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/arclen.html

Examples showing how to get the length of a curve directly or by creating a curve info node for use in expressions.

```mel
arclen curve1;
// This command returns a float value that is the length of curve1 in
// the current linear units.

string $curveInfoNode = `arclen -ch on curve1`;
expression -s ("surface1.sx = " + $curveInfoNode + ".arcLength");
// 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.
```

--------------------------------

### Python examples for mlDeformer command

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/mlDeformer.html

Shows how to use the mlDeformer command to reload models and get vertex deltas. The first example reloads model 0 on mlDeformer1, the second reloads all models, and the third gets surface vertex deltas for index 0.

```python
import maya.cmds as cmds

# Reload model 0 on the mlDeformer1 node.
cmds.mlDeformer("mlDeformer1", multiIndex=0, reloadModel=True)

# Reload all models on the mlDeformer1 node.
cmds.mlDeformer("mlDeformer1", reloadModel=True)

# Get the surface vertex deltas for index 0 on the mlDeformer1 node.
cmds.mlDeformer("mlDeformer1", multiIndex=0, vertexDeltas="dbs")
```

--------------------------------

### MEL instance command examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/instance.html

Examples demonstrating hierarchy creation, basic instancing, leaf-level instancing, and smart transformation usage.

```mel
  // Create a hierarchy
  sphere -n sphere1; move 3 0 0;
  sphere -n sphere2; move -3 0 0;
  group -n group1 sphere1 sphere2;
  group -n group2 group1;

  // Create an instance of one of the spheres
instance sphere1;

  // Duplicate the hierarchy except for the shapes which are
  // instanced.instances of all leaf level shapes
instance -leaf group1;

  // Create a row of 4 instanced circles which are equally spaced
  circle -n circle1;
  instance; move 3 0 0;
  instance -smartTransform;
  instance -smartTransform;
```

--------------------------------

### nBase MEL Examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/nBase.html

Examples demonstrating how to use the nBase command to manipulate start states and transfer texture map data for nCloth objects.

```MEL
// Stuff the current positions and velocities into nCloth1's startPositions and
// startVelocities.
//
nBase -e -stuffStart nCloth1;

// Clear nCloth1's startPositions and startVelocities.
//
nBase -e -clearStart nCloth1;

// Transfer the texture map data for the thicknessMap attribute into the
// thicknessPerVertex attribute.
//
nBase -e -textureToVertex thicknessMap nCloth1;
```

--------------------------------

### MEL Examples for applyTake

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/applyTake.html

Examples demonstrating how to apply recorded data, specify devices and start times, use filters, and target specific channels.

```mel
//    Apply all of the recorded data to param curves.
applyTake;

//    Applies the takes from clock and ultra devices and starts the
//    data at anim time 100.
applyTake -d clock -d ultra -st 100;

//    Applies the take from the ultra device and uses the euler and
//    simplify filters.
applyTake -d ultra -f euler -f simplify;

//    Applies only the shoulder channel and all of its children.
applyTake -d ultra -c shoulder -sc -rc;
```

--------------------------------

### Query and Set Render Partition

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/renderPartition.html

Examples showing how to query the current render partition and how to set a new one using the renderPartition command.

```python
import maya.cmds as cmds

# Query the current render partition
cmds.renderPartition( q=True )

# Set the current render partition to "foofoo"
cmds.renderPartition( 'foofoo' )
```

--------------------------------

### polyInstallAction Python usage examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/polyInstallAction.html

Various examples demonstrating how to install and uninstall constraints and display attributes for polygon actions using the maya.cmds module.

```python
import maya.cmds as cmds

# Will set pickmask to edges, install internal constraint
# so that only border edges may be selected.
cmds.polyInstallAction( 'polyCloseBorder', ic=True )

# Same as previous, plus force the display of borders if the
# user didn't asked explicitely for it before.
cmds.polyInstallAction( 'polyCloseBorder', ic=True, id=True )

# Shortcut for polyInstallAction -ic -id polyCloseBorder;
cmds.polyInstallAction( 'polyCloseBorder' )

# Assuming the previous install was for closeBorder,
# will release internal border constraint, but go on displaying
# borders if the user didn't asked explicitely for it before.
cmds.polyInstallAction( uc=True )

# Assuming the previous install was for closeBorder,
# will release internal border constraint, stop displaying
# borders if the user didn't asked explicitely for it before.
cmds.polyInstallAction( uc=True, ud=True )

# Shortcut for polyInstallAction -uc -ud;
cmds.polyInstallAction()
```

--------------------------------

### bluePencilNode Python examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/bluePencilNode.html

Examples demonstrating how to refresh the node, check for its existence, query the active camera, and create a new node with specific layer settings.

```python
import maya.cmds as cmds

# Refresh node.
cmds.bluePencilNode(r=True)

# Check if blue pencil node exists.
cmds.bluePencilNode(exists=True)

# Get the active camera name.
cmds.bluePencilNode(q=True, camera=True)

# Create a new node.
cmds.bluePencilNode(layer=True, c=CameraName, ln=LayerName, ls=1, f=True)
```

--------------------------------

### Create a device panel in a window

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/CommandsPython/devicePanel.html

This example demonstrates how to initialize a new window, set up a pane layout, and instantiate a device panel within it.

```python
import maya.cmds as cmds

# This example creates a new device panel in its own window
window = cmds.window()
cmds.paneLayout()
cmds.devicePanel()
cmds.showWindow( window )
```

--------------------------------

### MEL extendCurve usage examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/extendCurve.html

Examples demonstrating how to extend the start of a curve by a specific distance and how to extend the end of a curve to a specific point using MEL.

```mel
// to extend the start of a curve with a line of distance 3
extendCurve -em 0 -et 0 -s true -d 3.0;

// to extend the end of a curve to a point
extendCurve -em 2 -s false -ip 1 2 3;
```

--------------------------------

### MEL shot command examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/shot.html

Examples demonstrating how to create a shot, modify its duration using start and end times, apply holds, and query shot properties.

```mel
// Create a shot, modify it's length, and add some holds
string $shot = `shot myShot`;
shot -e -startTime 10 -endTime 19 $shot;
shot -e -sequenceStartTime 100 -sequenceEndTime -109 $shot;
shot -q -startTime $shot;
// Result: 10 //

shot -q -sequenceStartTime $shot;
// Result: 100 //

shot -e -postHoldTime 10 $shot;
shot -q -sequenceEndTime $shot;
// Result: 119 //

shot -e -preHoldTime 5 $shot;
shot -q -sequenceEndTime $shot;
// Result: 124 //

shot -q -sequenceDuration $shot
// Result: 25 //
```

--------------------------------

### MEL Examples for makeLive

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/makeLive.html

Various examples demonstrating how to set live objects, manage the registry, and query live object states using MEL.

```MEL
// get the registry size
makeLive -q -registrySize;

// set surface1 as the live object
makeLive surface1;

// make surface1 the dormant object
makeLive -none;

// make both surface1 and surface2 the live objects.
makeLive surface1 surface2

// Get the active number of registry entries and the stored collection
int $nbReg = `makeLive -q -registryCount`;
for ($i = 0; $i < $nbReg; $i++) {
	string $liveObjs[] = `makeLive -q -registry $i`;
	print $liveObjs;
	print "\n";
}

// make live the objects collection stored in registry entry 1
makeLive -registry 1;

// clears all the registry and reset the data stucture to the defaults.
makeLive -registryReset

// add both surface1 and surface2 to the registry list that is currently live
makeLive -addObjects surface1 surface2

// remove surface1 from the registry list that is currently live
makeLive -removeObjects surface1
```

--------------------------------

### fluidCacheInfo MEL examples

Source: https://help.autodesk.com/cloudhelp/2025/ENU/Maya-Tech-Docs/Commands/fluidCacheInfo.html

Examples demonstrating how to query start frames, resolution, end frames, and data availability for Initial Conditions and Playback caches using MEL.

```mel
// get start frame for Initial Conditions Cache
fluidCacheInfo -ic -sf;

// get resolution for Initial Conditions Cache
fluidCacheInfo -ic -re;

// get end frame for Playback Cache
fluidCacheInfo -pb -ef;

// get resolution for Playback Cache
fluidCacheInfo -pb -re;

// Is there data for any of the valid properties
// in the playback cache?
fluidCacheInfo -pb -hd;

// Is there density data in the playback cache?
fluidCacheInfo -at density -pb -hd;
```
Tokens:
Raw