Public Member Functions | Protected Member Functions

MFnHikEffector Class Reference

Search for all occurrences

Detailed Description

Full Body IK end effector function set.

MFnHikEffector is the function set for full body ik effectors. An Full Body IK (FBIK/HIK) effector is a special transform that allows users to manipulate a Full Body IK system.

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

#include <MFnHikEffector.h>

Inheritance diagram for MFnHikEffector:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnHikEffector ()
 Destructor.
 MFnHikEffector ()
 Default constructor.
 MFnHikEffector (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnHikEffector (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
MObject create (MObject parent=MObject::kNullObj, MStatus *ReturnStatus=NULL)
 Creates a new fbik effector.
MVector getPivotOffset (MStatus *ReturnStatus=NULL) const
 Retrieve the pivot offset of this effector.
MStatus setPivotOffset (const MVector &vector)
 Set the pivot offset for this effector.
MColor getEffColor (MStatus *ReturnStatus=NULL) const
 Retrieve the cached humanIK color of this effector.
MStatus setEffColor (const MColor &color)
 Set the humanIK color for this effector.
MStatus getAuxiliaryEffectors (MObjectArray &effs) const
 Returns an array of the auxiliary effectors associated with this effector.
 MFnHikEffector (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnHikEffector ( ) [virtual]

Destructor.

Class destructor.

MFnHikEffector ( 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:
MFnHikEffector ( 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:
MFnHikEffector ( 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::kHikEffector.

Reimplemented from MFnTransform.

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

Class name.

Return the class name : "MFnHikEffector".

Reimplemented from MFnTransform.

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

Creates a new fbik effector.

Parameters:
[in]parentparent DAG node (usually none)
[out]ReturnStatusreturn status
Returns:
A handle to the new object
Status Codes:

Reimplemented from MFnTransform.

MVector getPivotOffset ( MStatus ReturnStatus = NULL) const

Retrieve the pivot offset of this effector.

Parameters:
[out]ReturnStatusreturn status
Returns:
Pivot offset vector.
Status Codes:
MStatus setPivotOffset ( const MVector vector)

Set the pivot offset for this effector.

Parameters:
[in]vectorthe new pivot offset
Returns:
Status code
Status Codes:
MColor getEffColor ( MStatus ReturnStatus = NULL) const

Retrieve the cached humanIK color of this effector.

Parameters:
[out]ReturnStatusreturn status
Returns:
Pivot offset vector.
Status Codes:
MStatus setEffColor ( const MColor color)

Set the humanIK color for this effector.

Parameters:
[in]colorthe new color
Returns:
Status code
Status Codes:
MStatus getAuxiliaryEffectors ( MObjectArray effs) const

Returns an array of the auxiliary effectors associated with this effector.

Auxiliary effectors are used by humanIK to act as additional pivots.

Parameters:
[out]effsthe auxiliary effectors for this effector
Returns:
Status code
Status Codes:

MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector
MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector MFnHikEffector