pymel.core.animation.animCurveEditor¶

animCurveEditor(*args, **kwargs)¶

Edit a characteristic of a graph editor

Flags:

Long Name / Short Name		Argument Types	Properties
acs / acs		areCurvesSelected
areCurvesSelected / acs		bool
	Returns a boolean to know if at least one curve is selected in the graph editor.
autoFit / af		unicode
	on | off | tgl Auto fit-to-view.
classicMode / cm		bool
	When on, the graph editor is displayed in Classic Mode, otherwise Suites Modeis used.
clipTime / ct		unicode
	Valid values: onoffDisplay the clips with their offset and scale applied to the anim curves in the clip.
constrainDrag / cd		int
	Constrains all Graph Editor animation curve drag operations to either the X-axis, the Y-axis, or to neither of those axes. Values to supply are: 0 for not constraining any axis, 1 for constraing the X-axis, or 2 for constraining the Y-axis. When used in queries, this flag returns the latter values and these values have the same interpretation as above. Note: when the shift key is pressed before dragging the animation curve, the first mouse movement will instead determine (and override) any prior set constrained axis.
control / ctl		bool
	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 NONEif no control is present.
curvesShown / cs		bool
	Returns a string array containing the names of the animCurve nodes currently displayed in the graph editor.
curvesShownForceUpdate / csf		bool
	Returns a string array containing the names of the animCurve nodes currently displayed in the graph editor. Unlike the curvesShown flag, this will force an update of the graph editor for the case where the mainListConnection has been modified since the last refresh.
defineTemplate / dt		unicode
	Puts the 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.
denormalizeCurvesCommand / dcc		unicode
	Sets the script that is run to denormalize curves in the graph editor. This is intended for internal use only.
displayActiveKeyTangents / dat		unicode
	on | off | tgl Display active key tangents in the editor.
displayActiveKeys / dak		unicode
	on | off | tgl Display active keys in the editor.
displayInfinities / di		unicode
	on | off | tgl Display infinities in the editor.
displayKeys / dk		unicode
	on | off | tgl Display keyframes in the editor.
displayNormalized / dn		bool
	When on, display all curves normalized to the range -1 to +1.
displayTangents / dtn		unicode
	on | off | tgl Display tangents in the editor.
displayValues / dv		unicode
	on | off | tgl Display active keys and tangents values in the editor.
docTag / dtg		unicode
	Attaches a tag to the editor.
exists / ex		bool
	Returns whether the specified object exists or not. Other flags are ignored.
filter / f		unicode
	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		unicode
	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.
highlightConnection / hlc		unicode
	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.
keyingTime / kt		unicode
	The current time in the given curve to be keyed in the graph editor.
lockMainConnection / lck		bool
	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
	all | selected | currentTime FitView helpers.
mainListConnection / mlc		unicode
	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.
normalizeCurvesCommand / ncc		unicode
	Sets the script that is run to normalize curves in the graph editor. This is intended for internal use only.
outliner / o		unicode
	The name of the outliner that is associated with the graph editor.
panel / pnl		unicode
	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		unicode
	Specifies the parent layout for this editor. This flag will only have an effect if the editor is currently un-parented.
preSelectionHighlight / psh		bool
	When on, the curve/key/tangent under the mouse pointer is highlighted to ease selection.
renormalizeCurves / rnc		bool
	This flag causes the curve normalization factors to be recalculated.
resultSamples / rs		time
	Specify the sampling for result curves Note: the smaller this number is, the longer it will take to update the display.
resultScreenSamples / rss		int
	Specify the screen base result sampling for result curves. If 0, then results are sampled in time.
resultUpdate / ru		unicode
	Valid values: interactivedelayedControls how changes to animCurves are reflected in the result curves (if results are being shown). If resultUpdate is interactive, then as interactive changes are being made to the animCurve, the result curves will be updated. If modelUpdate is delayed (which is the default setting), then result curves are updated once the final change to an animCurve has been made.
selectionConnection / slc		unicode
	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.
showActiveCurveNames / acn		bool
	Display the active curve(s)’s name.
showBufferCurves / sb		unicode
	Valid values: onofftglDisplay buffer curves.
showCurveNames / scn		bool
	Display the curves’s name.
showResults / sr		unicode
	Valid values: onofftglDisplay result curves from expression or other non-keyed action.
showUpstreamCurves / suc		bool
	If true, the dependency graph is searched upstream for all curves that drive the selected plugs (showing multiple curves for example in a typical driven key setup, where first the driven key curve is encountered, followed by the actual animation curve that drives the source object). If false, only the first curves encountered will be shown. Note that, even if false, multiple curves can be shown if e.g. a blendWeighted node is being used to combine multiple curves.
smoothness / s		unicode
	Valid values: coarseroughmediumfineSpecify the display smoothness of animation curves.
snapTime / st		unicode
	none | integer | keyframe Keyframe move snap in time.
snapValue / sv		unicode
	none | integer | keyframe Keyframe move snap in values.
stackedCurves / sc		bool
	Switches the display mode between normal (all curves sharing one set of axes) to stacked (each curve on its own value axis, stacked vertically).
stackedCurvesMax / scx		float
	Sets the maximum value on the per-curve value axis when in stacked mode.
stackedCurvesMin / scm		float
	Sets the minimum value on the per-curve value axis when in stacked mode.
stackedCurvesSpace / scs		float
	Sets the spacing between curves when in stacked mode.
stateString / sts		bool
	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.
unParent / up		bool
	Specifies that the editor should be removed from its layout. This cannot be used in query mode.
unlockMainConnection / ulk		bool
	Unlocks the mainConnection, effectively restoring the original mainConnection (if it is still available), and dynamic updates.
updateMainConnection / upd		bool
	Causes a locked mainConnection to be updated from the orginal mainConnection, but preserves the lock state.
useTemplate / ut		unicode
	Forces the command to use a command template other than the current one.
valueLinesToggle / vlt		unicode
	on | off | tgl Display the value lines for high/low/zero of selected curves in the editor Flag can have multiple arguments, passed either as a tuple or a list.
viewLeft / vl		float
viewRight / vr		float

Derived from mel command maya.cmds.animCurveEditor

Example:

import pymel.core as pm

# Check to see if the "default" graph editor has been created
#
pm.animCurveEditor( 'graphEditor1GraphEd', exists=True )
# Result: True #
# Show result curves
#
pm.animCurveEditor( 'graphEditor1GraphEd', edit=True, showResults='on' )
# Result: u'graphEditor1GraphEd' #
# Decrease the sampling rate for the result curves
#
pm.animCurveEditor( 'graphEditor1GraphEd', edit=True, resultSamples=5 )
# Result: u'graphEditor1GraphEd' #

# Constrain all Graph Editor animation curve traversals to the X-axis
#
pm.animCurveEditor( 'graphEditor1GraphEd', edit=True, constrainDrag=1 )
# Result: u'graphEditor1GraphEd' #