pymel.core.windows.clipEditor

clipEditor(*args, **kwargs)

Create a clip editor with the given name.

Flags:
Long name (short name) Argument Types Properties
allTrackHeights (th) int  
 
OBSOLETE flag. Use clipStyle instead.
autoFit (af) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
on | off | tgl auto fit-to-view
characterOutline (co) unicode  
   
clipDropCmd (cd) unicode ../../../_images/edit.gif
 
Command executed when clip node is dropped on the TraX editor
clipStyle (cs) int ../../../_images/query.gif ../../../_images/edit.gif
 
Set/return the clip track style in the specified editor. Default is 2. Valid values are 1-3.
control (ctl) bool ../../../_images/query.gif
 

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 NONEif no control is present.

defineTemplate (dt) unicode ../../../_images/create.gif
 

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.

deleteCmd (dc) unicode ../../../_images/edit.gif
 
Command executed when backspacekey is pressed
deselectAll (da) bool ../../../_images/edit.gif
 
Deselect all clips and blends in the editor.
displayActiveKeyTangents (dat) unicode ../../../_images/edit.gif
 
on | off | tgl display tangents in the editor
displayActiveKeys (dak) unicode ../../../_images/edit.gif
 
on | off | tgl display tangents in the editor
displayInfinities (di) unicode ../../../_images/edit.gif
 
on | off | tgl display infinities in the editor
displayKeys (dk) unicode ../../../_images/edit.gif
 
on | off | tgl display keyframes in the editor
displayTangents (dtn) unicode ../../../_images/edit.gif
 
on | off | tgl display tangents in the editor
docTag (dtg) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Attaches a tag to the Maya editor.
exists (ex) bool ../../../_images/create.gif
 
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
filter (f) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
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.
forceMainConnection (fmc) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

frameAll (fa) bool ../../../_images/edit.gif
 
Frame view around all clips in the editor.
frameRange (fr) float, float ../../../_images/query.gif ../../../_images/edit.gif
 
The editor’s current frame range.
highlightConnection (hlc) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

highlightedBlend (hb) unicode, unicode ../../../_images/query.gif
 
Returns the highlighted blend, listed as scheduler and index
highlightedClip (hc) unicode, unicode ../../../_images/query.gif
 
Returns the highlighted clip, listed as scheduler and index
listAllCharacters (lac) bool ../../../_images/edit.gif
 
List all characters in the editor and outliner.
listCurrentCharacters (lc) bool ../../../_images/edit.gif
 
List only the characters in the editor and outliner.
lockMainConnection (lck) bool ../../../_images/create.gif ../../../_images/edit.gif
 

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.

lookAt (la) unicode ../../../_images/edit.gif
 
all | selected | currentTime fitView helpers
mainListConnection (mlc) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

manageSequencer (ms) bool ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

Sets/returns whether the clip editor should manage sequencer nodes. If so, animation clips and characters are not represented. Flag can have multiple arguments, passed either as a tuple or a list.

menuContext (mc) unicode ../../../_images/query.gif
 

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

panel (pnl) unicode ../../../_images/create.gif ../../../_images/query.gif
 

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) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
selectBlend (sb) unicode, unicode, unicode ../../../_images/query.gif ../../../_images/edit.gif
 

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) unicode, unicode ../../../_images/query.gif ../../../_images/edit.gif
 

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.

selectionConnection (slc) unicode ../../../_images/create.gif ../../../_images/query.gif ../../../_images/edit.gif
 

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.

snapTime (st) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
none | integer | keyframe keyframe move snap in time
snapValue (sv) unicode ../../../_images/query.gif ../../../_images/edit.gif
 
none | integer | keyframe keyframe move snap in values
stateString (sts) bool ../../../_images/query.gif
 

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.

unParent (up) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Specifies that the editor should be removed from its layout. This cannot be used with query.
unlockMainConnection (ulk) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection (upd) bool ../../../_images/create.gif ../../../_images/edit.gif
 
Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
useTemplate (ut) unicode ../../../_images/create.gif
 
Force the command to use a command template other than the current one.

Derived from mel command maya.cmds.clipEditor

Example:

import pymel.core as pm

pm.clipEditor( "clipEditorName" )

Previous topic

pymel.core.windows.checkBoxGrp

Next topic

pymel.core.windows.clipSchedulerOutliner

Core

Core Modules

Other Modules

This Page