MFnKeyframeDeltaScale Class Reference

#include <MFnKeyframeDeltaScale.h>

Class Description

Function set for scaling in time.

This function set is used for keyframe deltas of type MFn::kKeyframeDeltaScale. These deltas are generated from scaling events. Particularly scaling on the time axis. Changes in value are recorded as a MFnKeyframeDeltaMove.

Inheritance diagram for MFnKeyframeDeltaScale:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...
virtual	~MFnKeyframeDeltaScale ()
	Destructor.
	MFnKeyframeDeltaScale ()
	Default constructor.
	MFnKeyframeDeltaScale (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...
MTime	startTime (MStatus *ReturnStatus=NULL) const
	The start time of the scaling block. More...
MTime	endTime (MStatus *ReturnStatus=NULL) const
	The end time of the scaling block. More...
MTime	currentStartTime (MStatus *ReturnStatus=NULL) const
	The current scale time (after scaling has been performed). More...
MTime	currentEndTime (MStatus *ReturnStatus=NULL) const
	The current end time. More...
MTime	pivotTime (MStatus *ReturnStatus=NULL) const
	The pivot point of the scale (in time). More...
	MFnKeyframeDeltaScale (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...
virtual unsigned int	keyIndex (MStatus *ReturnStatus=NULL) const
	The index of this key on the animation curve. 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...

Constructor & Destructor Documentation

MFnKeyframeDeltaScale	(	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

MFnKeyframeDeltaScale	(	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::kKeyframeDeltaScale.

Reimplemented from MFnKeyframeDelta.

const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnKeyframeDeltaScale".

Reimplemented from MFnKeyframeDelta.

MTime startTime

(

MStatus *

ReturnStatus = NULL

)

const

The start time of the scaling block.

Parameters

[out]

ReturnStatus

return code.

Returns

An MTime value

Status Codes:

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

MTime endTime

(

MStatus *

ReturnStatus = NULL

)

const

The end time of the scaling block.

Parameters

[out]

ReturnStatus

return code.

Returns

An MTime value

Status Codes:

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

MTime currentStartTime

(

MStatus *

ReturnStatus = NULL

)

const

The current scale time (after scaling has been performed).

Parameters

[out]

ReturnStatus

return code.

Returns

An MTime value

Status Codes:

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

MTime currentEndTime

(

MStatus *

ReturnStatus = NULL

)

const

The current end time.

Parameters

[out]

ReturnStatus

return code.

Returns

An MTime value

Status Codes:

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

MTime pivotTime

(

MStatus *

ReturnStatus = NULL

)

const

The pivot point of the scale (in time).

Parameters

[out]

ReturnStatus

return code.

Returns

An MTime 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:

• MFnKeyframeDeltaScale.h
• MFnKeyframeDeltaScale.cpp