pymel.core.windows.palettePort¶

palettePort(*args, **kwargs)¶

This command creates an array of color cells. It could be used to to store an retrieve some colors you want to manage during your working session.

Flags:

Long Name / Short Name		Argument Types	Properties
actualTotal / at		int
	Set the actual number of palette entries. This number must be greater than zero, but not be greater than maximum number of palette entries defined by the dimensionsflag.
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.
changeCommand / cc		script
	This command string will be executed when a color in the palette is changed.
colorEditable / ced		bool
	If true then the user can modify the current index’s color.
colorEdited / ce		script
	This command string will be executed when a color in the palette is edited.
defineTemplate / dt		unicode
	Puts the command in a mode where any other flags and arguments 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.
dimensions / dim		int, int
	Set the dimensions of the array.
docTag / dtg		unicode
	Add a documentation flag to the control. The documentation flag has a directory structure. (e.g., -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 CTRL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTRL, 3 == CTRL + 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
	If true then the user can change the current color.
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 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.
hsvValue / hsv		int, int, float, float, float
	Set a color for a given cell, using HSV format. On query return the color of the current cell.
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.
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.
popupMenuArray / pma		bool
	Return the names of all the popup menus attached to this control.
preventOverride / po		bool
	If true, this flag prevents overriding the control’s attribute via the control’s right mouse button menu.
redraw / r		bool
	Forces a redraw of the array
rgbValue / rgb		int, float, float, float
	Set a color for a given cell, using RGB format. On query return the color of the current cell.
setCurCell / scc		int
	Set the current cell in the array to the given index. Returns the current cell when queried.
statusBarMessage / sbm		unicode
	Extra string to display in the status bar when the mouse is over the control.
topDown / td		bool
	If this flag is true, it indicates that first entry should appear in top left as opposed to the bottom left.
transparent / t		int
	Set a given cell to be the transparent color. A cell value of -1 indicates that no cell is transparent. On query returns the current transparent cell.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one.
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.palettePort

Example:

import pymel.core as pm

pm.window()
# Result: ui.Window('window1') #
pm.frameLayout(labelVisible=0)
# Result: ui.FrameLayout('window1|frameLayout17') #

# create a palette of 20 columns and 15 rows
pm.palettePort( 'palette', dim=(20, 15) )
# Result: ui.PalettePort('window1|frameLayout17|palette') #

# select cell #30
pm.palettePort( 'palette', edit=True, scc=30 )
# Result: ui.PalettePort('window1|frameLayout17|palette') #

# return RGB value for this cell
pm.palettePort( 'palette', query=True, rgb=True )
# Result: [1.0, 0.4264214038848877, 0.0] #

# make cell #100 transparent and blue
pm.palettePort( 'palette', edit=True, transparent=100, rgb=(100, 0.0, 0.0, 1.0) )
# Result: ui.PalettePort('window1|frameLayout17|palette') #
pm.palettePort( 'palette', edit=True, redraw=True )
# Result: ui.PalettePort('window1|frameLayout17|palette') #

# returns the current transparent cell (there can be only one)
pm.palettePort( 'palette', query=True, transparent=True )
# Result: 100 #
pm.showWindow()