Function set for changes in pre or post infinity type. More...

#include <MFnKeyframeDeltaInfType.h>

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=nullptr) 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...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Static Public Member Functions inherited from MFnKeyframeDelta
static const char *	className ()
	Returns the name of this class. More...

Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

static const char *	typeString (MFn::Type)
	Returns the type string for a given type. More...

static bool	isValid (MFn::Type)
	Returns true if type is in the range of valid types. More...

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

Constructor & Destructor Documentation

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

MFnKeyframeDeltaInfType	(	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::kKeyframeDeltaInfType.

Returns: the class type.

Reimplemented from MFnKeyframeDelta.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )

static

Returns the name of this class.

Return the class name : "MFnKeyframeDeltaInfType".

Returns: Name of this class.

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

The previous infinity type.

Parameters

[out] ReturnStatus Return code.

Returns: The previous infinityType for the curve.

Status Codes:

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

MFnAnimCurve::InfinityType currentInfinityType ( MStatus * ReturnStatus = NULL ) const

The current infinity type.

Parameters

[out] ReturnStatus Return code.

Returns: The current InfinityType for the curve

Status Codes:

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

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] ReturnStatus Return code.

Returns: true if this class encapsulates changes to the pre-infinity type.

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:

MFnKeyframeDeltaInfType.h
MFnKeyframeDeltaInfType.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation