pymel.core.animation.animLayer

animLayer(*args, **kwargs)

This command creates and edits animation layers.

Modifications:

• returns a PyNode object for flags: (query and (root or bestLayer or parent))
• returns a list of PyNode objects for flags: (query and (children or attribute or bestAnimLayer or animCurves or baseAnimCurves or blendNodes or affectedLayers or parent))

Flags:

Long name (short name)		Argument Types	Properties
addRelatedKG (akg)		bool
	Used adding attributes to a layer. Determines if associated keying groups should be added or not to the layer.
addSelectedObjects (aso)		bool
	Adds selected object(s) to the layer.
affectedLayers (afl)		bool
	Return the layers that the currently selected object(s) are members of
animCurves (anc)		bool
	In query mode returns the anim curves associated with this layer
attribute (at)		unicode
	Adds a specific attribute on a object to the layer.
baseAnimCurves (bac)		bool
	In query mode returns the base layer anim curves associated with this layer, if any.
bestAnimLayer (blr)		bool
	In query mode returns the best anim layers for keying for the selected objects. If used in conjunction with -at, will return the best anim layers for keying for the specific plugs (attributes) specified.
bestLayer (bl)		bool
	Return the layer that will be keyed for specified attribute.
blendNodes (bld)		bool
	In query mode returns the blend nodes associated with this layer
children (c)		unicode
	Get the list of children layers. return value is a string array.
collapse (col)		bool
	Determine if a layer is collapse in the layer editor.
copy (cp)		unicode
	Copy from layer.
copyAnimation (ca)		unicode
	copy animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.
copyNoAnimation (cna)		unicode
	Copy from layer without the animation curves.
excludeBoolean (ebl)		bool
	When adding selected object(s) to the layer, excludes any boolean attributes.
excludeDynamic (edn)		bool
	When adding selected object(s) to the layer, excludes any dynamic attributes.
excludeEnum (een)		bool
	When adding selected object(s) to the layer, excludes any enum attributes.
excludeRotate (ert)		bool
	When adding selected object(s) to the layer, exclude the rotate attribute.
excludeScale (esc)		bool
	When adding selected object(s) to the layer, exclude the scale attribute.
excludeTranslate (etr)		bool
	When adding selected object(s) to the layer, excludes the translate attribute.
excludeVisibility (evs)		bool
	When adding selected object(s) to the layer, exclude the visibility attribute.
exists (ex)		bool
	Determine if an layer exists.
extractAnimation (ea)		unicode
	transfer animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.
findCurveForPlug (fcv)		unicode
	finds the parameter curve containing the animation data for the specified plug on the given layer.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
forceUIRebuild (fur)		bool
	rebuilds the animation layers user interface.
forceUIRefresh (uir)		bool
	refreshes the animation layers user interface.
layeredPlug (lp)		unicode
	returns the plug on the blend node corresponding to the specified layer
lock (l)		bool
	Set the lock state of the specified layer. A locked layer can not receive key. Default is false.
moveLayerAfter (mva)		unicode
	Move layer after the specified layer
moveLayerBefore (mvb)		unicode
	Move layer before the specified layer
mute (m)		bool
	Set the mute state of the specified layer. Default is false.
override (o)		bool
	Set the overide state of the specified layer. Default is false.
parent (p)		unicode
	Set the parent of the specified layer. Default is the animation layer root.
passthrough (pth)		bool
	Set the passthrough state of the specified layer. Default is true.
preferred (prf)		bool
	Determine if a layer is a preferred layer, the best layer algorithm will try to set keyframe in preferred layer first.
removeAllAttributes (raa)		bool
	Remove all objects from layer.
removeAttribute (ra)		unicode
	Remove object from layer.
root (r)		unicode
	Return the base layer if it exist
selected (sel)		bool
	Determine if a layer is selected, a selected layer will be show in the timecontrol, graph editor.
solo (s)		bool
	Set the solo state of the specified layer. Default is false.
weight (w)		float
	Set the weight of the specified layer between 0.0 and 1.0. Default is 1.
writeBlendnodeDestinations (wbd)		bool
	In edit mode writes the destination plugs of the blend nodes that belong to the layer into the blend node. This is used for layer import/export purposes and is not for general use.

Derived from mel command maya.cmds.animLayer

Example:

import pymel.core as pm

pm.animLayer("layer1", mute=True, solo=True, override=True, passthrough=False, lock=True)
# Result: nt.AnimLayer(u'layer1') #
pm.animLayer("layer1", query=True, mute=True)
# Result: True #
pm.animLayer("layer1", query=True, solo=True)
# Result: True #
pm.animLayer("layer1", query=True, override=True)
# Result: True #
pm.animLayer("layer1", query=True, passthrough=True)
# Result: False #
pm.animLayer("layer1", query=True, lock=True)
# Result: True #
pm.animLayer("layer1", query=True, parent=True)
# Result: nt.AnimLayer(u'BaseAnimation') #