attrFieldSliderGrp

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

Synopsis

attrFieldSliderGrp [-adjustableColumn int] [-adjustableColumn2 int] [-adjustableColumn3 int] [-adjustableColumn4 int] [-adjustableColumn5 int] [-adjustableColumn6 int] [-annotation string] [-attribute string] [-backgroundColor float float float] [-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] [-dropCallback script] [-enable boolean] [-enableBackground boolean] [-exists] [-fieldMaxValue float] [-fieldMinValue float] [-fieldStep float] [-fullPathName string] [-height int] [-hideMapButton boolean] [-isObscured] [-label string] [-manage boolean] [-maxValue float] [-minValue float] [-noBackground boolean] [-numberOfPopupMenus] [-parent string] [-popupMenuArray] [-precision int] [-preventOverride boolean] [-rowAttach int string int] [-sliderMaxValue float] [-sliderMinValue float] [-sliderStep float] [-step float] [-useTemplate string] [-vertical] [-visible boolean] [-visibleChangeCommand script] [-width int] [groupName]

attrFieldSliderGrp 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 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.

Return value

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

Flags

Long name (short name)	Argument types	Properties
-exists(-ex)
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt)	string
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
Force the command to use a command template other than the current one.
-parent(-p)	string
The parent layout for this control.
-enable(-en)	boolean
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.
-width(-w)	int
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-height(-h)	int
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-visible(-vis)	boolean
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
Command that gets executed when visible state of the control changes.
-isObscured(-io)
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.
-manage(-m)	boolean
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.
-numberOfPopupMenus(-npm)
Return the number of popup menus attached to this control.
-popupMenuArray(-pma)
Return the names of all the popup menus attached to this control.
-preventOverride(-po)	boolean
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
-annotation(-ann)	string
Annotate the control with an extra string value.
-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.
-noBackground(-nbg)	boolean
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.
-enableBackground(-ebg)	boolean
Enables the background color of the control.
-docTag(-dtg)	string
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
-dragCallback(-dgc)	script
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
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'")
-fullPathName(-fpn)	string
Return the full path name of the widget, which includes all the parents
-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
Sets the width of the first column. Ignored if there is not exactly one column.
-columnWidth2(-cw2)	int int
Sets the column widths of both columns. Ignored if there is not exactly two columns.
-columnWidth3(-cw3)	int int int
Sets the column widths for all 3 columns. Ignored if there is not exactly 3 columns.
-columnWidth4(-cw4)	int int int int
Sets the column widths for all 4 columns. Ignored if there is not exactly 4 columns.
-columnWidth5(-cw5)	int int int int int
Sets the column widths for all 5 columns. Ignored if there is not exactly 5 columns.
-columnWidth6(-cw6)	int int int int int int
Sets the column widths for all 6 columns. Ignored if there is not exactly 6 columns.
-columnAttach(-cat)	int string int
Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies column attachment types and offets.
-columnAttach2(-ct2)	string string
Sets the attachment type of both columns. Ignored if there is not exactly two columns. Valid values are "left", "right", and "both".
-columnAttach3(-ct3)	string string string
Sets the attachment type for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are "left", "right", and "both".
-columnAttach4(-ct4)	string string string string
Sets the attachment type for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are "left", "right", and "both".
-columnAttach5(-ct5)	string string string string string
Sets the attachment type for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are "left", "right", and "both".
-columnAttach6(-ct6)	string string string string string string
Sets the attachment type for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are "left", "right", and "both".
-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.
-rowAttach(-rat)	int string int
Arguments are : column, attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment types and offsets for the entire row.
-columnAlign(-cal)	int string
Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type for the specified column.
-columnAlign2(-cl2)	string string
Sets the text alignment of both columns. Ignored if there is not exactly two columns. Valid values are "left", "right", and "center".
-columnAlign3(-cl3)	string string string
Sets the text alignment for all 3 columns. Ignored if there is not exactly 3 columns. Valid values are "left", "right", and "center".
-columnAlign4(-cl4)	string string string string
Sets the text alignment for all 4 columns. Ignored if there is not exactly 4 columns. Valid values are "left", "right", and "center".
-columnAlign5(-cl5)	string string string string string
Sets the text alignment for all 5 columns. Ignored if there is not exactly 5 columns. Valid values are "left", "right", and "center".
-columnAlign6(-cl6)	string string string string string string
Sets the text alignment for all 6 columns. Ignored if there is not exactly 6 columns. Valid values are "left", "right", and "center".
-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
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly two columns.
-adjustableColumn3(-ad3)	int
Specifies that the column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly three columns.
-adjustableColumn4(-ad4)	int
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly four columns.
-adjustableColumn5(-ad5)	int
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly five columns.
-adjustableColumn6(-ad6)	int
Specifies which column has an adjustable size that changes with the size of the parent layout. Ignored if there is not exactly six columns.
-attribute(-at)	string
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.
-label(-l)	string
By default, the label of this field will be the name of the attribute. This flag can be used to override that name with whatever string you want.
-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.)
-maxValue(-max)	float
Sets the maximum value for both the slider and the field. (See note above about min and max 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.)
-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.)
-sliderMinValue(-smn)	float
Set the minimum value for the slider. The slider min will be clipped to the field min.
-sliderMaxValue(-smx)	float
Set the maximum value for the slider. The slider max will be clipped to the field max.
-precision(-pre)	int
Sets the number of digits to the right of the decimal. (If attached to an int attribute, this is automatically set to 0 and cannot be overridden.)
-step(-s)	float
Sets the increment for both the slider and float field.
-fieldStep(-fs)	float
Sets the increment for the float field.
-sliderStep(-ss)	float
On Linux the slider step value represents the amount the value will increase or decrease when you click either side of the slider.
-hideMapButton(-hmb)	boolean
Force the map button to remain hidden for this control.
-changeCommand(-cc)	script
The command string is executed when the value of the slider or floatField changes. It will be executed only once after a drag of the slider.
-vertical(-vr)
Whether the orientation of the controls in this group are horizontal (default) or vertical.

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.

MEL examples

window -title "Attr Field Slider Groups";
    string $objName[] = `sphere`;
    columnLayout;
    attrFieldSliderGrp -min -10.0 -max 10.0 -at ($objName[0]+".tx");
showWindow;