Detailed Description

Keyframe Iterator.

Iterate over the keyframes of a particular Anim Curve Node, and query and edit the keyframe to which the iterator points.

Determine the time and value of the keyframe, as well as the x,y values and type of the tangent to the curve entering (in tangent) and leaving (out tangent) the keyframe.

Set the time and value of the keyframe, and the type of the tangents.

Anim Curves are implemented as Dependency Graph (DG) Nodes. Each Node has multiple ordered and indexed keyframes.

Use the Keyframe Iterator to systematically visit, and query and/or edit the keyframes of a Anim Curve Node.

Use the Keyframe Iterator in conjunction with the Anim Curve Function Set (MFnAnimCurve) to edit Anim Curve Nodes.

On creation the iterator is attached to a Anim Curve Node. The iterator may be detached from its current Node and attached to another Anim Curve Node using the reset() method.

Though keyframes within a Node are ordered and indexed, the iterator maintains the index of the current Node internally and does not export it. Use the Anim Curve Function Set to access the index for a keyframe. The index is zero-based. When an iterator is first attached to a Node, either on creation or reset, the index is set to zero. There is an overloaded version of the reset() method which does not cause the iterator to change Nodes, but merely resets the index.

Use the next(), reset() and isDone() methods to perform iterations.

Use the specific query methods to determine the time, value and tangent information for the keyframe under the iterator.

Use specific edit methods to set the time and value , as well as the incoming and outgoing tangent type (MItKeyframe::TangentType) of the keyframe under the iterator.

There is no method for setting the x,y value of either of the tangents.

Setting the time of a keyframe will fail if the new time would require a re-ordering of the keyframes. Use the Anim Curve Functiion Set methods MFnAnimCurve::remove() and MFnAnimCurve::addKeyFrame() to re-order the keyframes.

#include <MItKeyframe.h>

List of all members.

Public Types
enum	TangentType { kTangentGlobal = 0, kTangentFixed, kTangentLinear, kTangentFlat, kTangentSmooth, kTangentStep, kTangentSlow, kTangentFast, kTangentClamped, kTangentPlateau, kTangentStepNext, kTangentAuto }
	< Tangent types. More...
Public Member Functions
	MItKeyframe (MObject &animCurveNode, MStatus *ReturnStatus=NULL)
	Class Constructor.
	~MItKeyframe ()
	Class Destructor.
MStatus	reset (MObject &animCurveNode)
	Detaches the iterator from the current Anim Curve Node and attaches it to the given Node.
MStatus	reset ()
	Resets the keyframe index to 0 (first keyframe) on the Anim Curve Node to which the iterator is attached.
MStatus	next ()
	Moves to the next keyframe on the Anim Curve Node to which the iterator is attached.
bool	isDone (MStatus *ReturnStatus=NULL)
	Indicates that the iterator has moved beyond the last keyframe on the Anim Curve Node to which the iterator is attached.
MTime	time (MStatus *ReturnStatus=NULL)
	Determines the time of the current keyframe.
MStatus	setTime (MTime time)
	Sets the time of the current keyframe.
double	value (MStatus *ReturnStatus=NULL)
	Determines the value of the current keyframe.
MStatus	setValue (double value)
	Sets the value of the current keyframe.
TangentType	inTangentType (MStatus *ReturnStatus=NULL)
	Determines the type of the tangent to the curve entering the current keyframe.
TangentType	outTangentType (MStatus *ReturnStatus=NULL)
	Determines the type of the tangent to the curve leaving the current keyframe.
MStatus	setInTangentType (TangentType tangentType)
	Sets the type of the tangent to the curve entering the current keyframe.
MStatus	setOutTangentType (TangentType tangentType)
	Sets the type of the tangent to the curve entering the current keyframe.
MStatus	getTangentOut (float &x, float &y)
	Determines the x,y value of the tangent to the curve leaving the current keyframe.
MStatus	getTangentIn (float &x, float &y)
	Determines the x,y value of the tangent to the curve entering the current keyframe.
bool	tangentsLocked (MStatus *ReturnStatus=NULL) const
	Determines whether the tangents are locked at this keyframe.
MStatus	setTangentsLocked (bool locked)
	Lock or unlock the tangents at this keyframe.
Static Public Member Functions
static const char *	className ()
	Returns the name of this class.

kTangentGlobal	Search for all occurrences
kTangentFixed	Normally, if a key is moved tangent values will be adjusted to maintain their relationships to the surrounding keys (linear, smooth, etc). If a tangent is set to be fixed then it will not change when keys are moved but will retain its current value. Search for all occurrences
kTangentLinear	For an in tangent this sets it to point directly at the previous key. For an out tangent it points directly to the next key. This is used to create straight lines between keys. Search for all occurrences
kTangentFlat	The tangent is horizontal. Search for all occurrences
kTangentSmooth	The in and out tangents are colinear and set to provide a smooth transition from the key before to the key after. Search for all occurrences
kTangentStep	The key's value is maintained until the next key is reached whereupon it immediately jumps to the new key's value. Search for all occurrences
kTangentSlow	Slow tangent. Search for all occurrences
kTangentFast	Fast tangent. Search for all occurrences
kTangentClamped	Same as smooth except when two keys are very close together in which case the tangents between them are treated as linear. This corrects for slippage which is sometimes seen when spline tangents are used on keyframes which are close together. Search for all occurrences
kTangentPlateau	Similar to smooth except that minima and maxima between keyframes are flattened, if necessary, to prevent them overshooting their keys. Search for all occurrences
kTangentStepNext	Upon leaving the keyframe the value immediately jumps to that of the next keyframe and stays there. Search for all occurrences
kTangentAuto	The first and last keyframes will have flat tangents. Between, inner keyframes, the animation curve will not over shoot the keyframe values. Search for all occurrences

MItKeyframe	(	MObject &	animCurveNode,
		MStatus *	ReturnStatus = `NULL`
	)

[in]	animCurveNode	Target Node for attachment of iterator
[out]	ReturnStatus	Status Code (see below)

[out]	x	Delta x of the slope of the tangent
[out]	y	Delta y of the slope of the tangent

MItKeyframe Class Reference

OpenMayaAnim - API module for animation

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation