#include
<MIkHandleGroup.h>
List of all
members.
Detailed Description
IK handle groups.
Group class for ik handles. Each group has an associated solver
and priority. A single chain solver handle group has only one
handle in its group.
Constructor & Destructor Documentation
MIkHandleGroup::MIkHandleGroup |
( |
|
) |
|
Default constructor. The instance is set to contain no
groups.
MIkHandleGroup::~MIkHandleGroup |
( |
|
) |
|
Member Function Documentation
int MIkHandleGroup::priority |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return the priority value of this handle group.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- The priority
- Status Codes:
-
int MIkHandleGroup::solverID |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return the solver id used by this handle group.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- The solver id for this group
- Status Codes:
-
int MIkHandleGroup::solverPriority |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
return the priority of the solver used by this handle group.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- The solver priority
- Status Codes:
-
MStatus MIkHandleGroup::setPriority |
( |
int |
priority |
) |
|
Set the priority of this handle group.
- Parameters:
-
[in] |
priority |
the priority value to set |
- Returns:
- Status code
- Status Codes:
-
MStatus MIkHandleGroup::setSolverID |
( |
int |
id |
) |
|
Set the solver id for this handle group.
- Parameters:
-
[in] |
id |
the id value to set |
- Returns:
- Status code
- Status Codes:
-
bool MIkHandleGroup::checkEffectorAtGoal |
( |
MStatus * |
ReturnStatus =
NULL |
) |
|
Determines whether the end-effector at the handle(goal)
location.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
-
- true The end-effector is at the goal location
- false The end-effector is not at the goal location
- Status Codes:
-
Do all ik solving steps for this group.
- Returns:
- Status code
- Status Codes:
-
int MIkHandleGroup::dofCount |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return the total number of degrees of freedom of this handle
group.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- The total number of dofs
- Status Codes:
-
int MIkHandleGroup::handleCount |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Return the number of handles in the handle list for this
group.
- Parameters:
-
[out] |
ReturnStatus |
Status code |
- Returns:
- The number of handles
- Status Codes:
-
MObject MIkHandleGroup::handle |
( |
int |
ith, |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Return the ith handle in the handle list for this group.
- Parameters:
-
[in] |
ith |
the index of the handle |
[out] |
ReturnStatus |
Status code |
- Returns:
- An MObject for the
handle
- Status Codes:
-