Public Member Functions | Protected Member Functions

MFnIkEffector Class Reference

Search for all occurrences

Detailed Description

Inverse kinematics end effector function set.

MFnIkEffector is the function set for inverse kinematic end effectors. An end effector is a point on the skeleton, usually the last bone. When an IK system solves, it is trying to calculate the rotations on the joints necessary to get the end effector to the target point.

The methods of the parent class MFnTransform used to position the end effector.

#include <MFnIkEffector.h>

Inheritance diagram for MFnIkEffector:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnIkEffector ()
 Destructor.
 MFnIkEffector ()
 Default constructor.
 MFnIkEffector (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnIkEffector (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MObject parent=MObject::kNullObj, MStatus *ReturnStatus=NULL)
 Creates a new end effector.
 MFnIkEffector (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnIkEffector ( ) [virtual]

Destructor.

Class destructor.

MFnIkEffector ( 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:
MFnIkEffector ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters:
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
MFnIkEffector ( 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::kIkEffector.

Reimplemented from MFnTransform.

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

Class name.

Return the class name : "MFnIkEffector".

Reimplemented from MFnTransform.

MObject create ( MObject  parent = MObject::kNullObj,
MStatus ReturnStatus = NULL 
)

Creates a new end effector.

For the effector to work properly, it should be given a joint as the parent. It should be given the joint before the last bone.

Parameters:
[in]parentparent DAG node (should be a joint)
[out]ReturnStatusreturn status
Returns:
A handle to the new object
Status Codes:

Reimplemented from MFnTransform.


MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector
MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector MFnIkEffector