#include <MFnKeyframeDeltaAddRemove.h>

Class Description

Function set for the addition or removal keys on a curve.

Captures the addition or removal of key on a curve. keyIndex(...) will return the index of the key that was added or removed.

Inheritance diagram for MFnKeyframeDeltaAddRemove:

Public Types
enum	DeltaType { kAdded, kRemoved, kReplaced }
	Type of change. More...

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnKeyframeDeltaAddRemove ()
	Destructor.

	MFnKeyframeDeltaAddRemove ()
	Default constructor.

	MFnKeyframeDeltaAddRemove (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

DeltaType	deltaType (MStatus *ReturnStatus=NULL) const
	Indicates the type of change that this class instance represents. More...

double	value (MStatus *ReturnStatus=NULL) const
	The value of the key that was added or removed. More...

MTime	time (MStatus *ReturnStatus=NULL) const
	The time value of the key that was added or removed. More...

virtual unsigned int	keyIndex (MStatus *ReturnStatus=NULL) const
	The index of this key on the animation curve. More...

double	replacedValue (MStatus *ReturnStatus=NULL) const
	The value of the key that was replaced. More...

	MFnKeyframeDeltaAddRemove (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnKeyframeDelta
virtual	~MFnKeyframeDelta ()
	Destructor.

	MFnKeyframeDelta ()
	Default constructor.

	MFnKeyframeDelta (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	paramCurve (MStatus *ReturnStatus=NULL) const
	Return the Animation Curve MObject that this key belongs to. More...

	MFnKeyframeDelta (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnBase
virtual	~MFnBase ()
	Class Destructor. More...

bool	hasObj (MFn::Type) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

bool	hasObj (const MObject &) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

MObject	object (MStatus *ReturnStatus=NULL) const
	Returns the MObject that is attached to the Function Set. More...

virtual MStatus	setObject (MObject &object)
	Attaches the Function Set to the specified Maya Object. More...

virtual MStatus	setObject (const MObject &object)
	NO SCRIPT SUPPORT. More...

Protected Member Functions
virtual const char *	className () const
	Class name. More...

Additional Inherited Members
Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

Member Enumeration Documentation

enum DeltaType

Type of change.

Enumerator
kAdded	Key added.
kRemoved	Key removed.
kReplaced	Key replaced.

Constructor & Destructor Documentation

MFnKeyframeDeltaAddRemove	(	MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

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

MFnKeyframeDeltaAddRemove	(	const MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

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

Member Function Documentation

MFn::Type type ( ) const

virtual

Function set type.

Return the class type : MFn::kKeyframeDeltaAddRemove.

Reimplemented from MFnKeyframeDelta.

const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnKeyframeDeltaAddRemove".

Reimplemented from MFnKeyframeDelta.

MFnKeyframeDeltaAddRemove::DeltaType deltaType ( MStatus * ReturnStatus = NULL ) const

Indicates the type of change that this class instance represents.

Parameters

[out] ReturnStatus

Returns

kAdded - a key has been added.
kRemoved - a key has been removed.

Status Codes:

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

double value ( MStatus * ReturnStatus = NULL ) const

The value of the key that was added or removed.

Parameters

[out] ReturnStatus Return code.

Returns: A double value

Status Codes:

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

MTime time ( MStatus * ReturnStatus = NULL ) const

The time value of the key that was added or removed.

Parameters

[out] ReturnStatus Return code.

Returns: A MTime value of the added/removed key.

Status Codes:

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

unsigned int keyIndex ( MStatus * ReturnStatus = NULL ) const

virtual

The index of this key on the animation curve.

Note that when keys are added and then moved in a single action, the delta for the added key may refer to a key that no longer exists. In this case, the index returned related to the add operation will be the index where the key would be if it still existed on the curve. For example, if an animation curve has keys at frames 1 and 10, and a key is added at frame 12 and then moved to frame 11 in a single action, when the callback for the addition is received, the key at frame 12 will no longer exist. In this case, the keyIndex returned will be 3, to indicate that the key would be at index 3 if it existed.

Parameters

[out] ReturnStatus Return code.

Returns: 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.

Reimplemented from MFnKeyframeDelta.

double replacedValue ( MStatus * ReturnStatus = NULL ) const

The value of the key that was replaced.

This method is only applicable to the kReplaced operation. Otherwise it will return 0.

Parameters

[out] ReturnStatus Return code.

Returns: A double value

Status Codes:

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

The documentation for this class was generated from the following files:

MFnKeyframeDeltaAddRemove.h
MFnKeyframeDeltaAddRemove.cpp

MFnKeyframeDeltaAddRemove Class Reference

Class Description

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation