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

Synopsis

layerButton [-annotation string] [-backgroundColor float float float] [-color float float float] [-command string] [-current boolean] [-defineTemplate string] [-docTag] [-doubleClickCommand string] [-dragCallback string] [-dropCallback string] [-edit] [-enable boolean] [-exists] [-height int] [-identification int] [-isObscured] [-label string] [-labelWidth] [-layerState string] [-layerVisible boolean] [-manage boolean] [-name string] [-numberOfPopupMenus] [-parent string] [-popupMenuArray] [-preventOverride boolean] [-query] [-renameCommand string] [-select boolean] [-transparent boolean] [-typeCommand string] [-useTemplate string] [-visible boolean] [-visibleCommand string] [-width int]

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.

Flags

annotation, backgroundColor, color, command, current, defineTemplate, docTag, doubleClickCommand, dragCallback, dropCallback, edit, enable, exists, height, identification, isObscured, label, labelWidth, layerState, layerVisible, manage, name, numberOfPopupMenus, parent, popupMenuArray, preventOverride, query, renameCommand, select, transparent, typeCommand, useTemplate, visible, visibleCommand, width
Long name (short name) [argument types] Properties
-query(-q) query
Puts the command in query mode so that it will return the value of the specified flag.

In query mode, this flag needs a value.
-edit(-e) edit
Puts the command in edit mode so that it will change the values of the specified flags
-exists(-ex) create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt) string create
Puts a 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.
-useTemplate(-ut) string create
Will force the command to use a command template other than the current one.
-parent(-p) string create
The parent layout for this control.
-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.

In query mode, this flag needs a value.
-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.

In query mode, this flag needs a value.
-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.

In query mode, this flag needs a value.
-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).

In query mode, this flag needs a value.
-isObscured(-io) 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.

In query mode, this flag needs a value.
-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.

In query mode, this flag needs a value.
-numberOfPopupMenus(-npm) query
Return the number of popup menus attached to this control.

In query mode, this flag needs a value.
-popupMenuArray(-pma) query
Return the names of all the popup menus attached to this control.

In query mode, this flag needs a value.
-preventOverride(-po) boolean createqueryedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.

In query mode, this flag needs a value.
-annotation(-ann) string createqueryedit
Annotate the control with an extra string value.

In query mode, this flag needs a value.
-backgroundColor(-bgc) float float float createedit
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. (Windows only flag)
-docTag(-dt) createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

In query mode, this flag needs a value.
-dragCallback(-dgc) string 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) string 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'")

-label(-l) string createqueryedit
Label text for the button.

In query mode, this flag needs a value.
-color(-cl) float float float createedit
Layer color, specified with normalized real numbers in R, G, B space.
-transparent(-t) boolean createqueryedit
Indicate whether the layer color is visible or transparent.

In query mode, this flag needs a value.
-layerState(-ls) string createqueryedit
Describes the state of the layer. This may be one of normal, template, or reference.

In query mode, this flag needs a value.
-layerVisible(-lv) boolean createqueryedit
Indicates whether the layer is visible or invisible.

In query mode, this flag needs a value.
-name(-n) string createquery
Name of the layer.

In query mode, this flag needs a value.
-identification(-id) int createqueryedit
This is the integer identification number associated with the layer.

In query mode, this flag needs a value.
-command(-c) string createedit
Set the command to call on a single click.
-doubleClickCommand(-dcc) string createedit
Set the command to call on a double click.
-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.
-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.
-select(-s) boolean createqueryedit
Set this button to display as a selected layer.

In query mode, this flag needs a value.
-labelWidth(-lw) 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.

In query mode, this flag needs a value.
-visibleCommand(-vc) string createedit
Command that is called when the visibility indicator of the layer button is pressed.
-typeCommand(-tc) string createedit
Command that is called when the type indicator of the layer button is pressed.
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 be used more than once in a command

Return value


[string] Full path name to the control. TiceControlBaseCmd.cpp

Related

createDisplayLayer, editDisplayLayerGlobals, editDisplayLayerMembers

MEL examples

window;
columnLayout;
// Create a button for the default layer, colour it red and select it
string $b = `layerButton -name "defaultLayer" -cl 1.0 0.0 0.0 -s true`;
showWindow;

// Find out how wide the layer buttons are when created
int $width = `layerButton -q -labelWidth $b`;