MFnKeyframeDeltaMove Class Reference
[OpenMayaAnim - API module for animationFunctionSet classes]

#include <MFnKeyframeDeltaMove.h>

Inheritance diagram for MFnKeyframeDeltaMove:

Inheritance graph
[legend]
Collaboration diagram for MFnKeyframeDeltaMove:

Collaboration graph
[legend]

List of all members.


Detailed Description

Function set for change in keyframe value or time.

This function set is used for keyframe deltas of type MFn::kKeyframeDeltaMove. These keyframe deltas are generated from 'move' events. For example, the user drags or scales a key from one position to another.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnKeyframeDeltaMove ()
 Destructor.
 MFnKeyframeDeltaMove ()
 Default constructor.
 MFnKeyframeDeltaMove (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MTime previousTime (MStatus *ReturnStatus=NULL) const
MTime currentTime (MStatus *ReturnStatus=NULL) const
double previousValue (MStatus *ReturnStatus=NULL) const
double currentValue (MStatus *ReturnStatus=NULL) const
unsigned int previousIndex (MStatus *ReturnStatus=NULL) const
virtual unsigned int keyIndex (MStatus *ReturnStatus=NULL) const
 MFnKeyframeDeltaMove (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

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

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


Member Function Documentation

MFn::Type MFnKeyframeDeltaMove::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kKeyframeDeltaMove

Reimplemented from MFnKeyframeDelta.

const char * MFnKeyframeDeltaMove::className (  )  const [protected, virtual]

Class name.

Return the class name : "MFnKeyframeDeltaMove"

Reimplemented from MFnKeyframeDelta.

MTime MFnKeyframeDeltaMove::previousTime ( MStatus ReturnStatus = NULL  )  const

The previous time value of this key.

Parameters:
[out] ReturnStatus Return Code
Returns:
A MTime containing the previous time of this key.
Status Codes:

MTime MFnKeyframeDeltaMove::currentTime ( MStatus ReturnStatus = NULL  )  const

The current/current time value.

Parameters:
[out] ReturnStatus Status code.
Returns:
A MTime containing the current time of this key.
Status Codes:

double MFnKeyframeDeltaMove::previousValue ( MStatus ReturnStatus = NULL  )  const

The previous value of the key prior to the change. The value corresponds to the units of the animation curve.

Parameters:
[out] ReturnStatus Return code.
Returns:
A double representing the previous value of the key.
Status Codes:

double MFnKeyframeDeltaMove::currentValue ( MStatus ReturnStatus = NULL  )  const

The current value of the key. The value corresponds to the units of the animation curve.

Parameters:
[out] ReturnStatus Return code.
Returns:
A double representing the current value of the key.
Status Codes:

unsigned int MFnKeyframeDeltaMove::previousIndex ( MStatus ReturnStatus = NULL  )  const

The previous index value of this key. If a key has been moved over another key then you can use this previous index to figure out where the key was moved from.

Parameters:
[out] ReturnStatus Return code.
Returns:
An unsigned value representing the previous index of this key on the curve.
Status Codes:

unsigned int MFnKeyframeDeltaMove::keyIndex ( MStatus ReturnStatus = NULL  )  const [virtual]

The current index value of this key.

Parameters:
[out] ReturnStatus Return code.
Returns:
An unsigned value representing the current index of this key on the curve.
Status Codes:

Reimplemented from MFnKeyframeDelta.


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6