class MFnKeyframeDeltaTangent

Jump to documentation

Inheritance:

MFnKeyframeDeltaTangent < MFnKeyframeDelta < MFnBase

public members:

	MFnKeyframeDeltaTangent ()
	MFnKeyframeDeltaTangent ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnKeyframeDeltaTangent ()
virtual MFn::Type	type () const
MFnAnimCurve::TangentType	previousTangentType ( MStatus *ReturnStatus = NULL ) const
MFnAnimCurve::TangentType	currentTangentType ( MStatus *ReturnStatus = NULL ) const
MStatus	getPreviousPosition ( float &x, float &y ) const
MStatus	getCurrentPosition ( float &x, float &y ) const
bool	isInTangent ( MStatus *ReturnStatus = NULL ) const
	MFnKeyframeDeltaTangent ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnKeyframeDelta:

public members:

virtual MFn::Type	type () const
MObject	paramCurve ( MStatus * ReturnStatus = NULL ) const
virtual unsigned int	keyIndex ( MStatus * ReturnStatus = NULL ) const

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

A MFnKeyframeDeltaTangent function allows API programmers to read changes in keyframe tangent values. It captures changes in tangent type, as well as, changes in tangent time/value pair.

MFnKeyframeDeltaTangents are generated by a MAnimMessage::addAnimKeyframeEditedCallback. Because a key's tangent may be unbroken. It is possible to receive to MFnKeyframeDeltaTangent values per key -- one for the incoming tangent and one for the outgoing tangent. The API programmer should use the isInTangent method to determine if the tangent change affects the in-bound tangent or out-bound tangent.

Functions

MFnKeyframeDeltaTangent:: MFnKeyframeDeltaTangent ()

Description

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

MFnKeyframeDeltaTangent:: MFnKeyframeDeltaTangent ( 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

MFnKeyframeDeltaTangent:: MFnKeyframeDeltaTangent ( 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

MFnKeyframeDeltaTangent:: ~MFnKeyframeDeltaTangent ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaTangent:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDeltaTangent

MFnAnimCurve::TangentType MFnKeyframeDeltaTangent:: previousTangentType ( MStatus *ReturnStatus) const

Description

Returns the previous tangent type.

Arguments

• ReturnStatus Return code.

Return Values

• The previous tangent type.

Status Codes

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

MFnAnimCurve::TangentType MFnKeyframeDeltaTangent:: currentTangentType ( MStatus *ReturnStatus) const

Description

Returns the current tangent type that the key represents.

Arguments

• ReturnStatus Return code.

Return Values

• The current tangent type.

Status Codes

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

MStatus MFnKeyframeDeltaTangent:: getPreviousPosition (float &x, float &y) const

Description

Get the values of the previous time/value position of the tangent for this key.

Arguments

• time a MTime object to put the time into.
• val a double to place the value into.

Return Values

• MStatus based on the success or failure of the method.

Status Codes

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

MStatus MFnKeyframeDeltaTangent:: getCurrentPosition ( float &x, float &y) const

Description

Get the values of the current time/value position of the tangent for this key.

Arguments

• time a MTime object to put the time into.
• val a double to place the value into.

Return Values

• a MStatus based on the success or failure of the method.

Status Codes

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

bool MFnKeyframeDeltaTangent:: isInTangent ( MStatus *ReturnStatus) const

Description

Key's have two tangents, in-bound and out-bound. A MFnKeyframeTangent object can created once for each tangent. Use this method to determine which tangent was modified.

Arguments

• ReturnStatus Return code.

Return Values

• true if the incoming tangent was modified. false if the outgoing tangent was modified.

Status Codes

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

This class has no child classes.