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

Synopsis

shapePanel [-control] [-copy string] [-defineTemplate string] [-docTag string] [-exists] [-init] [-isUnique] [-label string] [-menuBarVisible boolean] [-needsInit] [-parent string] [-popupMenuProcedure script] [-replacePanel string] [-shapeEditor] [-tearOff] [-tearOffCopy string] [-unParent] [-useTemplate string] string

shapePanel is undoable, queryable, and editable.

This command creates a panel that derives from the base panel class that houses a shapeEditor.

Return value

stringThe name of the panel

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

Flags

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) query
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 edit
Makes this panel a copy of the specified panel. Both panels must be of the same type.
-defineTemplate(-dt) string create
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 createqueryedit
Attaches a tag to the Maya panel.
-exists(-ex) create
Returns whether the specified object exists or not. Other flags are ignored.
-init(-in) createedit
Initializes the panel's default state. This is usually done automatically on file -new and file -open.
-isUnique(-iu) query
Returns true if only one instance of this panel type is allowed.
-label(-l) string queryedit
Specifies the user readable label for the panel.
-menuBarVisible(-mbv) boolean createqueryedit
Controls whether the menu bar for the panel is displayed.
-needsInit(-ni) queryedit
(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 create
Specifies the parent layout for this panel.
-popupMenuProcedure(-pmp) script queryedit
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 edit
Will replace the specified panel with this panel. If the target panel is within the same layout it will perform a swap.
-shapeEditor(-se) query
Query only flag that returns the name of an editor to be associated with the panel.
-tearOff(-to) queryedit
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 create
Will create this panel as a torn of copy of the specified source panel.
-unParent(-up) edit
Specifies that the panel should be removed from its layout. This (obviously) cannot be used with query.
-useTemplate(-ut) string create
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 be used more than once in a command.

MEL examples

shapePanel bsP;