C++ API Reference
Static Public Member Functions | List of all members
MIkSystem Class Reference
OpenMayaAnim - API module for animation

Inverse kinematics (IK) system class. More...

#include <MIkSystem.h>

Static Public Member Functions

static MObject findSolver (MString name, MStatus *ReturnStatus=NULL)
 Returns the ik solver with the given name. More...
 
static MStatus getSolvers (MStringArray &names)
 Get a list of the names for the solvers that are available in the system. More...
 
static bool isGlobalSnap (MStatus *ReturnStatus=NULL)
 Determines whether global snapping is on. More...
 
static MStatus setGlobalSnap (bool isSnap)
 Turns global snapping on or off. More...
 
static bool isGlobalSolve (MStatus *ReturnStatus=NULL)
 Determines whether global solving is on. More...
 
static MStatus setGlobalSolve (bool isSnap)
 Turns global solving on or off. More...
 
static const char * className ()
 Returns the name of this class. More...
 

Detailed Description

Inverse kinematics (IK) system class.

This class provides an interface to the inverse kinematics (IK) system. The ik system is used to set/query the global snapping flag for handles, set/query the global solve flag for solvers, and to find the ik solvers available in maya.

Member Function Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MObject findSolver ( MString  name,
MStatus *  ReturnStatus = NULL 
)
static

Returns the ik solver with the given name.

If the solver cannot be found then a a null MObject and an error is returned.

Parameters
[in]namethe name of the solver to find
[out]ReturnStatusStatus Code (see below)
Returns
The ik solver matching the given name
Status Codes:
  • MS::kSuccess The named solver was returned
  • MS::kFailure No solver with the given name was found
MStatus getSolvers ( MStringArray &  names)
static

Get a list of the names for the solvers that are available in the system.

Parameters
[out]namesstorage for the solver names
Returns
Status code
Status Codes:
  • MS::kSuccess The solver names were generated
  • MS::kInsufficientMemory Not enough memory to build array
bool isGlobalSnap ( MStatus *  ReturnStatus = NULL)
static

Determines whether global snapping is on.

Turning on global snapping will turn on snapping for all ik handles.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
  • true global snapping is on
  • false global snapping is off
Status Codes:
  • MS::kSuccess The global snapping value was successfully returned
MStatus setGlobalSnap ( bool  isSnap)
static

Turns global snapping on or off.

Turning on global snapping will turn on snapping for all ik handles.

Parameters
[in]isSnaptrue turns global snapping on, false turns it off
Status Codes:
  • MS::kSuccess The global snapping value was successfully set
bool isGlobalSolve ( MStatus *  ReturnStatus = NULL)
static

Determines whether global solving is on.

Parameters
[out]ReturnStatusStatus Code (see below)
Status Codes:
  • MS::kSuccess The global solve value was successfully returned
MStatus setGlobalSolve ( bool  isSolve)
static

Turns global solving on or off.

Parameters
[in]isSolvetrue turns global solving on, false turns it off
Status Codes:
  • MS::kSuccess The global solve value was successfully set
const char * className ( )
static

Returns the name of this class.

Returns
The name of this class.
The documentation for this class was generated from the following files: