class MFnKeyframeDeltaInfType

Jump to documentation

Inheritance:

MFnKeyframeDeltaInfType < MFnKeyframeDelta < MFnBase

public members:

	MFnKeyframeDeltaInfType ()
	MFnKeyframeDeltaInfType ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnKeyframeDeltaInfType ()
virtual MFn::Type	type () const
MFnAnimCurve::InfinityType	previousInfinityType ( MStatus *ReturnStatus = NULL ) const
MFnAnimCurve::InfinityType	currentInfinityType ( MStatus *ReturnStatus = NULL ) const
bool	isPreInfinity ( MStatus *ReturnStatus = NULL ) const
	MFnKeyframeDeltaInfType ( 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 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.

Functions

MFnKeyframeDeltaInfType:: MFnKeyframeDeltaInfType ()

Description

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

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

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

MFnKeyframeDeltaInfType:: ~MFnKeyframeDeltaInfType ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaInfType:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kKeyframeDeltaInfType

MFnAnimCurve::InfinityType MFnKeyframeDeltaInfType:: previousInfinityType ( MStatus *ReturnStatus ) const

Description

The previous infinity type.

Arguments

• ReturnStatus Return code.

Return Values

• the previous infinityType for the curve.

Status Codes

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

MFnAnimCurve::InfinityType MFnKeyframeDeltaInfType:: currentInfinityType ( MStatus *ReturnStatus ) const

Description

The current infinity type.

Arguments

• ReturnStatus Return code.

Return Values

• the current InfinityType for the curve

Status Codes

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

bool MFnKeyframeDeltaInfType:: isPreInfinity ( MStatus *ReturnStatus ) const

Description

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.

Arguments

• ReturnStatus Return code.

Return Values

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

This class has no child classes.