pymel.core.windows.attrFieldGrp¶

attrFieldGrp(*args, **kwargs)¶

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, plus two to four float fields. These fields will be attached to the specified vector attribute, so that changes in either will be reflected in the other. The fields created here are expression fields – while normally operating as a float field, the user can type in any expression starting with the character -. 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.

Flags:

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
	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
	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
	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
	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
	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		unicode
	Annotate the control with an extra string value.
attribute / at		unicode
	The name of a unique attribute of type vector. This newly created field will be attached to the attribute, so that modifications to one will change the other. A vectorattribute is any compound attribute whose children consist of two to four double-valued attributes.
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		script
	The command string is executed when the value of any of the floatFields change.
columnAlign / cal		int, unicode
	Arguments are : column number, alignment type. Possible alignments are: left | right | center. Specifies alignment type for the specified column.
columnAlign2 / cl2		unicode, unicode
	Sets the text alignment of both columns. Ignored if there are not exactly two columns. Valid values are left, right, and center.
columnAlign3 / cl3		unicode, unicode, unicode
	Sets the text alignment for all 3 columns. Ignored if there are not exactly 3 columns. Valid values are left, right, and center.
columnAlign4 / cl4		unicode, unicode, unicode, unicode
	Sets the text alignment for all 4 columns. Ignored if there are not exactly 4 columns. Valid values are left, right, and center.
columnAlign5 / cl5		unicode, unicode, unicode, unicode, unicode
	Sets the text alignment for all 5 columns. Ignored if there are not exactly 5 columns. Valid values are left, right, and center.
columnAlign6 / cl6		unicode, unicode, unicode, unicode, unicode, unicode
	Sets the text alignment for all 6 columns. Ignored if there are not exactly 6 columns. Valid values are left, right, and center.
columnAttach / cat		int, unicode, int
	Arguments are : column number, attachment type, and offset. Possible attachments are: left | right | both. Specifies column attachment types and offets.
columnAttach2 / ct2		unicode, unicode
	Sets the attachment type of both columns. Ignored if there are not exactly two columns. Valid values are left, right, and both.
columnAttach3 / ct3		unicode, unicode, unicode
	Sets the attachment type for all 3 columns. Ignored if there are not exactly 3 columns. Valid values are left, right, and both.
columnAttach4 / ct4		unicode, unicode, unicode, unicode
	Sets the attachment type for all 4 columns. Ignored if there are not exactly 4 columns. Valid values are left, right, and both.
columnAttach5 / ct5		unicode, unicode, unicode, unicode, unicode
	Sets the attachment type for all 5 columns. Ignored if there are not exactly 5 columns. Valid values are left, right, and both.
columnAttach6 / ct6		unicode, unicode, unicode, unicode, unicode, unicode
	Sets the attachment type for all 6 columns. Ignored if there are 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 are 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 are 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 are 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 are 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 are 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
	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 are not exactly two columns.
columnWidth3 / cw3		int, int, int
	Sets the column widths for all 3 columns. Ignored if there are not exactly 3 columns.
columnWidth4 / cw4		int, int, int, int
	Sets the column widths for all 4 columns. Ignored if there are not exactly 4 columns.
columnWidth5 / cw5		int, int, int, int, int
	Sets the column widths for all 5 columns. Ignored if there are not exactly 5 columns.
columnWidth6 / cw6		int, int, int, int, int, int
	Sets the column widths for all 6 columns. Ignored if there are not exactly 6 columns.
defineTemplate / dt		unicode
	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		unicode
	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 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		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 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
	Enables the background color of the control.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
extraLabel / el		unicode
	set an optional string that will be positioned to the right of all the fields.
fullPathName / fpn		bool
	Return the full path name of the widget, which includes all the parents
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.
hideMapButton / hmb		bool
	Force the map button to remain hidden for this control.
highlightColor / hlc		float, float, float
	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.
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
	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 the user wants.
manage / m		bool
	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
	Sets the maximum value for all fields.
minValue / min		float
	Sets the minimum value for all fields.
noBackground / nbg		bool
	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.
numberOfFields / nf		int
	sets the number of fields. Only allowed values are 2 to 4. If not specified, defaults to 3. NOTE: if the -at flag is used when this widget is created, the number of children in the attribute will determine the number of fields. Also note: after creation, the number of fields cannot be changed with the -e flag.
numberOfPopupMenus / npm		bool
	Return the number of popup menus attached to this control.
parent / p		unicode
	The parent layout for this control.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
precision / pre		int
	Sets the precision for all fields
preventOverride / po		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
rowAttach / rat		int, unicode, int
	Arguments are : column, attachment type, offset. Possible attachments are: top | bottom | both. Specifies attachment types and offsets for the entire row.
step / s		float
	Sets the increment for all fields
useTemplate / ut		unicode
	Force the command to use a command template other than the current one.
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		script
	Command that gets executed when visible state of the control changes.
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. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.attrFieldGrp

Example:

import pymel.core as pm

#    Create an object and a window containing an 'attrFieldGrp' that will
#    manipulate the position of that object.
#
object = pm.sphere()
window = pm.window(title='attrFieldGrp Example')
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout7') #
pm.attrFieldGrp( attribute='%s.translate' % object[0] )
# Result: ui.AttrFieldGrp('window1|columnLayout7|attrFieldGrp1') #
pm.showWindow()