Go to: Return value. Related commands. Flags. Examples.

Synopsis

keyframeOutliner [flags] outlinerName

This command creates/edits/queries a keyframe outliner control.

Return value

string The name of the outliner control.

Related commands

copyKey, cutKey, pasteKey, snapKey, keyframe, keyframeStats, scaleKey, setInfinity, keyTangent, findKeyframe

Flags

animCurve, annotation, backgroundColor, defineTemplate, display, docTag, dragCallback, dropCallback, edit, enable, exists, height, isObscured, manage, numberOfPopupMenus, parent, popupMenuArray, preventOverride, query, useTemplate, visible, width

Long name (short name)[argument types]Properties
-query (-q) query
Puts the command in query mode so that it will return the value of the specified flag.
-edit (-e) edit
Puts the command in edit mode so that it will change the values of the specified flags
-exists (-ex) create
Returns true|false depending upon whether the specified object exists. Other flags are ignored.
-defineTemplate (-dt) stringcreate
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) stringcreate
Will force the command to use a command template other than the current one.
-parent (-p) stringcreate
The parent layout for this control.
-enable (-en) booleanquerycreateedit
The enable state of the control. By default, this flag is set to true and the control is enabled. Specify false and the control will appear dimmed or greyed-out indicating it is disabled.
-width (-w) intquerycreateedit
The width of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-height (-h) intquerycreateedit
The height of the control. The control will attempt to be this size if it is not overruled by parent layout conditions.
-visible (-vis) booleanquerycreateedit
The visible state of the control. A control is created visible by default. Note that a control's actual appearance is also dependent on the visible state of its parent layout(s).
-isObscured (-io) query
Return whether the control can actually be seen by the user. The control will be obscured if its state is invisible, if it is blocked (entirely or partially) by some other control, if it or a parent layout is unmanaged, or if the control's window is invisible or iconified.
-manage (-m) booleanquerycreateedit
Manage state of the control. An unmanaged control is not visible, nor does it take up any screen real estate. All controls are created managed by default.
-numberOfPopupMenus (-npm) query
Return the number of popup menus attached to this control.
-popupMenuArray (-pma) query
Return the names of all the popup menus attached to this control.
-preventOverride (-po) booleanquerycreateedit
If true, this flag disallows overriding the control's attribute via the control's right mouse button menu.
-annotation (-ann) stringquerycreateedit
Annotate the control with an extra string value.
-backgroundColor (-bgc) float float floatcreateedit
The background color of the control. The arguments correspond to the red, green, and blue color components. Each component ranges in value from 0.0 to 1.0. (Windows only flag)
-docTag (-dt) querycreateedit
Add a documentation flag to the control. The documentation flag has a directory structure like hierarchy. Eg. -dt render/multiLister/createNode/material
-dragCallback (-dgc) stringcreateedit
Adds a callback that is called when the middle mouse button is pressed. The callback is of the form:

global proc string[] callbackName(string $dragControl, int $x, int $y, int $mods)

The proc returns a string array that is transferred to the drop site. By convention the first string in the array describes the user settable message type. Controls that are application defined drag sources may ignore the callback. $mods allows testing for the key modifiers CTL and SHIFT. Possible values are 0 == No modifiers, 1 == SHIFT, 2 == CTL, 3 == CTL + SHIFT.

-dropCallback (-dpc) stringcreateedit
Adds a callback that is called when a drag and drop operation is released above the drop site. The callback is of the form:

global proc callbackName(string $dragControl, string $dropControl, string $msgs[], int $x, int $y, int $type)

The proc receives a string array that is transferred from the drag source. The first string in the msgs array describes the user defined message type. Controls that are application defined drop sites may ignore the callback. $type can have values of 1 == Move, 2 == Copy, 3 == Link.

-animCurve (-ac) stringedit
Name of the animation curve for which to display keyframes.
-display (-dsp) stringqueryedit
narrow | wide What columns to display. When "narrow", time and value will be displayed, when "wide" tangent information will be displayed as well
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

Examples

		window -rtf 0 -width 200 "myWindow";
		formLayout "myForm";
		keyframeOutliner -animCurve animCurve1 "myOutliner";
		formLayout -e
			-af myOutliner top 0 -af myOutliner left 0 -af myOutliner bottom 0
			-af myOutliner right 0 myForm;
		showWindow;