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:
  • addSelectedObjects : aso (bool) [create,query,edit]

    Adds selected object(s) to the layer.

  • affectedLayers : afl (bool) [query]

    Return the layers that the currently selected object(s) are members of

  • animCurves : anc (bool) [create,query,edit]

    In query mode returns the anim curves associated with this layer

  • attribute : at (unicode) [create,query,edit]

    Adds a specific attribute on a object to the layer.

  • baseAnimCurves : bac (bool) [create,query,edit]

    In query mode returns the base layer anim curves associated with this layer, if any.

  • bestAnimLayer : blr (bool) [create,query,edit]

    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) [query]

    Return the layer that will be keyed for specified attribute.

  • blendNodes : bld (bool) [create,query,edit]

    In query mode returns the blend nodes associated with this layer

  • children : c (unicode) [query]

    Get the list of children layers. return value is a string array.

  • collapse : col (bool) [create,query,edit]

    Determine if a layer is collapse in the layer editor.

  • copy : cp (unicode) [edit]

    Copy from layer.

  • copyAnimation : ca (unicode) [create,edit]

    copy animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.

  • copyNoAnimation : cna (unicode) [edit]

    Copy from layer without the animation curves.

  • excludeBoolean : ebl (bool) [create,query,edit]

    When adding selected object(s) to the layer, excludes any boolean attributes.

  • excludeDynamic : edn (bool) [create,query,edit]

    When adding selected object(s) to the layer, excludes any dynamic attributes.

  • excludeEnum : een (bool) [create,query,edit]

    When adding selected object(s) to the layer, excludes any enum attributes.

  • excludeRotate : ert (bool) [create,query,edit]

    When adding selected object(s) to the layer, exclude the rotate attribute.

  • excludeScale : esc (bool) [create,query,edit]

    When adding selected object(s) to the layer, exclude the scale attribute.

  • excludeTranslate : etr (bool) [create,query,edit]

    When adding selected object(s) to the layer, excludes the translate attribute.

  • excludeVisibility : evs (bool) [create,query,edit]

    When adding selected object(s) to the layer, exclude the visibility attribute.

  • exists : ex (bool) [query]

    Determine if an layer exists.

  • extractAnimation : ea (unicode) [create,edit]

    transfer animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.

  • forceUIRebuild : fur (bool) [create]

    rebuilds the animation layers user interface. Flag can have multiple arguments, passed either as a tuple or a list.

  • forceUIRefresh : uir (bool) [create]

    refreshes the animation layers user interface.

  • layeredPlug : lp (unicode) [query]

    returns the plug on the blend node corresponding to the specified layer

  • lock : l (bool) [create,query,edit]

    Set the lock state of the specified layer. A locked layer can not receive key. Default is false.

  • moveLayerAfter : mva (unicode) [edit]

    Move layer after the specified layer

  • moveLayerBefore : mvb (unicode) [edit]

    Move layer before the specified layer

  • mute : m (bool) [create,query,edit]

    Set the mute state of the specified layer. Default is false.

  • override : o (bool) [create,query,edit]

    Set the overide state of the specified layer. Default is false.

  • parent : p (unicode) [create,query,edit]

    Set the parent of the specified layer. Default is the animation layer root.

  • passthrough : pth (bool) [create,query,edit]

    Set the passthrough state of the specified layer. Default is true.

  • preferred : prf (bool) [create,query,edit]

    Determine if a layer is a preferred layer, the best layer algorithm will try to set keyframe in preferred layer first.

  • removeAllAttributes : raa (bool) [edit]

    Remove all objects from layer.

  • removeAttribute : ra (unicode) [edit]

    Remove object from layer.

  • root : r (unicode) [query]

    Return the base layer if it exist

  • selected : sel (bool) [create,query,edit]

    Determine if a layer is selected, a selected layer will be show in the timecontrol, graph editor.

  • solo : s (bool) [create,query,edit]

    Set the solo state of the specified layer. Default is false.

  • weight : w (float) [create,query,edit]

    Set the weight of the specified layer between 0.0 and 1.0. Default is 1.

  • writeBlendnodeDestinations : wbd (bool) [edit]

    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

Previous topic

pymel.core.animation.animDisplay

Next topic

pymel.core.animation.animView

Core

Core Modules

Other Modules

This Page