class MFnKeyframeDeltaScale

Jump to documentation

Inheritance:

MFnKeyframeDeltaScale < MFnKeyframeDelta < MFnBase

public members:

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

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::kKeyframeDeltaScale. These deltas are generated from scaling events. Particularly scaling on the time axis. Changes in value are recorded as a MFnKeyframeDeltaMove.

Functions

MFnKeyframeDeltaScale:: MFnKeyframeDeltaScale ()

Description

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

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

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

MFnKeyframeDeltaScale:: ~MFnKeyframeDeltaScale ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaScale:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDeltaScale

MTime MFnKeyframeDeltaScale:: startTime ( MStatus *ReturnStatus) const

Description

The start time of the scaling block.

Arguments

• ReturnStatus return code.

Return Values

• an MTime value

Status Codes

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

MTime MFnKeyframeDeltaScale:: endTime ( MStatus *ReturnStatus) const

Description

The end time of the scaling block.

Arguments

• ReturnStatus return code.

Return Values

• an MTime value

Status Codes

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

MTime MFnKeyframeDeltaScale:: currentStartTime ( MStatus *ReturnStatus) const

Description

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

Arguments

• ReturnStatus return code.

Return Values

• an MTime value

Status Codes

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

MTime MFnKeyframeDeltaScale:: currentEndTime ( MStatus *ReturnStatus) const

Description

The current end time.

Arguments

• ReturnStatus return code.

Return Values

• an MTime value

Status Codes

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

MTime MFnKeyframeDeltaScale:: pivotTime ( MStatus *ReturnStatus) const

Description

The pivot point of the scale (in time).

Arguments

• ReturnStatus return code.

Return Values

• an MTime value

Status Codes

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

This class has no child classes.