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


partition( [string] [string...] , [addSet=name], [name=string], [removeSet=name], [render=boolean])

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

partition is undoable, queryable, and editable.

This command is used to create, query or add/remove sets to a partition. If a partition name needs to be specified, it is the first argument, other arguments represent the set names.

Without any flags, the command will create a partition with a default name. Any sets which are arguments to the command will be added to the partition.

A set can be added to a partition only if none of its members are in any of the other sets in the partition. If the -re/render flag is specified when the partition is created, only 'renderable' sets can be added to the partition.

Sets can be added and removed from a partition by using the -addSet or -removeSet flags.

Note: If a set is already selected, and the partition command is executed, the set will be added to the created partition.

Return value

stringName of the partition that was created or edited

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


character, sets


addSet, name, removeSet, render
Long name (short name) Argument types Properties
name(n) string create
Assigns the given name to new partition. Valid only for create mode.
render(re) boolean createquery
New partition can contain render sets. For use in creation mode only. Default is false. Can also be used with query flag - returns boolean.
addSet(add) name create
Adds the list of sets to the named partition.
removeSet(rm) name create
Removes the list of sets from the named partition.

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

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