OpenMayaAnim.MAnimUtil Class Reference

Inheritance diagram for OpenMayaAnim.MAnimUtil:

Static Public Member Functions
def	findAnimatablePlugs ()
def	findAnimatedPlugs ()
def	findAnimation ()
def	findConstraint ()
def	findSetDrivenKeyAnimation ()
def	isAnimated ()

Detailed Description

Static class providing common animation helper methods.

Member Function Documentation

def OpenMayaAnim.MAnimUtil.findAnimatablePlugs ( )

static

findAnimatablePlugs(MSelectionList) -> MPlugArray

Find the list of attributes (MPlugs) on any member of an MSelectionList
that is animatable.

In addition to normal objects, components such as mesh vertices or
faces can be easily described on an MSelectionList, making this a
good way to determine if parts of a shape are animatable or not.

def OpenMayaAnim.MAnimUtil.findAnimatedPlugs ( )

static

findAnimatedPlugs(MObject, bool) -> MPlugArray
findAnimatedPlugs(MDagPath, bool) -> MPlugArray
findAnimatedPlugs(MSelectionList selectionList, bool checkParent) -> MPlugArray

Find the list of attributes (MPlugs) on the input object that is animated.

def OpenMayaAnim.MAnimUtil.findAnimation ( )

static

findAnimation(MPlug) -> MObjectArray

Find the animCurve(s) that are animating a given attribute (MPlug).
In most cases an attribute is animated by a single animCurve and so
just that animCurve will be returned.  It is possible to setup a
series of connections where an attribute is animated by more than
one animCurve, although Maya does not currently offer a UI to do so.
Compound attributes are not expanded to include any child attributes.

def OpenMayaAnim.MAnimUtil.findConstraint ( )

static

findConstraint(Mplug) -> (MObject, MObjectArray)

Find any constraint that is directly driving the specified attribute.
If a constraint is found, this method will also find the constraint
targets. Return false if no constraint exists on the attribute.

Compound attributes are not expanded to include any child attributes.

def OpenMayaAnim.MAnimUtil.findSetDrivenKeyAnimation ( )

static

findSetDrivenKeyAnimation(MPlug) -> (MObjectArray, MPlugArray)

Find any driven keyframe animCurves, the blendWeighted node and the
driver attribute(s) that are animating a given attribute (MPlug).
Or return false if no driven keyframe exists on the attribute.

A driven keyframe is similar to a regular keyframe. However, while a
standard keyframe always has an x-axis of time in the graph editor,
for a drivenkeyframe the user may choose any attribute
as the x-axis of the graph editor. This attribute is called the driver.

In the case where there is only one driver, the animation curve
will be connected directly to the driven attribute. When there are
multiple drivers, the driven keyframe animCurves feed into a
blendWeighted node which drives the attribute.

Compound attributes are not expanded to include any child attributes.

def OpenMayaAnim.MAnimUtil.isAnimated ( )

static

isAnimated(MObject, bool) -> bool
isAnimated(MDagPath, bool) -> bool
isAnimated(MPlug, bool) -> bool
isAnimated(MSelectionList selectionList, bool checkParent) -> bool

Determine whether or not an MObject is animated.
If the MObject is a hierarchical object (such as a dag node) then
you may also specify whether or not the input object's parents are examined.