MIkSystem Class Reference
[OpenMayaAnim - API module for animation]

#include <MIkSystem.h>

List of all members.


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.

Static Public Member Functions

static MObject findSolver (MString name, MStatus *ReturnStatus=NULL)
static MStatus getSolvers (MStringArray &names)
static bool isGlobalSnap (MStatus *ReturnStatus=NULL)
static MStatus setGlobalSnap (bool isSnap)
static bool isGlobalSolve (MStatus *ReturnStatus=NULL)
static MStatus setGlobalSolve (bool isSnap)


Member Function Documentation

MObject MIkSystem::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] name the name of the solver to find
[out] ReturnStatus Status Code (see below)
Returns:
The ik solver matching the given name
Status Codes:

MStatus MIkSystem::getSolvers ( MStringArray names  )  [static]

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

Parameters:
[out] names storage for the solver names
Returns:
Status code
Status Codes:

bool MIkSystem::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] ReturnStatus Status 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 MIkSystem::setGlobalSnap ( bool  isSnap  )  [static]

Turns global snapping on or off. Turning on global snapping will turn on snapping for all ik handles.

Parameters:
[in] isSnap true turns global snapping on, false turns it off
Status Codes:
  • MS::kSuccess The global snapping value was successfully set

bool MIkSystem::isGlobalSolve ( MStatus ReturnStatus = NULL  )  [static]

Determines whether global solving is on.

Parameters:
[out] ReturnStatus Status Code (see below)
Status Codes:
  • MS::kSuccess The global solve value was successfully returned

MStatus MIkSystem::setGlobalSolve ( bool  isSolve  )  [static]

Turns global solving on or off.

Parameters:
[in] isSolve true turns global solving on, false turns it off
Status Codes:


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