pymel.core.uitypes.GradientControlNoAttr

Inheritance diagram of GradientControlNoAttr

class GradientControlNoAttr

class counterpart of mel function gradientControlNoAttr

This command creates a control for editing a ramp (2D control curve). The control attaches to an optionVar used to store and retrieve the encoded gradient control points stored in a string.

changeCommand(val=True, **kwargs)

Specifies a command to be executed whenever the value of this ramp is modified. This option should not be used when specifying an optionVar.

Derived from mel command maya.cmds.gradientControlNoAttr

currentKeyChanged(val=True, **kwargs)

Specifies a command to be executed whenever the selected key changes.

Derived from mel command maya.cmds.gradientControlNoAttr

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

dragCommand(val=True, **kwargs)

Specifies a command to be executed while the ramp is being modified.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.gradientControlNoAttr

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

getAnnotation(**kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.gradientControlNoAttr

getAsString(**kwargs)

Used to query and set the value of the ramp as a string of comma separated values

Derived from mel command maya.cmds.gradientControlNoAttr

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

getCurrentKey(**kwargs)

Returns the index of the currently selected key.

Derived from mel command maya.cmds.gradientControlNoAttr

getCurrentKeyColorValue(**kwargs)

Get or set the color of the currently selected key. Only useful if the ramp is set to be a color ramp.

Derived from mel command maya.cmds.gradientControlNoAttr

getCurrentKeyCurveValue(**kwargs)

Get or set the value of the currently selected key. Only useful if the ramp is set to be a curve ramp.

Derived from mel command maya.cmds.gradientControlNoAttr

getCurrentKeyInterpValue(**kwargs)

Get or set the interpolation value for the current key.

Derived from mel command maya.cmds.gradientControlNoAttr

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

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

getEnableBackground(**kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.gradientControlNoAttr

getFullPathName(**kwargs)

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

Derived from mel command maya.cmds.gradientControlNoAttr

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

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

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

getNumberOfPopupMenus(**kwargs)

Return the number of popup menus attached to this control.

Derived from mel command maya.cmds.gradientControlNoAttr

getOptionVar(**kwargs)

Specifies the name of the option var used to store and retrieve the string value capturing the curve.

Derived from mel command maya.cmds.gradientControlNoAttr

getPopupMenuArray(**kwargs)

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

Derived from mel command maya.cmds.gradientControlNoAttr

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

getRampAsColor(**kwargs)

Sets whether the ramp should be viewed as a colour ramp or as a curve. Default is as a curve.

Derived from mel command maya.cmds.gradientControlNoAttr

getValueAtPoint(**kwargs)

Used during query to specify the point at which to query the curve.

Derived from mel command maya.cmds.gradientControlNoAttr

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

getVisibleChangeCommand(**kwargs)

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

Derived from mel command maya.cmds.gradientControlNoAttr

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

setAnnotation(val=True, **kwargs)

Annotate the control with an extra string value.

Derived from mel command maya.cmds.gradientControlNoAttr

setAsString(val=True, **kwargs)

Used to query and set the value of the ramp as a string of comma separated values

Derived from mel command maya.cmds.gradientControlNoAttr

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

setCurrentKey(val=True, **kwargs)

Returns the index of the currently selected key.

Derived from mel command maya.cmds.gradientControlNoAttr

setCurrentKeyColorValue(val=True, **kwargs)

Get or set the color of the currently selected key. Only useful if the ramp is set to be a color ramp.

Derived from mel command maya.cmds.gradientControlNoAttr

setCurrentKeyCurveValue(val=True, **kwargs)

Get or set the value of the currently selected key. Only useful if the ramp is set to be a curve ramp.

Derived from mel command maya.cmds.gradientControlNoAttr

setCurrentKeyInterpValue(val=True, **kwargs)

Get or set the interpolation value for the current key.

Derived from mel command maya.cmds.gradientControlNoAttr

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

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

setEnableBackground(val=True, **kwargs)

Enables the background color of the control.

Derived from mel command maya.cmds.gradientControlNoAttr

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

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

setOptionVar(val=True, **kwargs)

Specifies the name of the option var used to store and retrieve the string value capturing the curve.

Derived from mel command maya.cmds.gradientControlNoAttr

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

setRampAsColor(val=True, **kwargs)

Sets whether the ramp should be viewed as a colour ramp or as a curve. Default is as a curve.

Derived from mel command maya.cmds.gradientControlNoAttr

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

setVisibleChangeCommand(val=True, **kwargs)

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

Derived from mel command maya.cmds.gradientControlNoAttr

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

Previous topic

pymel.core.uitypes.GradientControl

Next topic

pymel.core.uitypes.GridLayout

Core

Core Modules

Other Modules

This Page