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/adjustableColumnflags. 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 pre-packaged collection of label text, float field and float slider (for values with a min or max specified) The group also supports the notion of a larger secondary range of possible field values. If an attribute is specified for this object, then it will use any min and max values defined in the attribute. The user-specified values can reduce the min and max, but cannot expand them. The field created here is an expression field – while normally operating as a float field, the user can type in any expression starting with the character -. This will expand the field to occupy the space previously taken by the slider. The field also has an automatic menu brought up by the right mouse button. The contents of this menu change depending on the state of the attribute being watched by the field.
Long name (short name) | Argument Types | Properties | |
---|---|---|---|
adjustableColumn (adj) | int | ||
Specifies which column has an adjustable size that changes with the sizing of the layout. The column value is a 1-based index. You may also specify 0 to turn off the previous adjustable column. |
|||
adjustableColumn2 (ad2) | int | ||
|
|||
adjustableColumn3 (ad3) | int | ||
|
|||
adjustableColumn4 (ad4) | int | ||
|
|||
adjustableColumn5 (ad5) | int | ||
|
|||
adjustableColumn6 (ad6) | int | ||
|
|||
annotation (ann) | unicode | ||
|
|||
attribute (at) | unicode | ||
The name of a unique attribute of type double or int. This newly created field will be attached to the attribute, so that modifications to one will change the other. |
|||
backgroundColor (bgc) | float, float, float | ||
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. |
|||
changeCommand (cc) | callable | ||
|
|||
columnAlign (cal) | int, unicode | ||
|
|||
columnAlign2 (cl2) | unicode, unicode | ||
|
|||
columnAlign3 (cl3) | unicode, unicode, unicode | ||
|
|||
columnAlign4 (cl4) | unicode, unicode, unicode, unicode | ||
|
|||
columnAlign5 (cl5) | unicode, unicode, unicode, unicode, unicode | ||
|
|||
columnAlign6 (cl6) | unicode, unicode, unicode, unicode, unicode, unicode | ||
|
|||
columnAttach (cat) | int, unicode, int | ||
|
|||
columnAttach2 (ct2) | unicode, unicode | ||
|
|||
columnAttach3 (ct3) | unicode, unicode, unicode | ||
|
|||
columnAttach4 (ct4) | unicode, unicode, unicode, unicode | ||
|
|||
columnAttach5 (ct5) | unicode, unicode, unicode, unicode, unicode | ||
|
|||
columnAttach6 (ct6) | unicode, unicode, unicode, unicode, unicode, unicode | ||
|
|||
columnOffset2 (co2) | int, int | ||
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 is not exactly two columns. |
|||
columnOffset3 (co3) | int, int, int | ||
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 is not exactly three columns. |
|||
columnOffset4 (co4) | int, int, int, int | ||
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 is not exactly four columns. |
|||
columnOffset5 (co5) | int, int, int, int, int | ||
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 is not exactly five columns. |
|||
columnOffset6 (co6) | int, int, int, int, int, int | ||
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 is not exactly six columns. |
|||
columnWidth (cw) | int, int | ||
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 | ||
|
|||
columnWidth2 (cw2) | int, int | ||
|
|||
columnWidth3 (cw3) | int, int, int | ||
|
|||
columnWidth4 (cw4) | int, int, int, int | ||
|
|||
columnWidth5 (cw5) | int, int, int, int, int | ||
|
|||
columnWidth6 (cw6) | int, int, int, int, int, int | ||
|
|||
defineTemplate (dt) | unicode | ||
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. |
|||
docTag (dtg) | unicode | ||
|
|||
dragCallback (dgc) | callable | ||
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 dragControlvalue 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) | callable | ||
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 dragControlvalue 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) | bool | ||
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) | bool | ||
|
|||
exists (ex) | bool | ||
|
|||
fieldMaxValue (fmx) | float | ||
Set the maximum value for the field. This flag allows you to specify a maximum bound for the field higher than that of the slider. (See note above about max and min values.) |
|||
fieldMinValue (fmn) | float | ||
Set the minimum value for the field. This flag allows you to specify a minimum bound for the field lower than that of the slider. (See note above about max and min values.) |
|||
fieldStep (fs) | float | ||
|
|||
fullPathName (fpn) | bool | ||
|
|||
height (h) | int | ||
|
|||
hideMapButton (hmb) | bool | ||
|
|||
isObscured (io) | bool | ||
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) | unicode | ||
|
|||
manage (m) | bool | ||
|
|||
maxValue (max) | float | ||
|
|||
minValue (min) | float | ||
Sets the minimum value for both the slider and the field. (by default max and min are set according to what is in the attribute, if anything. If no max and min are specified, or if only one of the two are specified, then no slider is created.) |
|||
numberOfPopupMenus (npm) | bool | ||
|
|||
parent (p) | unicode | ||
|
|||
popupMenuArray (pma) | bool | ||
|
|||
precision (pre) | int | ||
|
|||
preventOverride (po) | bool | ||
|
|||
rowAttach (rat) | int, unicode, int | ||
|
|||
sliderMaxValue (smx) | float | ||
|
|||
sliderMinValue (smn) | float | ||
|
|||
sliderStep (ss) | float | ||
|
|||
step (s) | float | ||
|
|||
useTemplate (ut) | unicode | ||
|
|||
vertical (vr) | bool | ||
Whether the orientation of the controls in this group are horizontal (default) or vertical. Flag can have multiple arguments, passed either as a tuple or a list. |
|||
visible (vis) | bool | ||
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) | callable | ||
|
|||
width (w) | int | ||
|
Derived from mel command maya.cmds.attrFieldSliderGrp
Example:
import pymel.core as pm
pm.window( title='Attr Field Slider Groups' )
# Result: ui.Window('window1') #
objName = pm.sphere()
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout7') #
pm.attrFieldSliderGrp( min=-10.0, max=10.0, at='%s.tx' % objName[0] )
# Result: ui.AttrFieldSliderGrp('window1|columnLayout7|attrFieldSliderGrp2') #
pm.showWindow()