class MFnKeyframeDeltaBreakdown

Jump to documentation

Inheritance:

MFnKeyframeDeltaBreakdown < MFnKeyframeDelta < MFnBase

public members:

	MFnKeyframeDeltaBreakdown ()
	MFnKeyframeDeltaBreakdown ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnKeyframeDeltaBreakdown ()
virtual MFn::Type	type () const
bool	wasBreakdown ( MStatus *ReturnStatus = NULL ) const
bool	isBreakdown ( MStatus *ReturnStatus = NULL ) const
	MFnKeyframeDeltaBreakdown ( 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

Delta keyframe object for changes in breakdown state of a key.

Functions

MFnKeyframeDeltaBreakdown:: MFnKeyframeDeltaBreakdown ()

Description

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

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

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

MFnKeyframeDeltaBreakdown:: ~MFnKeyframeDeltaBreakdown ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaBreakdown:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDeltaBreakdown

bool MFnKeyframeDeltaBreakdown:: wasBreakdown ( MStatus *ReturnStatus) const

Description

Returns the previous breakdown state of the key. It will return false if the key was converted to a breakdown key.

Arguments

• ReturnStatus Return code.

Return Values

• true or false depending on the key's breakdown state.

Status Codes

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

bool MFnKeyframeDeltaBreakdown:: isBreakdown ( MStatus *ReturnStatus) const

Description

Returns the current breakdown state of the key. It will return true if the key was converted to a breakdown key.

Arguments

• ReturnStatus Return code.

Return Values

• true or false depending on the key's breakdown state.

Status Codes

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

This class has no child classes.