clipEditor

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

Synopsis

clipEditor( editorName , [allTrackHeights=int], [autoFit=string], [characterOutline=string], [clipDropCmd=string], [control=boolean], [defineTemplate=string], [deleteCmd=string], [deselectAll=boolean], [displayActiveKeyTangents=string], [displayActiveKeys=string], [displayInfinities=string], [displayKeys=string], [displayTangents=string], [docTag=string], [exists=boolean], [filter=string], [forceMainConnection=string], [frameAll=boolean], [frameRange=[float, float]], [highlightConnection=string], [highlightedBlend=[string, string]], [highlightedClip=[string, string]], [listAllCharacters=boolean], [listCurrentCharacters=boolean], [lockMainConnection=boolean], [lookAt=string], [mainListConnection=string], [menuContext=string], [panel=string], [parent=string], [selectBlend=[string, string, string]], [selectClip=[string, string]], [selectionConnection=string], [snapTime=string], [snapValue=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.

clipEditor 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)	boolean
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)	boolean
Specifies that the editor should be removed from its layout. This cannot be used with query.
control(ctl)	boolean
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)	boolean
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 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)	boolean
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection(upd)	boolean
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.
displayKeys(dk)	string
on | off | tgl display keyframes in the editor
displayTangents(dtn)	string
on | off | tgl display tangents in the editor
displayActiveKeys(dak)	string
on | off | tgl display tangents in the editor
displayActiveKeyTangents(dat)	string
on | off | tgl display tangents in the editor
displayInfinities(di)	string
on | off | tgl display infinities in the editor
autoFit(af)	string
on | off | tgl auto fit-to-view
lookAt(la)	string
all | selected | currentTime fitView helpers
snapTime(st)	string
none | integer | keyframe keyframe move snap in time
snapValue(sv)	string
none | integer | keyframe keyframe move snap in values
characterOutline(co)	string
Sets/returns the character outline to use with the clip editor
highlightedBlend(hb)	[string, string]
Returns the highlighted blend, listed as scheduler and index
highlightedClip(hc)	[string, string]
Returns the highlighted clip, listed as scheduler and index
selectBlend(sb)	[string, string, string]
Select the blends specified by the scheduler name and the indicies of the two clips used in the blend. When queried, a string containing the scheduler name and the two clip indicies for all of the selected blends is returned.
selectClip(sc)	[string, string]
Selects the clip specified by the scheduler name and the clip index. When queried, a string containing the scheduler and clip index of all of the selected clips is returned.
deselectAll(da)	boolean
Deselect all clips and blends in the editor.
clipDropCmd(cd)	string
Command executed when clip node is dropped on the TraX editor
deleteCmd(dc)	string
Command executed when backspace key is pressed
frameAll(fa)	boolean
Frame view around all clips in the editor.
frameRange(fr)	[float, float]
Frame view around start/end of range
listAllCharacters(lac)	boolean
List all characters in the editor and outliner.
listCurrentCharacters(lc)	boolean
List only the characters in the editor and outliner.
menuContext(mc)	string
Returns a string array denoting the type of data object the cursor is over. Returned values are: {"timeSlider"} {"nothing"} {"track", "track index", "character node name", "group name"} {"clip", "clip node name"}
allTrackHeights(th)	int
Set/return the height of a track in all editors. The value is specified in number of rows. Default is 1. Valid values are 1 or 2.

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

cmds.clipEditor( "clipEditorName" )