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

Synopsis

toolCollection( [string] , [clear=boolean], [collectionItemArray=boolean], [defineTemplate=string], [exists=boolean], [gl=boolean], [numberOfCollectionItems=boolean], [parent=string], [select=string], [useTemplate=string])

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

toolCollection is undoable, queryable, and editable.

This command creates a tool button collection. Collections are parented to the current default layout if no parent is specified with the -p/parent flag. As children of the layout they will be deleted when the layout is deleted. Collections may also span more than one window if the -gl/global flag is used. In this case the collection has no parent and must be explicitly deleted with the 'deleteUI' command when it is no longer wanted.

Return value

stringThe name of the toolCollection created.

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

Flags

clear, collectionItemArray, defineTemplate, exists, gl, numberOfCollectionItems, parent, select, useTemplate
Long name (short name) Argument types Properties
clear(cl)
2025
 boolean edit
Unselect all of the items in the collection.
collectionItemArray(cia) boolean query
Returns a string list giving the long names of all the items in this collection.
defineTemplate(dt) string create
Puts the command in a mode where any other flags and arguments are parsed and added to the command template specified in the argument. They will be used as default arguments in any subsequent invocations of the command when templateName is set as the current template.
exists(ex) boolean create
Returns whether the specified object exists or not. Other flags are ignored.
gl(gl) boolean createquery
Set the collection to have no parent layout. This flag must be specified when the collection is created and can not be queried or edited. Consequently, global collections must be explicitly deleted.
numberOfCollectionItems(nci) boolean query
Returns the number of items that are in this collection.
parent(p) string create
Specify the parent to associate the collection with. The collection will be deleted along with the parent. This flag must be specified when the collection is created and can not be edited.
select(sl) string createqueryedit
Select the specified collection item. If queried will return the name of the currently selected collection item.
useTemplate(ut) string create
Forces the command to use a command template other than the current one.
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.window()
cmds.columnLayout()
cmds.toolCollection()
cmds.toolButton( tool='selectSuperContext', toolImage1=('selectSuperContext', 'aselect.xpm') )
cmds.toolButton( tool='moveSuperContext', toolImage1=('moveSuperContext', 'move_M.png') )
cmds.toolButton( tool='scaleSuperContext', toolImage1=('scaleSuperContext', 'scale_M.png') )
cmds.showWindow()