MFnKeyframeDeltaInfType Class Reference

#include <MFnKeyframeDeltaInfType.h>

Class Description

Function set for changes in pre or post infinity type.

This delta object represents changes in the pre-infinity or post-infinity type of the animation curve. Pre-infinity and post-infinity types are specific to animation curves and do not have a corresponding key associated with them. It is, therefore, invalid to have a keyframe associated with a MFnKeyframeDeltaInfType. To determine if this class represents a change to pre or post infinity use the method isPreInfinity on this class.

+ Inheritance diagram for MFnKeyframeDeltaInfType:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnKeyframeDeltaInfType ()
 Destructor.
 
 MFnKeyframeDeltaInfType ()
 Default constructor.
 
 MFnKeyframeDeltaInfType (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MFnAnimCurve::InfinityType previousInfinityType (MStatus *ReturnStatus=NULL) const
 The previous infinity type. More...
 
MFnAnimCurve::InfinityType currentInfinityType (MStatus *ReturnStatus=NULL) const
 The current infinity type. More...
 
bool isPreInfinity (MStatus *ReturnStatus=NULL) const
 This class can describe changes to both the pre-infinity and post-infinity this method allows the API user to figure out which type this class represents. More...
 
 MFnKeyframeDeltaInfType (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

MFnKeyframeDeltaInfType ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnKeyframeDeltaInfType ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kKeyframeDeltaInfType.

Reimplemented from MFnKeyframeDelta.

const char * className ( ) const
protectedvirtual

Class name.

Return the class name : "MFnKeyframeDeltaInfType".

Reimplemented from MFnKeyframeDelta.

MFnAnimCurve::InfinityType previousInfinityType ( MStatus ReturnStatus = NULL) const

The previous infinity type.

Parameters
[out]ReturnStatusReturn code.
Returns
The previous infinityType for the curve.
Status Codes:
MFnAnimCurve::InfinityType currentInfinityType ( MStatus ReturnStatus = NULL) const

The current infinity type.

Parameters
[out]ReturnStatusReturn code.
Returns
The current InfinityType for the curve
Status Codes:
bool isPreInfinity ( MStatus ReturnStatus = NULL) const

This class can describe changes to both the pre-infinity and post-infinity this method allows the API user to figure out which type this class represents.

Parameters
[out]ReturnStatusReturn code.
Returns
true if this class encapsulates changes to the pre-infinity type.
Status Codes:

The documentation for this class was generated from the following files:
  • MFnKeyframeDeltaInfType.h
  • MFnKeyframeDeltaInfType.cpp