componentEditor

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

Synopsis

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

componentEditor 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
-exists(-ex)
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate(-dt)	string
Puts a 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.
-useTemplate(-ut)	string
Force the command to use a command template other than the current one.
-panel(-pnl)	string
Specifies the panel that the editor belongs to. By default if an editor is created in the create callback of a scripted panel it will belong to that panel. If an editor doesn't belong to a panel it will be deleted when the window that it is in is deleted.
-parent(-p)	string
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
-unParent(-up)
Specifies that the editor should be removed from its layout. This cannot be used with query.
-control(-ctl)
Query only. Returns the top level control for this editor. Usually used for getting a parent to attach popup menus. Caution: It is possible, at times, for an editor to exist without a control. This flag returns "NONE" if no control is present.
-mainListConnection(-mlc)	string
Specifies the name of a selectionConnection object which the editor will use as its source of content. The editor will only display items contained in the selectionConnection object.
-forceMainConnection(-fmc)	string
Specifies the name of a selectionConnection object which 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.
-selectionConnection(-slc)	string
Specifies the name of a selectionConnection object which 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 change.
-highlightConnection(-hlc)	string
Specifies the name of a selectionConnection object which 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.
-filter(-f)	string
Specifies the name of an itemFilter object to be placed on this editor. This filters the information coming onto the main list of the editor.
-lockMainConnection(-lck)
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.
-stateString(-sts)
Query only flag. Returns the MEL command that will edit an editor to match the current editor state. The returned command string uses the string variable $editorName in place of a specific name.
-unlockMainConnection(-ulk)
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
-updateMainConnection(-upd)
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
-docTag(-dtg)	string
Attaches a tag to the Maya editor.
-lockInput(-li)	boolean
Prevents the editor from responding to changes in the active list. Independent of selection connection.
-precision(-pre)	int
Specifies the maximum number of digits displayed to the right of the decimal place. Can be 0 to 20.
-setOperationLabel(-sol)	int string
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.
-operationLabels(-ol)
returns a string array containing the names for all operation types known to the editor.
-operationCount(-oc)
returns the total number of operation types known to the component editor.
-operationType(-ot)	int
Tells the editor which of its known operation types it should be performing. This is a 0-based index.
-hideZeroColumns(-hzc)	boolean
Hides columns whose elements are all zero. By default this flag is set to false.
-sortAlpha(-sa)	boolean
Controls alphabetical (true), or hierarchical sorting of columns
-showObjects(-so)
Restricts the display to columns that are in the current active list.
-showSelected(-ss)	boolean
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.
-floatSlider(-fs)	string
assigns a float slider that the component editor will use for editing groups of values.
-floatField(-ff)	string
assigns a float field that the component editor will use for editing groups of values.
-hidePathName(-hpn)	boolean
Hides path name of displayed element. By default this flag is set to false.
-newTab(-nt)	string string string
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
-removeTab(-rt)	string
Removes the tab based on the set provided
-selected(-sl)
Returns a list of strings, containing the labels of the currently selected columns

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

componentEditorWindow;
componentEditor -q -ctl componentEditorWinComponEditor;