class MFnKeyframeDeltaWeighted

Jump to documentation

: public MFnKeyframeDelta Function set for changes in a key's weighted state. (OpenMayaAnim) (OpenMayaAnim.py)

Inheritance:

MFnKeyframeDeltaWeighted < MFnKeyframeDelta < MFnBase

public members:

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

Used to read changes in a key's weighted state.
Description

Delta keyframe object for changes in weighted state of a key.

Functions

MFnKeyframeDeltaWeighted:: MFnKeyframeDeltaWeighted ()

Description

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

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

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

MFnKeyframeDeltaWeighted:: ~MFnKeyframeDeltaWeighted ()

Description

The class destructor.

MFn::Type MFnKeyframeDeltaWeighted:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kKeyframeDeltaWeighted

bool MFnKeyframeDeltaWeighted:: wasWeighted ( MStatus *ReturnStatus) const

Description

Returns true if the key had weighted tangent, but it is not currently.

Arguments

  • ReturnStatus Return code.

Return Values

  • true or false depending on the key's weight status.

Status Codes

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

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright