pymel.core.windows.radioButtonGrp¶

radioButtonGrp(*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 from one to four radio buttons in a single row. By default the radio buttons will share a single collection, but they can also share the collection of another radio button group. The buttons can also have an optional text label.

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.
annotation1 / an1		unicode
	specifies the tooptip of the first radiobutton
annotation2 / an2		unicode
	specifies the tooptip of the second radiobutton
annotation3 / an3		unicode
	specifies the tooptip of the third radiobutton
annotation4 / an4		unicode
	specifies the tooptip of the fourth radiobutton
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
	Command executed when the group changes state. Note that this flag should not be used in conjunction with onCommand and offCommand. That is, one should either use changeCommand and test the state of a radio button from inside the callback, or use onCommand and offCommand as separate callbacks.
changeCommand1 / cc1		script
changeCommand2 / cc2		script
changeCommand3 / cc3		script
changeCommand4 / cc4		script
	Specify a changed state command for each respective radio button.
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.
data1 / da1		int
data2 / da2		int
data3 / da3		int
data4 / da4		int
	Internal data associated with each radio button.
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’
editable / ed		bool
	The edit state of the group. By default, this flag is set to true and the radio button values may be changed by clicking on them. If false then the radio buttons are ‘read only’ and can not be clicked on. The value of the radio button can always be changed with the sl/selectflags regardless of the state of the ed/editableflag.
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.
enable1 / en1		bool
enable2 / en2		bool
enable3 / en3		bool
enable4 / en4		bool
	Enable state of the individual radio buttons.
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.
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.
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
	When present on creation an optional text label will be built with the group. The string specifies the label text.
label1 / l1		unicode
label2 / l2		unicode
label3 / l3		unicode
label4 / l4		unicode
	Specify label strings for the respective radio buttons in the group.
labelAnnotation / la		unicode
	when present on creation an optional text label will be built with the group . The string specifies the label tooltip
labelArray2 / la2		unicode, unicode
labelArray3 / la3		unicode, unicode, unicode
labelArray4 / la4		unicode, unicode, unicode, unicode
	Specify multiple labels in a single flag. These flags are ignored if the number of radio buttons doesn’t match.
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.
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.
numberOfPopupMenus / npm		bool
	Return the number of popup menus attached to this control.
numberOfRadioButtons / nrb		int
	Number of radio buttons in the group (1 - 4).
offCommand / ofc		script
	Command executed when any radio button turns off.
offCommand1 / of1		script
offCommand2 / of2		script
offCommand3 / of3		script
offCommand4 / of4		script
	Off command for each respective radio button.
onCommand / onc		script
	Command executed when any radio button turns on.
onCommand1 / on1		script
onCommand2 / on2		script
onCommand3 / on3		script
onCommand4 / on4		script
	On command for each respective radio button.
parent / p		unicode
	The parent layout for this control.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
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.
select / sl		int
	Selected radio button. The argument is a 1 based integer.
shareCollection / scl		unicode
	Specify the radioButtonGrp that this radio group is to be associated with. By default the radio group will be a separate collection.
useTemplate / ut		unicode
	Force the command to use a command template other than the current one.
vertical / vr		bool
	Whether the orientation of the radio buttons in this group are horizontal (default) or vertical.
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.radioButtonGrp

Example:

import pymel.core as pm

#    Create a window with two separate radio button groups.
#
window = pm.window()
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout72') #
pm.radioButtonGrp( label='Three Buttons', labelArray3=['One', 'Two', 'Three'], numberOfRadioButtons=3 )
# Result: ui.RadioButtonGrp('window1|columnLayout72|radioButtonGrp1') #
pm.radioButtonGrp( label='Four Buttons', labelArray4=['I', 'II', 'III', 'IV'], numberOfRadioButtons=4 )
# Result: ui.RadioButtonGrp('window1|columnLayout72|radioButtonGrp2') #
pm.showWindow( window )

#    Create a window with two radio button groups that are
#    linked together.
#
window = pm.window()
pm.columnLayout()
# Result: ui.ColumnLayout('window2|columnLayout73') #
group1 = pm.radioButtonGrp( numberOfRadioButtons=3, label='Colors', labelArray3=['Red', 'Blue', 'Green'] )
pm.radioButtonGrp( numberOfRadioButtons=3, shareCollection=group1, label='', labelArray3=['Yellow', 'Orange', 'Purple'] )
# Result: ui.RadioButtonGrp('window2|columnLayout73|radioButtonGrp4') #
pm.showWindow( window )