Go to: Synopsis. Return value. Flags. Python examples.
shapePanel(
string
, [control=boolean], [copy=string], [defineTemplate=string], [docTag=string], [exists=boolean], [init=boolean], [isUnique=boolean], [label=string], [menuBarVisible=boolean], [needsInit=boolean], [parent=string], [popupMenuProcedure=script], [replacePanel=string], [shapeEditor=boolean], [tearOff=boolean], [tearOffCopy=string], [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.
This command creates a panel that derives from the base panel
class that houses a shapeEditor.
| string | The name of the panel |
In query mode, return type is based on queried flag.
control, copy, defineTemplate, docTag, exists, init, isUnique, label, menuBarVisible, needsInit, parent, popupMenuProcedure, replacePanel, shapeEditor, tearOff, tearOffCopy, unParent, useTemplate
| 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.
|
|
defineTemplate(dt)
|
string
|
|
|
Puts the 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)
|
string
|
|
|
Attaches a tag to the Maya 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.
|
|
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.
|
|
unParent(up)
|
boolean
|
|
|
Specifies that the panel should be removed from its layout.
This (obviously) cannot be used with query.
|
|
useTemplate(ut)
|
string
|
|
|
Force 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.
|
import maya.cmds as cmds
cmds.shapePanel( 'bsP' )