animLayer

Go to: Synopsis. Return value. Keywords. Related. Flags. Python examples.

Synopsis

animLayer([addRelatedKG=boolean], [addSelectedObjects=boolean], [affectedLayers=boolean], [affectedLayersAttribute=string], [animCurves=boolean], [attribute=string], [baseAnimCurves=boolean], [bestAnimLayer=boolean], [bestLayer=boolean], [blendNodes=boolean], [children=string], [collapse=boolean], [copy=string], [copyAnimation=string], [copyNoAnimation=string], [excludeBoolean=boolean], [excludeDynamic=boolean], [excludeEnum=boolean], [excludeProxy=boolean], [excludeRotate=boolean], [excludeScale=boolean], [excludeTranslate=boolean], [excludeVisibility=boolean], [exists=boolean], [extractAnimation=string], [findCurveForPlug=string], [forceUIRebuild=boolean], [forceUIRefresh=boolean], [layeredPlug=string], [lock=boolean], [maxLayers=boolean], [moveLayerAfter=string], [moveLayerBefore=string], [mute=boolean], [override=boolean], [parent=string], [passthrough=boolean], [preferred=boolean], [removeAllAttributes=boolean], [removeAttribute=string], [removeSelectedObjects=boolean], [root=string], [selected=boolean], [solo=boolean], [weight=float], [writeBlendnodeDestinations=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

animLayer is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Keywords

Related

Flags

Long name (short name)	Argument types	Properties
addRelatedKG(akg)	boolean
When adding or removing selected object(s) from the layer, adds associated keying group(s) to the object(s).
addSelectedObjects(aso)	boolean
Adds selected object(s) to the layer.
affectedLayers(afl)	boolean
Return the layers that the currently selected object(s) are members of
affectedLayersAttribute(afa) 2025.1	string
Specify attributes when querying for affected layers. In query mode, this flag needs a value.
animCurves(anc)	boolean
In query mode returns the anim curves associated with this layer
attribute(at)	string
Adds a specific attribute on a object to the layer.
baseAnimCurves(bac)	boolean
In query mode returns the base layer anim curves associated with this layer, if any.
bestAnimLayer(blr)	boolean
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)	boolean
Return the layer that will be keyed for specified attribute.
blendNodes(bld)	boolean
In query mode returns the blend nodes associated with this layer
children(c)	string
Get the list of children layers. Return value is a string array.
collapse(col)	boolean
Determine if a layer is collapse in the layer editor.
copy(cp)	string
Copy from the layer.
copyAnimation(ca)	string
Copy animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.
copyNoAnimation(cna)	string
Copy from layer without the animation curves.
excludeBoolean(ebl)	boolean
When adding or removing selected object(s) from the layer, excludes any boolean attributes.
excludeDynamic(edn)	boolean
When adding or removing selected object(s) from the layer, excludes any dynamic attributes.
excludeEnum(een)	boolean
When adding or removing selected object(s) from the layer, excludes any enum attributes.
excludeProxy(epr)	boolean
When adding or removing selected object(s) from the layer, excludes any proxy attributes.
excludeRotate(ert)	boolean
When adding or removing selected object(s) from the layer, excludes the rotate attribute.
excludeScale(esc)	boolean
When adding or removing selected object(s) from the layer, excludes the scale attribute.
excludeTranslate(etr)	boolean
When adding or removing selected object(s) from the layer, excludes the translate attribute.
excludeVisibility(evs)	boolean
When adding or removing selected object(s) from the layer, excludes the visibility attribute.
exists(ex)	boolean
Determine if a layer exists.
extractAnimation(ea)	string
Transfer animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.
findCurveForPlug(fcv)	string
Finds the parameter curve containing the animation data for the specified plug on the given layer. In query mode, this flag needs a value.
forceUIRebuild(fur)	boolean
Rebuilds the animation layers user interface.
forceUIRefresh(uir)	boolean
Refreshes the animation layers user interface.
layeredPlug(lp)	string
Returns the plug on the blend node corresponding to the specified layer In query mode, this flag needs a value.
lock(l)	boolean
Set the lock state of the specified layer. A locked layer cannot receive key. Default is false.
maxLayers(ml)	boolean
Returns the maximum number of anim layers supported by this product.
moveLayerAfter(mva)	string
Move layer after the specified layer
moveLayerBefore(mvb)	string
Move layer before the specified layer
mute(m)	boolean
Set the mute state of the specified layer. Default is false.
override(o)	boolean
Set the overide state of the specified layer. Default is false.
parent(p)	string
Set the parent of the specified layer. Default is the animation layer root.
passthrough(pth)	boolean
Set the passthrough state of the specified layer. Default is true.
preferred(prf)	boolean
Determine if a layer is a preferred layer, the best layer algorithm will try to set keyframe in preferred layer first.
removeAllAttributes(raa)	boolean
Remove all objects from the layer.
removeAttribute(ra)	string
Remove object from the layer.
removeSelectedObjects(rso)	boolean
Removes selected object(s) from the layer.
root(r)	string
Return the base layer if it exist
selected(sel)	boolean
Determine if a layer is selected, a selected layer will be show in the timecontrol, graph editor.
solo(s)	boolean
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)	boolean
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.

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 have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds


cmds.animLayer("layer1", mute=True, solo=True, override=True, passthrough=False, lock=True)

cmds.animLayer("layer1", query=True, mute=True)
# Result: 1 #

cmds.animLayer("layer1", query=True, solo=True)
# Result: 1 #

cmds.animLayer("layer1", query=True, override=True)
# Result: 1 #

cmds.animLayer("layer1", query=True, passthrough=True)
# Result: 0 #

cmds.animLayer("layer1", query=True, lock=True)
# Result: 1 #

cmds.animLayer("layer1", query=True, parent=True)
# Result: BaseAnimation #