MFnKeyframeDeltaScale Class Reference
[OpenMayaAnim - API module for animation, FunctionSet classes]

#include <MFnKeyframeDeltaScale.h>

Inheritance diagram for MFnKeyframeDeltaScale:

[legend]

Collaboration diagram for MFnKeyframeDeltaScale:

[legend]

List of all members.

---

Detailed 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.

Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnKeyframeDeltaScale ()
	Destructor.
	MFnKeyframeDeltaScale ()
	Default constructor.
	MFnKeyframeDeltaScale (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
MTime	startTime (MStatus *ReturnStatus=NULL) const
MTime	endTime (MStatus *ReturnStatus=NULL) const
MTime	currentStartTime (MStatus *ReturnStatus=NULL) const
MTime	currentEndTime (MStatus *ReturnStatus=NULL) const
MTime	pivotTime (MStatus *ReturnStatus=NULL) const
	MFnKeyframeDeltaScale (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

---

Constructor & Destructor Documentation

MFnKeyframeDeltaScale::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::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 MFnKeyframeDeltaScale::type

(

)

const [virtual]

Function set type.

Return the class type : MFn::kKeyframeDeltaScale

Reimplemented from MFnKeyframeDelta.

const char * MFnKeyframeDeltaScale::className

(

)

const [protected, virtual]

Class name.

Return the class name : "MFnKeyframeDeltaScale"

Reimplemented from MFnKeyframeDelta.

MTime MFnKeyframeDeltaScale::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 MFnKeyframeDeltaScale::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 MFnKeyframeDeltaScale::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 MFnKeyframeDeltaScale::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 MFnKeyframeDeltaScale::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.