class MFnKeyframeDeltaAddRemove

Jump to documentation

Inheritance:

MFnKeyframeDeltaAddRemove < MFnKeyframeDelta < MFnBase

public members:

	MFnKeyframeDeltaAddRemove ()
	MFnKeyframeDeltaAddRemove ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnKeyframeDeltaAddRemove ()
virtual MFn::Type	type () const
enum	DeltaType kAdded kRemoved kReplaced
DeltaType	deltaType ( MStatus *ReturnStatus = NULL ) const
double	value ( MStatus *ReturnStatus = NULL ) const
MTime	time ( MStatus *ReturnStatus = NULL ) const
virtual unsigned int	keyIndex ( MStatus * ReturnStatus = NULL ) const
double	replacedValue ( MStatus *ReturnStatus = NULL ) const
	MFnKeyframeDeltaAddRemove ( 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

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

Functions

MFnKeyframeDeltaAddRemove:: MFnKeyframeDeltaAddRemove ()

Description

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

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

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

MFnKeyframeDeltaAddRemove:: ~MFnKeyframeDeltaAddRemove ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaAddRemove:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDeltaAddRemove

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

Description

Indicates the type of change that this class instance represents.

Arguments

• ReturnStatus

Return Values

• 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 MFnKeyframeDeltaAddRemove:: value ( MStatus *ReturnStatus) const

Description

The value of the key that was added or removed.

Arguments

• ReturnStatus Return code.

Return Values

• a double value

Status Codes

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

MTime MFnKeyframeDeltaAddRemove:: time ( MStatus *ReturnStatus) const

Description

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

Arguments

• ReturnStatus Return code.

Return Values

• a MTime value of the added/removed key.

Status Codes

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

unsigned int MFnKeyframeDeltaAddRemove:: 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.

double MFnKeyframeDeltaAddRemove:: replacedValue ( MStatus *ReturnStatus) const

Description

The value of the key that was replaced. This method is only applicable to the kReplaced operation. Otherwise it will return 0.

Arguments

• ReturnStatus Return code.

Return Values

• a double value

Status Codes

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

This class has no child classes.