class MIkSystem

Jump to documentation

public members:

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 )

Documentation

Description

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.

Functions

MObject MIkSystem:: findSolver ( MString name, MStatus * ReturnStatus )

Description

Returns the ik solver with the given name. If the solver cannot be found then a a null MObject and an error is returned.

Arguments

• name the name of the solver to find
• ReturnStatus Status Code (see below)

Return value

• 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 MIkSystem:: getSolvers ( MStringArray & names )

Description

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

Arguments

• names storage for the solver names

Return value

• Status code

Status Codes

• MS::kSuccess The solver names were generated
• MS::kInsufficientMemory Not enough memory to build array

bool MIkSystem:: isGlobalSnap ( MStatus * ReturnStatus )

Description

Determines whether global snapping is on. Turning on global snapping will turn on snapping for all ik handles.

Arguments

• ReturnStatus Status Code (see below)

Return value

• 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 )

Description

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

Arguments

• 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 )

Description

Determines whether global solving is on.

Arguments

• ReturnStatus Status Code (see below)

Status Codes

• MS::kSuccess The global solve value was successfully returned

MStatus MIkSystem:: setGlobalSolve ( bool isSolve )

Description

Turns global solving on or off.

Arguments

• isSolve true turns global solving on, false turns it off

Status Codes

• MS::kSuccess The global solve value was successfully set

This class has no child classes.