class MFnKeyframeDeltaBlockAddRemove

Jump to documentation

Inheritance:

MFnKeyframeDeltaBlockAddRemove < MFnKeyframeDelta < MFnBase

public members:

	MFnKeyframeDeltaBlockAddRemove ()
	MFnKeyframeDeltaBlockAddRemove ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnKeyframeDeltaBlockAddRemove ()
virtual MFn::Type	type () const
enum	DeltaType kAdded kRemoved
DeltaType	deltaType ( MStatus *ReturnStatus = NULL ) const
MTime	startTime ( MStatus *ReturnStatus = NULL ) const
MTime	endTime ( MStatus *ReturnStatus = NULL ) const
unsigned int	numKeys ( MStatus *ReturnStatus = NULL ) const
void	getValues ( MDoubleArray &values, MStatus *ReturnStatus = NULL ) const
void	getTimes ( MTimeArray &times, MStatus *ReturnStatus = NULL ) const
	MFnKeyframeDeltaBlockAddRemove ( 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

Function set for reading a block of keyframe changes. They are used internally to set a large group of keys quickly. Because changes occur in groups using base class keyframe methods on this derived class do not make sense. Therefore, methods describing where the block of keys were added or removed are available though methods on this class.

Functions

MFnKeyframeDeltaBlockAddRemove:: MFnKeyframeDeltaBlockAddRemove ()

Description

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

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

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

MFnKeyframeDeltaBlockAddRemove:: ~MFnKeyframeDeltaBlockAddRemove ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaBlockAddRemove:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDeltaBlockAddRemove

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

Description

Indicates the type of change, i.e. keys added or removed, that this class instance represents.

Arguments

• ReturnStatus Return code.

Return Values

• kAdded - a block of keys were added.
• kRemoved - a block of keys were removed.

Status Codes

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

MTime MFnKeyframeDeltaBlockAddRemove:: startTime ( MStatus *ReturnStatus) const

Description

An MTime value indicating the start time of the add/remove.

Arguments

• ReturnStatus Return code.

Return Values

• an MTime value.

Status Codes

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

MTime MFnKeyframeDeltaBlockAddRemove:: endTime ( MStatus *ReturnStatus) const

Description

Returns an MTime value indicating the endTime of the add/remove.

Arguments

• ReturnStatus Return code.

Return Values

• an MTime value indicating the end of the add/remove.

Status Codes

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

unsigned int MFnKeyframeDeltaBlockAddRemove:: numKeys ( MStatus *ReturnStatus) const

Description

Total number of keys involved in this add or remove operation.

Arguments

• ReturnStatus Return code.

Return Values

Status Codes

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

void MFnKeyframeDeltaBlockAddRemove:: getValues ( MDoubleArray &values, MStatus *ReturnStatus) const

Description

Returns the values of all keys involved in the group add or remove.

Arguments

• values MDoubleArray to store values.
• status Status code.

Return Values

Status Codes

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

void MFnKeyframeDeltaBlockAddRemove:: getTimes ( MTimeArray &times, MStatus *ReturnStatus) const

Description

Returns the times of all keys involved in the group add or remove.

Arguments

• times MTimeArray to store all time values.
• status Return code.

Return Values

Status Codes

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

This class has no child classes.