class MFnKeyframeDelta

Jump to documentation

Inheritance:

MFnKeyframeDelta < MFnBase

public members:

	MFnKeyframeDelta ()
	MFnKeyframeDelta ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnKeyframeDelta ()
virtual MFn::Type	type () const
MObject	paramCurve ( MStatus * ReturnStatus = NULL ) const
virtual unsigned int	keyIndex ( MStatus * ReturnStatus = NULL ) const
	MFnKeyframeDelta ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnBase:

public members:

virtual MFn::Type	type () const
bool	hasObj ( MFn::Type ) const
bool	hasObj ( const MObject & ) const
MObject	object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( MObject & object )
virtual MStatus	setObject ( const MObject & object )

Documentation

Description

Base function set for all keyframe delta objects. A keyframe delta object is generated from the MAnimMessage::addAnimKeyframeEditedCallback.

Functions

MFnKeyframeDelta:: MFnKeyframeDelta ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnKeyframeDelta:: MFnKeyframeDelta ( MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given MObject.

Arguments

• object the MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnKeyframeDelta:: MFnKeyframeDelta ( const MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MObject.

Arguments

• object the const MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnKeyframeDelta:: ~MFnKeyframeDelta ()

Description

The class destructor.

MFn::Type MFnKeyframeDelta:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDelta

MObject MFnKeyframeDelta:: paramCurve ( MStatus *ReturnStatus ) const

Description

Return the Animation Curve MObject that this key belongs to.

Arguments

• ReturnStatus Return code.

Return Values

• a MObject, readable by MFnAnimCurve.

Status Codes

• MS::kSuccess The operation succeeded.
• MS::kFailure An object error has occurred.

unsigned int MFnKeyframeDelta:: keyIndex ( MStatus *ReturnStatus ) const

Description

The index of this key on the animation curve.

Arguments

• ReturnStatus Return code.

Return Values

• an unsigned int representing the position of the key on the curve.

Status Codes

• MS::kSuccess The operation succeeded.
• MS::kFailure An object error has occurred.
• MS::kInvalidParameter key index is not available for this delta object.

Direct child classes:

- MFnKeyframeDeltaWeighted
- MFnKeyframeDeltaTangent
- MFnKeyframeDeltaScale
- MFnKeyframeDeltaMove
- MFnKeyframeDeltaInfType
- MFnKeyframeDeltaBreakdown
- MFnKeyframeDeltaBlockAddRemove
- MFnKeyframeDeltaAddRemove