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

Synopsis

floatSliderButtonGrp( [name] , [adjustableColumn=int], [adjustableColumn2=int], [adjustableColumn3=int], [adjustableColumn4=int], [adjustableColumn5=int], [adjustableColumn6=int], [annotation=string], [backgroundColor=[float, float, float]], [buttonCommand=script], [buttonLabel=string], [changeCommand=script], [columnAlign=[int, string]], [columnAlign2=[string, string]], [columnAlign3=[string, string, string]], [columnAlign4=[string, string, string, string]], [columnAlign5=[string, string, string, string, string]], [columnAlign6=[string, string, string, string, string, string]], [columnAttach=[int, string, int]], [columnAttach2=[string, string]], [columnAttach3=[string, string, string]], [columnAttach4=[string, string, string, string]], [columnAttach5=[string, string, string, string, string]], [columnAttach6=[string, string, string, string, string, string]], [columnOffset2=[int, int]], [columnOffset3=[int, int, int]], [columnOffset4=[int, int, int, int]], [columnOffset5=[int, int, int, int, int]], [columnOffset6=[int, int, int, int, int, int]], [columnWidth=[int, int]], [columnWidth1=int], [columnWidth2=[int, int]], [columnWidth3=[int, int, int]], [columnWidth4=[int, int, int, int]], [columnWidth5=[int, int, int, int, int]], [columnWidth6=[int, int, int, int, int, int]], [defineTemplate=string], [docTag=string], [dragCallback=script], [dragCommand=script], [dropCallback=script], [enable=boolean], [enableBackground=boolean], [enableKeyboardFocus=boolean], [exists=boolean], [extraLabel=string], [field=boolean], [fieldMaxValue=float], [fieldMinValue=float], [fieldStep=float], [fullPathName=boolean], [height=int], [highlightColor=[float, float, float]], [image=string], [isObscured=boolean], [label=string], [manage=boolean], [maxValue=float], [minValue=float], [noBackground=boolean], [numberOfPopupMenus=boolean], [parent=string], [popupMenuArray=boolean], [precision=int], [preventOverride=boolean], [rowAttach=[int, string, int]], [sliderStep=float], [statusBarMessage=string], [step=float], [symbolButtonCommand=script], [symbolButtonDisplay=boolean], [useTemplate=string], [value=float], [visible=boolean], [visibleChangeCommand=script], [width=int])

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

floatSliderButtonGrp is undoable, queryable, and editable.

All of the group commands position their individual controls in columns starting at column 1. The layout of each control (ie. column) can be customized using the -cw/columnWidth, -co/columnOffset, -cat/columnAttach, -cal/columnAlign, and -adj/adjustableColumn flags. By default, columns are left aligned with no offset and are 100 pixels wide. Only one column in any group can be adjustable.

This command creates a float slider component with optional button and symbol buttons.

TelfFloatSliderGrpCmd.cpp

Return value

stringFull path name to the control.

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

Flags

adjustableColumn, adjustableColumn2, adjustableColumn3, adjustableColumn4, adjustableColumn5, adjustableColumn6, annotation, backgroundColor, buttonCommand, buttonLabel, changeCommand, columnAlign, columnAlign2, columnAlign3, columnAlign4, columnAlign5, columnAlign6, columnAttach, columnAttach2, columnAttach3, columnAttach4, columnAttach5, columnAttach6, columnOffset2, columnOffset3, columnOffset4, columnOffset5, columnOffset6, columnWidth, columnWidth1, columnWidth2, columnWidth3, columnWidth4, columnWidth5, columnWidth6, defineTemplate, docTag, dragCallback, dragCommand, dropCallback, enable, enableBackground, enableKeyboardFocus, exists, extraLabel, field, fieldMaxValue, fieldMinValue, fieldStep, fullPathName, height, highlightColor, image, isObscured, label, manage, maxValue, minValue, noBackground, numberOfPopupMenus, parent, popupMenuArray, precision, preventOverride, rowAttach, sliderStep, statusBarMessage, step, symbolButtonCommand, symbolButtonDisplay, useTemplate, value, visible, visibleChangeCommand, width
Long name (short name) Argument types Properties
adjustableColumn(adj) int createedit
Specifies which column has an adjustable size that changes with the sizing of the layout. The column value is a 1-based index. Passing 0 as argument turns off the previous adjustable column.
adjustableColumn2(ad2) int createedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly two columns.
adjustableColumn3(ad3) int createedit
Specifies that the column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly three columns.
adjustableColumn4(ad4) int createedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly four columns.
adjustableColumn5(ad5) int createedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly five columns.
adjustableColumn6(ad6) int createedit
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there are not exactly six columns.
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.
buttonCommand(bc) script createedit
Command string to be executed when the button is pressed.
buttonLabel(bl) string createqueryedit
The button text.
changeCommand(cc) script createedit
Command string executed when the value of the slider changes. It will be executed only once after a drag of the slider.
columnAlign(cal) [int, string] createeditmultiuse
Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type for the specified column.
columnAlign2(cl2) [string, string] createedit
Sets the text alignment of both columns. Ignored if there are not exactly two columns. Valid values are "left", "right", and "center".
columnAlign3(cl3) [string, string, string] createedit
Sets the text alignment for all three columns. Ignored if there are not exactly three columns. Valid values are "left", "right", and "center".
columnAlign4(cl4) [string, string, string, string] createedit
Sets the text alignment for all four columns. Ignored if there are not exactly four columns. Valid values are "left", "right", and "center".
columnAlign5(cl5) [string, string, string, string, string] createedit
Sets the text alignment for all five columns. Ignored if there are not exactly five columns. Valid values are "left", "right", and "center".
columnAlign6(cl6) [string, string, string, string, string, string] createedit
Sets the text alignment for all six columns. Ignored if there are not exactly six columns. Valid values are "left", "right", and "center".
columnAttach(cat) [int, string, int] createeditmultiuse
Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies column attachment types and offets.
columnAttach2(ct2) [string, string] createedit
Sets the attachment type of both columns. Ignored if there are not exactly two columns. Valid values are "left", "right", and "both".
columnAttach3(ct3) [string, string, string] createedit
Sets the attachment type for all three columns. Ignored if there are not exactly three columns. Valid values are "left", "right", and "both".
columnAttach4(ct4) [string, string, string, string] createedit
Sets the attachment type for all four columns. Ignored if there are not exactly four columns. Valid values are "left", "right", and "both".
columnAttach5(ct5) [string, string, string, string, string] createedit
Sets the attachment type for all five columns. Ignored if there are not exactly five columns. Valid values are "left", "right", and "both".
columnAttach6(ct6) [string, string, string, string, string, string] createedit
Sets the attachment type for all six columns. Ignored if there are not exactly six columns. Valid values are "left", "right", and "both".
columnOffset2(co2) [int, int] createedit
This flag is used in conjunction with the -columnAttach2 flag. If that flag is not used then this flag will be ignored. It sets the offset for the two columns. The offsets applied are based on the attachments specified with the -columnAttach2 flag. Ignored if there are not exactly two columns.
columnOffset3(co3) [int, int, int] createedit
This flag is used in conjunction with the -columnAttach3 flag. If that flag is not used then this flag will be ignored. It sets the offset for the three columns. The offsets applied are based on the attachments specified with the -columnAttach3 flag. Ignored if there are not exactly three columns.
columnOffset4(co4) [int, int, int, int] createedit
This flag is used in conjunction with the -columnAttach4 flag. If that flag is not used then this flag will be ignored. It sets the offset for the four columns. The offsets applied are based on the attachments specified with the -columnAttach4 flag. Ignored if there are not exactly four columns.
columnOffset5(co5) [int, int, int, int, int] createedit
This flag is used in conjunction with the -columnAttach5 flag. If that flag is not used then this flag will be ignored. It sets the offset for the five columns. The offsets applied are based on the attachments specified with the -columnAttach5 flag. Ignored if there are not exactly five columns.
columnOffset6(co6) [int, int, int, int, int, int] createedit
This flag is used in conjunction with the -columnAttach6 flag. If that flag is not used then this flag will be ignored. It sets the offset for the six columns. The offsets applied are based on the attachments specified with the -columnAttach6 flag. Ignored if there are not exactly six columns.
columnWidth(cw) [int, int] createeditmultiuse
Arguments are : column number, column width. Sets the width of the specified column where the first parameter specifies the column (1 based index) and the second parameter specifies the width.
columnWidth1(cw1) int createedit
Sets the width of the first column. Ignored if there is not exactly one column.
columnWidth2(cw2) [int, int] createedit
Sets the column widths of both columns. Ignored if there are not exactly two columns.
columnWidth3(cw3) [int, int, int] createedit
Sets the column widths for all 3 columns. Ignored if there are not exactly 3 columns.
columnWidth4(cw4) [int, int, int, int] createedit
Sets the column widths for all 4 columns. Ignored if there are not exactly 4 columns.
columnWidth5(cw5) [int, int, int, int, int] createedit
Sets the column widths for all 5 columns. Ignored if there are not exactly 5 columns.
columnWidth6(cw6) [int, int, int, int, int, int] createedit
Sets the column widths for all 6 columns. Ignored if there are not exactly 6 columns.
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.
docTag(dtg) string createqueryedit
Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -dt render/multiLister/createNode/material)
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 CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + 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'")

dragCommand(dc) script createedit
Command string executed repeatedly during a drag of the slider.
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.
enableKeyboardFocus(ekf) boolean createqueryedit
If enabled, the user can navigate to the control with the tab key and select values with the keyboard or mouse. This flag would typically be used to turn off focus support from controls that get it by default, like Edit and List controls. If disabled, text in text fields can still be selected with the mouse but cannot be copied (except on Linux when "Middle Click Paste" is enabled).
exists(ex) boolean create
Returns whether the specified object exists or not. Other flags are ignored.
extraLabel(el) string createqueryedit
If present on creation this specifies that there will be an extra label appearing after the slider. Sets the string to be the text for the extra label.
field(f) boolean create
Indicates whether the group will have an editable float field present that reflects the value of the slider.
fieldMaxValue(fmx) float createqueryedit
Maximum value that may be entered in the field. This value may be set to any value greater than the -max/maxValue flag. By default, it is equal to the -max/maxValue flag.
fieldMinValue(fmn) float createqueryedit
Minimum value that may be entered in the field. This value may be set to any value less than the -min/minValue flag. By default, it is equal to the -min/minValue flag.
fieldStep(fs) float createqueryedit
Increment for the field.
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.
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.
image(i) string createqueryedit
Image displayed on the symbol button.
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
If present on creation the group will have static text.
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.
maxValue(max) float createqueryedit
Maximum value for both the slider and the field.
minValue(min) float createqueryedit
Minimum value for both the slider and the field.
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.
precision(pre) int createedit
Number of digits to the right of the decimal.
preventOverride(po) boolean createqueryedit
If true, this flag prevents overriding the control's attribute via the control's right mouse button menu.
rowAttach(rat) [int, string, int] createeditmultiuse
Arguments are : column, attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment types and offsets for the entire row.
sliderStep(ss) float createqueryedit
The slider step value represents the amount the value will increase or decrease when you click either side of the slider.
statusBarMessage(sbm) string createedit
Extra string to display in the status bar when the mouse is over the control.
step(s) float createqueryedit
Increment for both the slider and field.
symbolButtonCommand(sbc) script createedit
Command string executed when the symbol button is pressed.
symbolButtonDisplay(sbd) boolean createqueryedit
Visibility of the symbol button.
useTemplate(ut) string create
Forces the command to use a command template other than the current one.
value(v) float createqueryedit
Value of the group.
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.
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

window = cmds.window()
cmds.columnLayout()
cmds.floatSliderButtonGrp( label='Label', field=True, buttonLabel='Button', symbolButtonDisplay=True, columnWidth=(5, 23), image='cmdWndIcon.xpm' )
cmds.showWindow( window )