pymel.core.nodetypes.AnimLayer¶
digraph inheritanceef8cde71f2 { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "AnimLayer" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.AnimLayer",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `animLayer`",height=0.25,shape=box,fontsize=8]; "ObjectSet" -> "AnimLayer" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ContainerBase" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.ContainerBase.html#pymel.core.nodetypes.ContainerBase",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DependNode" -> "ContainerBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DependNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DependNode.html#pymel.core.nodetypes.DependNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" -> "DependNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Entity" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.Entity.html#pymel.core.nodetypes.Entity",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "ContainerBase" -> "Entity" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ObjectSet" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.ObjectSet.html#pymel.core.nodetypes.ObjectSet",style="setlinewidth(0.5)",tooltip="The ObjectSet class and `SelectionSet` class work together. Both classes have a very similar interface,",height=0.25,shape=box,fontsize=8]; "Entity" -> "ObjectSet" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProxyUnicode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.util.utilitytypes/pymel.util.utilitytypes.ProxyUnicode.html#pymel.util.utilitytypes.ProxyUnicode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.core.general/pymel.core.general.PyNode.html#pymel.core.general.PyNode",style="setlinewidth(0.5)",tooltip="Abstract class that is base for all pymel nodes classes.",height=0.25,shape=box,fontsize=8]; "ProxyUnicode" -> "PyNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
- class AnimLayer(*args, **kwargs)¶
class counterpart of mel function animLayer
This command creates and edits animation layers.
- Restriction = Enum( EnumValue('Restriction', 0, 'none'), EnumValue('Restriction', 1, 'verticesOnly'), EnumValue('Restriction', 2, 'edgesOnly'), EnumValue('Restriction', 3, 'facetsOnly'), EnumValue('Restriction', 4, 'editPointsOnly'), EnumValue('Restriction', 5, 'renderableOnly'))¶
- addMember(obj)¶
Add a new object (dependency node) to the set.
Parameters: - obj : PyNode
the object to add
Derived from api method maya.OpenMaya.MFnSet.addMember
Undo is not currently supported for this method
- copy(val=True, **kwargs)¶
Copy from layer.
Derived from mel command maya.cmds.animLayer
- copyAnimation(val=True, **kwargs)¶
Copy animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.
Derived from mel command maya.cmds.animLayer
- copyNoAnimation(val=True, **kwargs)¶
Copy from layer without the animation curves.
Derived from mel command maya.cmds.animLayer
- extractAnimation(val=True, **kwargs)¶
Transfer animation from specified layer to destination layer, only animation that are on attribute layered by both layer that are concerned.
Derived from mel command maya.cmds.animLayer
- getAddRelatedKG(**kwargs)¶
Used adding attributes to a layer. Determines if associated keying groups should be added or not to the layer.
Derived from mel command maya.cmds.animLayer
- getAddSelectedObjects(**kwargs)¶
Adds selected object(s) to the layer.
Derived from mel command maya.cmds.animLayer
- getAffectedLayers(**kwargs)¶
Return the layers that the currently selected object(s) are members of
Derived from mel command maya.cmds.animLayer
- getAnimCurves(**kwargs)¶
In query mode returns the anim curves associated with this layer
Derived from mel command maya.cmds.animLayer
- getAttribute()¶
Retrieve the attributes animated on this AnimLayer
- getAttributes()¶
Retrieve the attributes animated on this AnimLayer
- getBaseAnimCurves(**kwargs)¶
In query mode returns the base layer anim curves associated with this layer, if any.
Derived from mel command maya.cmds.animLayer
- getBestAnimLayer(**kwargs)¶
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.
Derived from mel command maya.cmds.animLayer
- getBestLayer(**kwargs)¶
Return the layer that will be keyed for specified attribute.
Derived from mel command maya.cmds.animLayer
- getBlendNodes(**kwargs)¶
In query mode returns the blend nodes associated with this layer
Derived from mel command maya.cmds.animLayer
- getChildren(**kwargs)¶
Get the list of children layers. Return value is a string array.
Derived from mel command maya.cmds.animLayer
- getCollapse(**kwargs)¶
Determine if a layer is collapse in the layer editor.
Derived from mel command maya.cmds.animLayer
- getExcludeBoolean(**kwargs)¶
When adding selected object(s) to the layer, excludes any boolean attributes.
Derived from mel command maya.cmds.animLayer
- getExcludeDynamic(**kwargs)¶
When adding selected object(s) to the layer, excludes any dynamic attributes.
Derived from mel command maya.cmds.animLayer
- getExcludeEnum(**kwargs)¶
When adding selected object(s) to the layer, excludes any enum attributes.
Derived from mel command maya.cmds.animLayer
- getExcludeRotate(**kwargs)¶
When adding selected object(s) to the layer, exclude the rotate attribute.
Derived from mel command maya.cmds.animLayer
- getExcludeScale(**kwargs)¶
When adding selected object(s) to the layer, exclude the scale attribute.
Derived from mel command maya.cmds.animLayer
- getExcludeTranslate(**kwargs)¶
When adding selected object(s) to the layer, excludes the translate attribute.
Derived from mel command maya.cmds.animLayer
- getExcludeVisibility(**kwargs)¶
When adding selected object(s) to the layer, exclude the visibility attribute.
Derived from mel command maya.cmds.animLayer
- getExists(**kwargs)¶
Determine if an layer exists.
Derived from mel command maya.cmds.animLayer
- getFindCurveForPlug(**kwargs)¶
Finds the parameter curve containing the animation data for the specified plug on the given layer.
Derived from mel command maya.cmds.animLayer
- getLayeredPlug(**kwargs)¶
Returns the plug on the blend node corresponding to the specified layer
Derived from mel command maya.cmds.animLayer
- getLock(**kwargs)¶
Set the lock state of the specified layer. A locked layer cannot receive key. Default is false.
Derived from mel command maya.cmds.animLayer
- getMaxLayers(**kwargs)¶
Returns the maximum number of anim layers supported by this product.
Derived from mel command maya.cmds.animLayer
- getMute(**kwargs)¶
Set the mute state of the specified layer. Default is false.
Derived from mel command maya.cmds.animLayer
- getOverride(**kwargs)¶
Set the overide state of the specified layer. Default is false.
Derived from mel command maya.cmds.animLayer
- getParent(**kwargs)¶
Set the parent of the specified layer. Default is the animation layer root.
Derived from mel command maya.cmds.animLayer
- getPassthrough(**kwargs)¶
Set the passthrough state of the specified layer. Default is true.
Derived from mel command maya.cmds.animLayer
- getPreferred(**kwargs)¶
Determine if a layer is a preferred layer, the best layer algorithm will try to set keyframe in preferred layer first.
Derived from mel command maya.cmds.animLayer
- getRoot(**kwargs)¶
Return the base layer if it exist
Derived from mel command maya.cmds.animLayer
- getSelected(**kwargs)¶
Determine if a layer is selected, a selected layer will be show in the timecontrol, graph editor.
Derived from mel command maya.cmds.animLayer
- getSolo(**kwargs)¶
Set the solo state of the specified layer. Default is false.
Derived from mel command maya.cmds.animLayer
- getWeight(**kwargs)¶
Set the weight of the specified layer between 0.0 and 1.0. Default is 1.
Derived from mel command maya.cmds.animLayer
- isMember(object)¶
Returns true if the given object (dependency node) is a member of this set
Parameters: - object : PyNode
object to test for membership
Return type: bool
Derived from api method maya.OpenMaya.MFnSet.isMember
- moveLayerAfter(val=True, **kwargs)¶
Move layer after the specified layer
Derived from mel command maya.cmds.animLayer
- moveLayerBefore(val=True, **kwargs)¶
Move layer before the specified layer
Derived from mel command maya.cmds.animLayer
- removeAllAttributes(val=True, **kwargs)¶
Remove all objects from layer.
Derived from mel command maya.cmds.animLayer
- removeAttribute(val=True, **kwargs)¶
Remove object from layer.
Derived from mel command maya.cmds.animLayer
- removeMember(obj)¶
Remove an object (dependency node) from the set.
Parameters: - obj : PyNode
the object to remove
Derived from api method maya.OpenMaya.MFnSet.removeMember
Undo is not currently supported for this method
- setAddRelatedKG(val=True, **kwargs)¶
Used adding attributes to a layer. Determines if associated keying groups should be added or not to the layer.
Derived from mel command maya.cmds.animLayer
- setAddSelectedObjects(val=True, **kwargs)¶
Adds selected object(s) to the layer.
Derived from mel command maya.cmds.animLayer
- setAnimCurves(val=True, **kwargs)¶
In query mode returns the anim curves associated with this layer
Derived from mel command maya.cmds.animLayer
- setAttribute(val=True, **kwargs)¶
Adds a specific attribute on a object to the layer.
Derived from mel command maya.cmds.animLayer
- setBaseAnimCurves(val=True, **kwargs)¶
In query mode returns the base layer anim curves associated with this layer, if any.
Derived from mel command maya.cmds.animLayer
- setBestAnimLayer(val=True, **kwargs)¶
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.
Derived from mel command maya.cmds.animLayer
- setBlendNodes(val=True, **kwargs)¶
In query mode returns the blend nodes associated with this layer
Derived from mel command maya.cmds.animLayer
- setCollapse(val=True, **kwargs)¶
Determine if a layer is collapse in the layer editor.
Derived from mel command maya.cmds.animLayer
- setExcludeBoolean(val=True, **kwargs)¶
When adding selected object(s) to the layer, excludes any boolean attributes.
Derived from mel command maya.cmds.animLayer
- setExcludeDynamic(val=True, **kwargs)¶
When adding selected object(s) to the layer, excludes any dynamic attributes.
Derived from mel command maya.cmds.animLayer
- setExcludeEnum(val=True, **kwargs)¶
When adding selected object(s) to the layer, excludes any enum attributes.
Derived from mel command maya.cmds.animLayer
- setExcludeRotate(val=True, **kwargs)¶
When adding selected object(s) to the layer, exclude the rotate attribute.
Derived from mel command maya.cmds.animLayer
- setExcludeScale(val=True, **kwargs)¶
When adding selected object(s) to the layer, exclude the scale attribute.
Derived from mel command maya.cmds.animLayer
- setExcludeTranslate(val=True, **kwargs)¶
When adding selected object(s) to the layer, excludes the translate attribute.
Derived from mel command maya.cmds.animLayer
- setExcludeVisibility(val=True, **kwargs)¶
When adding selected object(s) to the layer, exclude the visibility attribute.
Derived from mel command maya.cmds.animLayer
- setFindCurveForPlug(val=True, **kwargs)¶
Finds the parameter curve containing the animation data for the specified plug on the given layer.
Derived from mel command maya.cmds.animLayer
- setLock(val=True, **kwargs)¶
Set the lock state of the specified layer. A locked layer cannot receive key. Default is false.
Derived from mel command maya.cmds.animLayer
- setMute(val=True, **kwargs)¶
Set the mute state of the specified layer. Default is false.
Derived from mel command maya.cmds.animLayer
- setOverride(val=True, **kwargs)¶
Set the overide state of the specified layer. Default is false.
Derived from mel command maya.cmds.animLayer
- setParent(val=True, **kwargs)¶
Set the parent of the specified layer. Default is the animation layer root.
Derived from mel command maya.cmds.animLayer
- setPassthrough(val=True, **kwargs)¶
Set the passthrough state of the specified layer. Default is true.
Derived from mel command maya.cmds.animLayer
- setPreferred(val=True, **kwargs)¶
Determine if a layer is a preferred layer, the best layer algorithm will try to set keyframe in preferred layer first.
Derived from mel command maya.cmds.animLayer
- setSelected(val=True, **kwargs)¶
Determine if a layer is selected, a selected layer will be show in the timecontrol, graph editor.
Derived from mel command maya.cmds.animLayer
- setSolo(val=True, **kwargs)¶
Set the solo state of the specified layer. Default is false.
Derived from mel command maya.cmds.animLayer
- setWeight(val=True, **kwargs)¶
Set the weight of the specified layer between 0.0 and 1.0. Default is 1.
Derived from mel command maya.cmds.animLayer
- writeBlendnodeDestinations(val=True, **kwargs)¶
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 have multiple arguments, passed either as a tuple or a list.
Derived from mel command maya.cmds.animLayer