timeEditorPanel

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

Synopsis

timeEditorPanel [-activeClipEditMode int] [-activeTabRootClipId] [-activeTabTime] [-activeTabView int] [-autoFit string] [-autoFitTime string] [-control] [-defineTemplate string] [-displayActiveKeyTangents string] [-displayActiveKeys string] [-displayInfinities string] [-displayKeys string] [-displayTangents string] [-displayValues string] [-docTag string] [-exists] [-filter string] [-forceMainConnection string] [-groupIdForTabView int] [-highlightConnection string] [-keyingTarget int] [-layerId int] [-lockMainConnection] [-lookAt string] [-mainListConnection string] [-menu script] [-minClipWidth int] [-panel string] [-parent string] [-selectionConnection string] [-setToPrevClipEditMode] [-snapTime string] [-snapToClip boolean] [-snapToFrame boolean] [-snapTolerance int] [-snapValue string] [-stateString] [-tabView int] [-timeCursor boolean] [-unParent] [-unlockMainConnection] [-updateMainConnection] [-useTemplate string] editorName

timeEditorPanel 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
-activeClipEditMode(-ace)	int
Set the appropriate clip edit mode for the editor. 0: Default Mode 1: Trim Mode 2: Scale Mode 3: Loop Mode 4: Hold Mode
-activeTabRootClipId(-atr)
Get the clip id for which current active tab has been opened. In case of main tab, this will return -1 meaning there is no root clip.
-activeTabTime(-att)
Get current time displayed inside the active tab. This will be global time in case of the main tab and local time for others.
-activeTabView(-atv)	int
Get/set the index of the tab widget's (active) visible tab. Note: the index is zero-based.
-autoFit(-af)	string
on | off | tgl Auto fit-to-view.
-autoFitTime(-aft)	string
on | off | tgl Auto fit-to-view along the time axis, as well.
-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 for an editor to exist without a control. The query will return "NONE" if no control is present.
-defineTemplate(-dt)	string
Puts the command in a mode where any other flags and arguments 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.
-displayActiveKeyTangents(-dat)	string
on | off | tgl Display active key tangents in the editor.
-displayActiveKeys(-dak)	string
on | off | tgl Display active keys in the editor.
-displayInfinities(-di)	string
on | off | tgl Display infinities in the editor.
-displayKeys(-dk)	string
on | off | tgl Display keyframes in the editor.
-displayTangents(-dtn)	string
on | off | tgl Display tangents in the editor.
-displayValues(-dv)	string
on | off | tgl Display active keys and tangents values in the editor.
-docTag(-dtg)	string
Attaches a tag to the editor.
-exists(-ex)
Returns whether the specified object exists or not. Other flags are ignored.
-filter(-f)	string
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.
-forceMainConnection(-fmc)	string
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.
-groupIdForTabView(-gtv)	int
Get the group clip id for the given tab view index. To specify the tab index, this flag must appear before the -query flag. In query mode, this flag needs a value.
-highlightConnection(-hlc)	string
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.
-keyingTarget(-kt)	int
Set keying target to specified clip ID. If keying into layer, '-layer' flag must be used. In query mode, the clip id is omitted, and the name of the keying target will be returned.
-layerId(-l)	int
Indicate layer ID of keying target.
-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.
-lookAt(-la)	string
all | selected | currentTime FitView helpers.
-mainListConnection(-mlc)	string
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.
-menu(-m)	script
Specify a script to be run when the editor is created. The function will be passed one string argument which is the new editor's name.
-minClipWidth(-mcw)	int
Set the minimum clip width.
-panel(-pnl)	string
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
Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
-selectionConnection(-slc)	string
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.
-setToPrevClipEditMode(-spe)
Revert to previous clip edit mode.
-snapTime(-st)	string
none | integer | keyframe Keyframe move snap in time.
-snapToClip(-stc)	boolean
Enable/Disable snap-to-clip option in Time Editor while manipulating and drag-and-drop clips. When snapToClip is on all manipulated timing will land on a clip boundary if it is close to it.
-snapToFrame(-stf)	boolean
Enable/Disable snap-to-frame option in Time Editor while manipulating and drag-and-drop clips. When snapToFrame is on all manipulated timing will land on an exact frame.
-snapTolerance(-sto)	int
Set the tolerance value for snapping.
-snapValue(-sv)	string
none | integer | keyframe Keyframe move snap in values.
-stateString(-sts)
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.
-tabView(-tv)	int
Create a tab view for the given group clip ID.
-timeCursor(-tc)	boolean
Activate the time cursor in Time Editor for scrubbing.
-unParent(-up)
Specifies that the editor should be removed from its layout. This cannot be used in query mode.
-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.
-useTemplate(-ut)	string
Forces 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 be used more than once in a command.

MEL examples

// Check to see if the "default" time editor has been created
//
timeEditorPanel -exists timeEditorPanel1TimeEd;

// Open the group(id=1) in local time tab
//
timeEditorPanel -e -tabView 1 timeEditorPanel1TimeEd;

// Query the current active tab view
//
timeEditorPanel -q -activeTabView timeEditorPanel1TimeEd;

// Query the current time inside active tab view
//
timeEditorPanel -q -activeTabTime timeEditorPanel1TimeEd;

// Query the corresponding group given the tab view index
//
timeEditorPanel -groupIdForTabView 0 -q timeEditorPanel1TimeEd;