shapePanel

Go to: Synopsis. Return value. Flags. Python examples.

Synopsis

shapePanel( string , [control=boolean], [copy=string], [createString=boolean], [defineTemplate=string], [docTag=string], [editString=boolean], [exists=boolean], [init=boolean], [isUnique=boolean], [label=string], [menuBarRepeatLast=boolean], [menuBarVisible=boolean], [needsInit=boolean], [parent=string], [popupMenuProcedure=script], [replacePanel=string], [shapeEditor=boolean], [tearOff=boolean], [tearOffCopy=string], [tearOffRestore=boolean], [unParent=boolean], [useTemplate=string])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

shapePanel is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Flags

Long name (short name)	Argument types	Properties
control(ctl)	boolean
Returns the top level control for this panel. Usually used for getting a parent to attach popup menus. CAUTION: panels may not have controls at times. This flag can return "" if no control is present.
copy(cp)	string
Makes this panel a copy of the specified panel. Both panels must be of the same type.
createString(cs)	boolean
Command string used to create a panel
defineTemplate(dt)	string
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.
docTag(dtg)	string
Attaches a tag to the Maya panel.
editString(es)	boolean
Command string used to edit a panel
exists(ex)	boolean
Returns whether the specified object exists or not. Other flags are ignored.
init(init)	boolean
Initializes the panel's default state. This is usually done automatically on file -new and file -open.
isUnique(iu)	boolean
Returns true if only one instance of this panel type is allowed.
label(l)	string
Specifies the user readable label for the panel.
menuBarRepeatLast(mrl)	boolean
Controls whether clicking on the menu header with the middle mouse button would repeat the last selected menu item.
menuBarVisible(mbv)	boolean
Controls whether the menu bar for the panel is displayed.
needsInit(ni)	boolean
(Internal) On Edit will mark the panel as requiring initialization. Query will return whether the panel is marked for initialization. Used during file -new and file -open.
parent(p)	string
Specifies the parent layout for this panel.
popupMenuProcedure(pmp)	script
Specifies the procedure called for building the panel's popup menu(s). The default value is "buildPanelPopupMenu". The procedure should take one string argument which is the panel's name.
replacePanel(rp)	string
Will replace the specified panel with this panel. If the target panel is within the same layout it will perform a swap.
shapeEditor(se)	boolean
Query only flag that returns the name of an editor to be associated with the panel.
tearOff(to)	boolean
Will tear off this panel into a separate window with a paneLayout as the parent of the panel. When queried this flag will return if the panel has been torn off into its own window.
tearOffCopy(toc)	string
Will create this panel as a torn of copy of the specified source panel.
tearOffRestore(tor)	boolean
Restores panel if it is torn off and focus is given to it. If docked, becomes the active panel in the docked window. This should be the default flag that is added to all panels instead of -to/-tearOff flag which should only be used to tear off the panel.
unParent(up)	boolean
Specifies that the panel should be removed from its layout. This (obviously) cannot be used with query.
useTemplate(ut)	string
Forces the command to use a command template other than the current one.

Flag can appear in Create mode of command	Flag can appear in Edit mode of command
Flag can appear in Query mode of command	Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

cmds.shapePanel( 'bsP' )