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

Synopsis

layerButton([annotation=string], [backgroundColor=[float, float, float]], [color=[float, float, float]], [command=script], [current=boolean], [defineTemplate=string], [docTag=string], [doubleClickCommand=script], [dragCallback=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [exists=boolean], [fullPathName=boolean], [height=int], [hideOnPlaybackCommand=script], [highlightColor=[float, float, float]], [identification=int], [isObscured=boolean], [label=string], [labelWidth=boolean], [layerHideOnPlayback=boolean], [layerState=string], [layerVisible=boolean], [manage=boolean], [name=string], [noBackground=boolean], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [preventOverride=boolean], [renameCommand=string], [select=boolean], [transparent=boolean], [typeCommand=script], [useTemplate=string], [visible=boolean], [visibleChangeCommand=script], [visibleCommand=script], [width=int])

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

layerButton is undoable, queryable, and editable.

Creates a layer bar button widget. This widget contains both the name of the layer to which it refers and a color swatch indicating it's color assignment. It is used primarily in the construction of the layerBar and layer Editor window, being the widget used for each layer in the respective lists.

Return value

stringFull path name to the control.

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

Related

createDisplayLayer, editDisplayLayerGlobals, editDisplayLayerMembers

Flags

annotation, backgroundColor, color, command, current, defineTemplate, docTag, doubleClickCommand, dragCallback, dropCallback, enable, enableBackground, exists, fullPathName, height, hideOnPlaybackCommand, highlightColor, identification, isObscured, label, labelWidth, layerHideOnPlayback, layerState, layerVisible, manage, name, noBackground, numberOfPopupMenus, parent, popupMenuArray, preventOverride, renameCommand, select, transparent, typeCommand, useTemplate, visible, visibleChangeCommand, visibleCommand, width
Long name (short name) Argument types Properties
annotation(ann) string createqueryedit
Annotate the control with an extra string value.
backgroundColor(bgc) [float, float, float] createqueryedit
The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
When setting backgroundColor, the background is automatically enabled, unless enableBackground is also specified with a false value.
color(cl) [float, float, float] createedit
Layer color, specified with normalized real numbers in R, G, B space.
command(c) script createedit
Set the command to call on a single click.
current(cr) boolean createedit
Set this button to display as the current layer. The current layer is the one which the user has the option of adding all newly created objects into. NB: Setting the layer button to this state has no effect on the actual current layer.
defineTemplate(dt) string create
Puts the command in a mode where any other flags and args 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.
docTag(dtg) string createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
doubleClickCommand(dcc) script createedit
Set the command to call on a double click.
dragCallback(dgc) script createedit
Adds a callback that is called when the middle mouse button is pressed. The MEL version of the callback is of the form:

global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods)

The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT.

In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form:

def callbackName( dragControl, x, y, modifiers ):

The values of these arguments are the same as those for the MEL version above.

The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys "dragControl", "x", "y", "modifiers". The "dragControl" value is a string and the other values are integers (eg the callback string could be "print '%(dragControl)s %(x)d %(y)d %(modifiers)d'")

dropCallback(dpc) script createedit
Adds a callback that is called when a drag and drop operation is released above the drop site. The MEL version of the callback is of the form:

global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type)

The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link.

In Python, it is similar, but there are two ways to specify the callback. The recommended way is to pass a Python function object as the argument. In that case, the Python callback should have the form:

def pythonDropTest( dragControl, dropControl, messages, x, y, dragType ):

The values of these arguments are the same as those for the MEL version above.

The other way to specify the callback in Python is to specify a string to be executed. In that case, the string will have the values substituted into it via the standard Python format operator. The format values are passed in a dictionary with the keys "dragControl", "dropControl", "messages", "x", "y", "type". The "dragControl" value is a string and the other values are integers (eg the callback string could be "print '%(dragControl)s %(dropControl)s %(messages)r %(x)d %(y)d %(type)d'")

enable(en) boolean createqueryedit
The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
enableBackground(ebg) boolean createqueryedit
Enables the background color of the control.
exists(ex) boolean create
Returns whether the specified object exists or not. Other flags are ignored.
fullPathName(fpn) boolean query
Return the full path name of the widget, which includes all the parents
height(h) int createqueryedit
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
hideOnPlaybackCommand(hpc) script createedit
Command that is called when the hide on playback indicator of the layer button is pressed.
highlightColor(hlc) [float, float, float] createqueryedit
The highlight color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0.
identification(id) int createqueryedit
This is the integer identification number associated with the layer.
isObscured(io) boolean query
Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's window is invisible or iconified.
label(l) string createqueryedit
Label text for the button.
labelWidth(lw) boolean query
Query the width of the label part so as to determine if button clicks are in the label part or the colour swatch part.
layerHideOnPlayback(hp) boolean createqueryedit
Indicates whether the layer is visible or invisible during the playback.
layerState(ls) string createqueryedit
Describes the state of the layer. This may be one of normal, template, or reference.
layerVisible(lv) boolean createqueryedit
Indicates whether the layer is visible or invisible.
manage(m) boolean createqueryedit
Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
name(n) string createquery
Name of the layer.
noBackground(nbg) boolean createedit
Clear/reset the control's background. Passing true means the background should not be drawn at all, false means the background should be drawn. The state of this flag is inherited by children of this control.
numberOfPopupMenus(npm) boolean query
Return the number of popup menus attached to this control.
parent(p) string createquery
The parent layout for this control.
popupMenuArray(pma) boolean query
Return the names of all the popup menus attached to this control.
preventOverride(po) boolean createqueryedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
renameCommand(rc) string createedit
Set the command to call when the layer gets renamed. The string '#1' will be substituted with the control's name and '#2' will be replaced with the layer's new name.
select(s) boolean createqueryedit
Set this button to display as a selected layer.
transparent(t) boolean createqueryedit
Indicate whether the layer color is visible or transparent.
typeCommand(tc) script createedit
Command that is called when the type indicator of the layer button is pressed.
useTemplate(ut) string create
Force the command to use a command template other than the current one.
visible(vis) boolean createqueryedit
The visible state of the control. A control is created visible by default. Note that a control's actual appearance is also dependent on the visible state of its parent layout(s).
visibleChangeCommand(vcc) script createqueryedit
Command that gets executed when visible state of the control changes.
visibleCommand(vc) script createedit
Command that is called when the visibility indicator of the layer button is pressed.
width(w) int createqueryedit
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
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()
# Create a button for the default layer, colour it red and select it
b = cmds.layerButton(name='defaultLayer', cl=(1.0, 0.0, 0.0), s=True)
cmds.showWindow()

# Find out how wide the layer buttons are when created
width = cmds.layerButton(b ,q=True, labelWidth=True )