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

Synopsis

characterOutlineEditor( editorName , [control=boolean], [defineTemplate=string], [docTag=string], [edit=boolean], [exists=boolean], [filter=string], [forceMainConnection=string], [highlightConnection=string], [lockMainConnection=boolean], [mainListConnection=string], [panel=string], [parent=string], [query=boolean], [selectionConnection=string], [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.

characterOutlineEditor is undoable, queryable, and editable.

Flags

control, defineTemplate, docTag, edit, exists, filter, forceMainConnection, highlightConnection, lockMainConnection, mainListConnection, panel, parent, query, selectionConnection, stateString, unParent, unlockMainConnection, updateMainConnection, useTemplate
Long name (short name) [argument types] Properties
query(q) boolean query
Puts the command in query mode so that it will return the value of the specified flag.

In query mode, this flag needs a value.
edit(e) boolean edit
Puts the command in edit mode so that it will change the values of the specified flags
exists(ex) boolean create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
defineTemplate(dt) string create
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 create
Will force the command to use a command template other than the current one.
panel(pnl) string createquery
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.

In query mode, this flag needs a value.
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.

In query mode, this flag needs a value.
unParent(up) boolean createedit
Specifies that the editor should be removed from its layout. This cannot be used with query.
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: editors may not have controls at times. This flag can return "NONE" if no control is present.

In query mode, this flag needs a value.
mainListConnection(mlc) string createqueryedit
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.

In query mode, this flag needs a value.
forceMainConnection(fmc) string createqueryedit
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.

In query mode, this flag needs a value.
selectionConnection(slc) string createqueryedit
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 someone else changes the object, the editor will update to show the change.

In query mode, this flag needs a value.
highlightConnection(hlc) string createqueryedit
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 who do, it is sort of a secondary selection list.

In query mode, this flag needs a value.
filter(f) string createqueryedit
Specifies the name of a filter to be placed on this editor. This filters the information coming onto the main list of the editor.

In query mode, this flag needs a value.
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.
stateString(sts) boolean query
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.

In query mode, this flag needs a value.
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.
docTag(dtg) string createqueryedit
Attaches a tag to the maya editor.

In query mode, this flag needs a value.
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.

Return value


string

Related

bakeClip, character, characterMap, clip, clipEditor, clipSchedule

Python examples

import maya.cmds as cmds

cmds.characterOutlineEditor()