pymel.core.windows.floatSlider2

floatSlider2(*args, **kwargs)

This command creates a float slider containing two handles. The two handles are arranged such that they cannot pass one another, thus handle 1 will always have a value less than or or equal to handle 2 when you adjust the values. Each handle may have a MEL command associated with it which is issued when the handle moves and thus can be used to update the values of plugs such as via a setAttr command. Each handle can also be associated with a float textfield to display the current value of the handle. Note: the floatSlider2 widget currently only supports vertical (columnLayout) orientation.

Flags:

Long name (short name)		Argument Types	Properties
annotation (ann)		unicode
	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.
changeCommand1 (cc1)		unicode
	Command to be associated with handle 1 and issued whenever the value of the handle is changed (except when values are changed via the -hv/handleValue flag). An example command might be “setAttr nurbsSphere1.tx” and if handle 1 were to move to value 0.23 the slider would issue the command “setAttr nurbsSphere1.tx 0.23;”.
changeCommand2 (cc2)		unicode
	Command to be associated with handle 2 and issued whenever the value of the handle is changed (except when values are changed via the -hv/handleValue flag). An example command might be “setAttr nurbsSphere1.tx” and if handle 2 were to move to value 0.23 the slider would issue the command “setAttr nurbsSphere1.tx 0.23;”.
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
	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’”)
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 true|false depending upon whether the specified object exists. Other flags are ignored.
fullPathName (fpn)		unicode
	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.
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.
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.
maximum (max)		float
	Maximum limit of the slider. The default value is 10.0. The maximum value occurs at the top(right) end of the slider unless -polarity was specified. Note: you cannot set the maximum value greater than or equal to the current minimum.
minimum (min)		float
	Minimum limit of the slider. The default value is 0.0. The minimum value occurs at the bottom end of the slider unless -polarity was specified. Note: you cannot set the minimum value greater than or equal to the current maximum.
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.
parent (p)		unicode
	The parent layout for this control.
polarity (pol)		int
	Specifies the polarity of the slider. If 0 (the default), the minimum value (specified by the -minimum flag) occurs at the bottom end of the slider and maximum at the top(right), with values increasing as the slider handles are moved towards the upper end of the slider. If the polarity is specified as 1, the reverse behaviour occurs, with the maximum occurring at the bottom end, the mimimum occuring at the top(right) end and values decreasing as the handles are moved towards the upper end.
popupMenuArray (pma)		bool
	Return the names of all the popup menus attached to this control.
positionControl1 (pc1)		unicode
	Set the name of the control (if any) which is associated with handle 1 of this slider. The control must be a “floatField”. The control always displays the value of the handle, and is updated as the handle moves.
positionControl2 (pc2)		unicode
	Set the name of the control (if any) which is associated with handle 2 of this slider. The control must be a “floatField”. The control always displays the value of the handle, and is updated as the handle moves.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
preventOverride (po)		bool
	If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
useTemplate (ut)		unicode
	Force the command to use a command template other than the current one.
value1 (v1)		float
	Value of handle 1. To ensure that handle 1 stays at or below handle 2, an error will occur if the value specified is too large. If you wish to set both handles simultaneously, use the -values flag.
value2 (v2)		float
	Value of handle 2. To ensure that handle 2 stays at or above handle 2, an error will occur if the value specified is too large. If you wish to set both handles simultaneously, use the -values flag.
values (vs)		float, float
	Sets the value for handles 1 and 2 simulteneously. The first argument is applied to handle 1 and must be less than or equal to the second (handle 2) argument or an error will be issued.
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.

Derived from mel command maya.cmds.floatSlider2

Example:

import pymel.core as pm

############ floatSlider2 example #############
#
# First, create one object to control with the slider. We will use one
# slider handle to control the startSweep and the other the endSweep so
# that the sphere can be made to open and close via the handles.
#
pm.sphere()
# Result: [nt.Transform(u'nurbsSphere1'), nt.MakeNurbSphere(u'makeNurbSphere1')] #

# Create a window containing a floatSlider2 (two handled float slider).
# The window also contains two floating-point textfields.
#    - Moving the handle updates the associated textfield.
#    - Typing a value into a textfield moves the associated handle.
#
pm.window()
# Result: ui.Window('window1') #
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout32') #

ff1    = pm.floatField()
slider = pm.floatSlider2()
ff2    = pm.floatField()

# Hook the slider handles up to drive the textfields. When you move the
# slider handles, the textfields will update to display the
# position of the handle.
#
pm.floatSlider2( slider, edit=True, positionControl1=ff1, positionControl2=ff2 )
# Result: ui.FloatSlider2('window1|columnLayout32|floatSlider21') #

# Set the slider direction (polarity) and upper limit.
#
pm.floatSlider2( slider, edit=True, polarity=1, max=360 )
# Result: ui.FloatSlider2('window1|columnLayout32|floatSlider21') #

# Connect the slider so that the handles drive the sweep angles of
# the NURBS sphere.
#
pm.floatSlider2(slider, edit=True, cc1='setAttr makeNurbSphere1.endSweep', cc2='setAttr makeNurbSphere1.startSweep' )
# Result: ui.FloatSlider2('window1|columnLayout32|floatSlider21') #

# Display the window.
#
pm.showWindow()