pymel.core.uitypes.FloatSlider2

class FloatSlider2

class counterpart of mel function floatSlider2

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.

changeCommand1(val=True, **kwargs)

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;”.

Derived from mel command maya.cmds.floatSlider2

changeCommand2(val=True, **kwargs)

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;”.

Derived from mel command maya.cmds.floatSlider2

dragCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.floatSlider2

dropCallback(val=True, **kwargs)

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’”)

Derived from mel command maya.cmds.floatSlider2

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.floatSlider2

getBackgroundColor(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getDocTag(**kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.floatSlider2

getEnable(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.floatSlider2

getFullPathName(**kwargs)

Return the full path name of the widget, which includes all the parents

Derived from mel command maya.cmds.floatSlider2

getHeight(**kwargs)

The height 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

getIsObscured(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getManage(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getMaximum(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getMinimum(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.floatSlider2

getPolarity(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getPopupMenuArray(**kwargs)

Return the names of all the popup menus attached to this control.

Derived from mel command maya.cmds.floatSlider2

getPreventOverride(**kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.floatSlider2

getValue1(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getValue2(**kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

getVisible(**kwargs)

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

Derived from mel command maya.cmds.floatSlider2

getVisibleChangeCommand(**kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.floatSlider2

getWidth(**kwargs)

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

positionControl1(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

positionControl2(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.floatSlider2

setBackgroundColor(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setDocTag(val=True, **kwargs)

Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material

Derived from mel command maya.cmds.floatSlider2

setEnable(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.floatSlider2

setHeight(val=True, **kwargs)

The height 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

setManage(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setMaximum(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setMinimum(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setPolarity(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setPreventOverride(val=True, **kwargs)

If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.

Derived from mel command maya.cmds.floatSlider2

setValue1(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setValue2(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2

setVisible(val=True, **kwargs)

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

Derived from mel command maya.cmds.floatSlider2

setVisibleChangeCommand(val=True, **kwargs)

Command that gets executed when visible state of the control changes.

Derived from mel command maya.cmds.floatSlider2

setWidth(val=True, **kwargs)

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

values(val=True, **kwargs)

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.

Derived from mel command maya.cmds.floatSlider2