pymel.core.windows.gradientControl

gradientControl(*args, **kwargs)

This command creates a control that displays the gradient attribute specified. The gradient attribute must be of the correct form and naming. It should be a multi attribute with each entry a compound composed of: Either a color compound or a float value (the control will automatically detect which and display a ramp or graph accordingly).A single float attribute for position.An enum for the interpolation types.Currently the routines to get the value of a ramp structure (with interpolation) are not available through MEL, which limits the use of this control by end users. The MEL command AEaddRampControl should be used to attach this control to an attribute from attribute editor templates.

Flags:
Long name (short name) Argument Types Properties
adaptiveScaling (adaptiveScaling) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Allow the ramp widget display to scale vertically to accommodate values greater than 1.0. True if adaptive scaling is enabled, false (the default) if not.
annotation (ann) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Annotate the control with an extra string value.
attribute (at) PyNode ../../../_images/create.gif
 
Specifies the name of the gradient attribute to control.
backgroundColor (bgc) float, float, float ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

defineTemplate (dt) unicode ../../../_images/create.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Enables the background color of the control.
exists (ex) bool ../../../_images/create.gif
 
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
fullPathName (fpn) unicode ../../../_images/query.gif
 
Return the full path name of the widget, which includes all the parents
height (h) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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 ../../../_images/query.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.
numberOfControls (nc) int ../../../_images/query.gif
 
Returns the number of controls in the ramp widget
numberOfPopupMenus (npm) bool ../../../_images/query.gif
 
Return the number of popup menus attached to this control.
parent (p) unicode ../../../_images/create.gif ../../../_images/query.gif
 
The parent layout for this control.
popupMenuArray (pma) bool ../../../_images/query.gif
 
Return the names of all the popup menus attached to this control.
preventOverride (po) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
If true, this flag disallows overriding the control’s attribute via the control’s right mouse button menu.
refreshOnRelease (ror) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Define how updates are dispatched during interactive editing of the ramp widget. True causes updates to only dispatch after releasing the mouse button after editing. False (the default) causes updates to dispatch interactively during editing (e.g. while moving ramp curve points). Note that the global update mode, if set to “on release” can disable the effect of this option.

selectedColorControl (scc) unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies the name of a color control to edit the selected color.
selectedInterpControl (sic) unicode ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies the name of an enum control to edit the selected interpolation.
| .. |
spc)** | unicode | .. image:: /images/create.gif |
| | .. image:: /images/edit.gif |
 
Specifies the name of a float slider to edit the selected position.
| .. |
snc)** | bool | .. image:: /images/create.gif |
| | .. image:: /images/query.gif |
| | .. image:: /images/edit.gif |
 
When ‘true’, this flag disables the creation/deletion of ramp entries (control points) via ramp widget interaction. Default is false.
staticPositions (sp) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
When ‘true’, this flag disables the interactive modification of ramp entry positions. Default is false.
upperLimitControl (ulc) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Specify the name of a text control which is updated with the current upper display limit for the ramp. This option is only effective when adaptiveScaling is specified.

useTemplate (ut) unicode ../../../_images/create.gif
 
Force the command to use a command template other than the current one.
verticalLayout (vl) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

When ‘true’, this makes the control orient vertically rather than horizontally. The default is false or horizontal.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

visible (vis) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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 ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Command that gets executed when visible state of the control changes.
width (w) int ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.gradientControl

Example:

import pymel.core as pm

import maya.cmds as cmds

# Create a ramp widget for the profileCurve attribute
#
pm.window( title='Gradient Control For Attribute' )
# Result: ui.Window('window1') #
objName = pm.createNode('polySplitRing')
pm.columnLayout()
# Result: ui.ColumnLayout('window1|columnLayout40') #
pm.gradientControl( at='%s.profileCurve' % objName )
# Result: ui.GradientControl('window1|columnLayout40|gradientControl1') #
pm.showWindow()

# To add a ramp widget in the attribute editor, call the
# AEaddRampControl mel script.
#

Previous topic

pymel.core.windows.grabColor

Next topic

pymel.core.windows.gradientControlNoAttr

Core

Core Modules

Other Modules

This Page