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

Synopsis

componentEditor( name , [control=boolean], [defineTemplate=string], [docTag=string], [exists=boolean], [filter=string], [floatField=string], [floatSlider=string], [forceMainConnection=string], [hidePathName=boolean], [hideZeroColumns=boolean], [highlightConnection=string], [lockInput=boolean], [lockMainConnection=boolean], [mainListConnection=string], [newTab=[string, string, string]], [operationCount=boolean], [operationLabels=boolean], [operationType=int], [panel=string], [parent=string], [precision=int], [removeTab=string], [selected=boolean], [selectionConnection=string], [setOperationLabel=[int, string]], [showObjects=boolean], [showSelected=boolean], [sortAlpha=boolean], [stateString=boolean], [unParent=boolean], [unlockMainConnection=boolean], [updateMainConnection=boolean], [useTemplate=string])

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

componentEditor is undoable, queryable, and editable.

This command creates a new component editor in the current layout.

Return value

stringThe panel name

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

Flags

control, defineTemplate, docTag, exists, filter, floatField, floatSlider, forceMainConnection, hidePathName, hideZeroColumns, highlightConnection, lockInput, lockMainConnection, mainListConnection, newTab, operationCount, operationLabels, operationType, panel, parent, precision, removeTab, selected, selectionConnection, setOperationLabel, showObjects, showSelected, sortAlpha, stateString, unParent, unlockMainConnection, updateMainConnection, useTemplate
Long name (short name) Argument types Properties
control(ctl) boolean query
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible for an editor to exist without a control. The query will return "NONE" if no control is present.
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 editor.
exists(ex) boolean create
Returns whether the specified object exists or not. Other flags are ignored.
filter(f) string createqueryedit
Specifies the name of an itemFilter object to be used with this editor. This filters the information coming onto the main list of the editor.
floatField(ff) string createqueryedit
assigns a float field that the component editor will use for editing groups of values.
floatSlider(fs) string createqueryedit
assigns a float slider that the component editor will use for editing groups of values.
forceMainConnection(fmc) string createqueryedit
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will only display items contained in the selectionConnection object. This is a variant of the -mainListConnection flag in that it will force a change even when the connection is locked. This flag is used to reduce the overhead when using the -unlockMainConnection , -mainListConnection, -lockMainConnection flags in immediate succession.
hidePathName(hpn) boolean createqueryedit
Hides path name of displayed element. By default this flag is set to false.
hideZeroColumns(hzc) boolean createqueryedit
Hides columns whose elements are all zero. By default this flag is set to false.
highlightConnection(hlc) string createqueryedit
Specifies the name of a selectionConnection object that the editor will synchronize with its highlight list. Not all editors have a highlight list. For those that do, it is a secondary selection list.
lockInput(li) boolean createqueryedit
Prevents the editor from responding to changes in the active list. Independent of selection connection.
lockMainConnection(lck) boolean createedit
Locks the current list of objects within the mainConnection, so that only those objects are displayed within the editor. Further changes to the original mainConnection are ignored.
mainListConnection(mlc) string createqueryedit
Specifies the name of a selectionConnection object that the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.
newTab(nt) [string, string, string] createedit
Creates a new tab, named by the first argument, based on an existing tab, given as the second argument using elements from a set, given in the third argument
operationCount(oc) boolean query
returns the total number of operation types known to the component editor.
operationLabels(ol) boolean query
returns a string array containing the names for all operation types known to the editor.
operationType(ot) int createqueryedit
Tells the editor which of its known operation types it should be performing. This is a 0-based index.
panel(pnl) string createquery
Specifies the panel for this editor. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor does not belong to a panel it will be deleted when the window that it is in is deleted.
parent(p) string createqueryedit
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
precision(pre) int createqueryedit
Specifies the maximum number of digits displayed to the right of the decimal place. Can be 0 to 20.
removeTab(rt) string edit
Removes the tab based on the set provided
selected(sl) boolean query
Returns a list of strings, containing the labels of the currently selected columns
selectionConnection(slc) string createqueryedit
Specifies the name of a selectionConnection object that the editor will synchronize with its own selection list. As the user selects things in this editor, they will be selected in the selectionConnection object. If the object undergoes changes, the editor updates to show the changes.
setOperationLabel(sol) [int, string] edit
uses the string as the new name for the existing operation type specified by the integer index. Note that there is no messaging system which allows UI to be informed of changes made by this flag.
showObjects(so) boolean create
Restricts the display to columns that are in the current active list.
showSelected(ss) boolean createedit
Restricts the display to those columns which are currently selected. By default this flag is set to false, so all columns are selected. The results from this flag obey the current -hideZeroColumns setting.
sortAlpha(sa) boolean createqueryedit
Controls alphabetical (true), or hierarchical sorting of columns
stateString(sts) boolean query
Query only flag. Returns the MEL command that will create an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.
unParent(up) boolean createedit
Specifies that the editor should be removed from its layout. This cannot be used in query mode.
unlockMainConnection(ulk) boolean createedit
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection(upd) boolean createedit
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# componentEditorWindow is a MEL procedure so need to call through MEL.
import maya.mel
maya.mel.eval('componentEditorWindow()')
cmds.componentEditor( 'componentEditorWinComponEditor', q=True, ctl=True )