class MFnKeyframeDeltaMove

Jump to documentation

Inheritance:

MFnKeyframeDeltaMove < MFnKeyframeDelta < MFnBase

public members:

	MFnKeyframeDeltaMove ()
	MFnKeyframeDeltaMove ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnKeyframeDeltaMove ()
virtual MFn::Type	type () const
MTime	previousTime ( MStatus * ReturnStatus = NULL ) const
MTime	currentTime ( MStatus * ReturnStatus = NULL ) const
double	previousValue ( MStatus * ReturnStatus = NULL ) const
double	currentValue ( MStatus * ReturnStatus = NULL ) const
unsigned int	previousIndex ( MStatus * ReturnStatus = NULL ) const
virtual unsigned int	keyIndex ( MStatus * ReturnStatus = NULL ) const
	MFnKeyframeDeltaMove ( 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

This function set is used for keyframe deltas of type MFn::kKeyframeDeltaMove. These keyframe deltas are generated from 'move' events. For example, the user drags or scales a key from one position to another.

Functions

MFnKeyframeDeltaMove:: MFnKeyframeDeltaMove ()

Description

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

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

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

MFnKeyframeDeltaMove:: ~MFnKeyframeDeltaMove ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaMove:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDeltaMove

MTime MFnKeyframeDeltaMove:: previousTime ( MStatus *ReturnStatus) const

Description

The previous time value of this key.

Arguments

• ReturnStatus Return Code

Return Values

• a MTime containing the previous time of this key.

Status Codes

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

MTime MFnKeyframeDeltaMove:: currentTime ( MStatus *ReturnStatus) const

Description

The current/current time value.

Arguments

• ReturnStatus Status code.

Return Values

• a MTime containing the current time of this key.

Status Codes

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

double MFnKeyframeDeltaMove:: previousValue ( MStatus *ReturnStatus) const

Description

The previous value of the key prior to the change. The value corresponds to the units of the animation curve.

Arguments

• ReturnStatus Return code.

Return Values

• a double representing the previous value of the key.

Status Codes

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

double MFnKeyframeDeltaMove:: currentValue ( MStatus *ReturnStatus) const

Description

The current value of the key. The value corresponds to the units of the animation curve.

Arguments

• ReturnStatus Return code.

Return Values

• a double representing the current value of the key.

Status Codes

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

unsigned int MFnKeyframeDeltaMove:: previousIndex ( MStatus *ReturnStatus) const

Description

The previous index value of this key. If a key has been moved over another key then you can use this previous index to figure out where the key was moved from.

Arguments

• ReturnStatus Return code.

Return Values

• an unsigned value representing the previous index of this key on the curve.

Status Codes

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

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

Description

The current index value of this key.

Arguments

• ReturnStatus Return code.

Return Values

• an unsigned value representing the current index of this key on the curve.

Status Codes

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

This class has no child classes.