MFnIkSolver Class Reference
[OpenMayaAnim - API module for animationFunctionSet classes]

#include <MFnIkSolver.h>
Inheritance diagram for MFnIkSolver:
Inheritance graph
[legend]
Collaboration diagram for MFnIkSolver:
Collaboration graph
[legend]

List of all members.


Detailed Description

Function set for inverse kinematics (IK) solvers.

This is the function set for inverse kinematics (IK) solvers. This function set is used for setting and querying attached ik solvers.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnIkSolver ()
  Destructor.
  MFnIkSolver ()
  Default constructor.
  MFnIkSolver (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
unsigned int  maxIterations (MStatus *ReturnStatus=NULL)
MStatus  setMaxIterations (unsigned int maxIters)
double  tolerance (MStatus *ReturnStatus=NULL)
MStatus  setTolerance (double tolerance)
  MFnIkSolver (const MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

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

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

Member Function Documentation

MFn::Type MFnIkSolver::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kIkSolver

Reimplemented from MFnDependencyNode.

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

Class name.

Return the class name : "MFnIkSolver"

Reimplemented from MFnDependencyNode.

unsigned int MFnIkSolver::maxIterations ( MStatus ReturnStatus = NULL  ) 

Returns the maximum number of iterations used when solving.

Parameters:
[out]  ReturnStatus  Status Code (see below)
Returns:
The maximum number of iterations used by this solver when solving
Status Codes:
  • MS::kSuccess The maximum number if iterations was successfully returned
  • MS::kFailure This function set has not been attached to a valid object

MStatus MFnIkSolver::setMaxIterations ( unsigned int  maxIters  ) 

Sets the maximum number of iterations used when solving.

Parameters:
[in]  maxIters  the new value for the maximum number of iterations for the solver
Returns:
Status Code (see below)
Status Codes:
  • MS::kSuccess The maximum number of iterations for this solver has been successfully set
  • MS::kFailure This function set has not been attached to a valid object

double MFnIkSolver::tolerance ( MStatus ReturnStatus = NULL  ) 

Returns the tolerance used when solving.

Parameters:
[out]  ReturnStatus  Status Code (see below)
Returns:
The tolerance value for this solver
Status Codes:
  • MS::kSuccess The tolerance value was successfully returned
  • MS::kFailure This function set has not been attached to a valid object

MStatus MFnIkSolver::setTolerance ( double  tolerance  ) 

Sets the tolerance used when solving.

Parameters:
[in]  tolerance  The tolerance value to be set
Returns:
Status Code (see below)
Status Codes:
  • MS::kSuccess The tolerance value was successfully set
  • MS::kFailure This function set has not been attached to a valid object

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6