class MIkHandleGroup

Jump to documentation

public members:

	MIkHandleGroup ()
	~MIkHandleGroup ()
int	priority ( MStatus *ReturnStatus = NULL) const
int	solverID ( MStatus *ReturnStatus = NULL) const
int	solverPriority ( MStatus *ReturnStatus = NULL) const
MStatus	setPriority ( int )
MStatus	setSolverID ( int )
bool	checkEffectorAtGoal ( MStatus *ReturnStatus = NULL)
MStatus	solve ()
int	dofCount ( MStatus *ReturnStatus = NULL) const
int	handleCount ( MStatus *ReturnStatus = NULL) const
MObject	handle ( int ith, MStatus *ReturnStatus = NULL )

Documentation

Description

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.

Functions

MIkHandleGroup:: MIkHandleGroup ()

Description

Default constructor. The instance is set to contain no groups.

MIkHandleGroup:: ~MIkHandleGroup ()

Description

The class destructor.

int MIkHandleGroup:: priority ( MStatus *ReturnStatus) const

Description

Return the priority value of this handle group.

Arguments

• ReturnStatus Status code

Return value

• the priority

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

int MIkHandleGroup:: solverID ( MStatus *ReturnStatus) const

Description

Return the solver id used by this handle group.

Arguments

• ReturnStatus Status code

Return value

• the solver id for this group

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

int MIkHandleGroup:: solverPriority ( MStatus *ReturnStatus) const

Description

return the priority of the solver used by this handle group.

Arguments

• ReturnStatus Status code

Return value

• the solver priority

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

MStatus MIkHandleGroup:: setPriority ( int priority )

Description

Set the priority of this handle group.

Arguments

• priority the priority value to set

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

MStatus MIkHandleGroup:: setSolverID ( int id )

Description

Set the solver id for this handle group.

Arguments

• id the id value to set

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

bool MIkHandleGroup:: checkEffectorAtGoal ( MStatus *ReturnStatus)

Description

Determines whether the end-effector at the handle(goal) location.

Arguments

• ReturnStatus Status code

Return value

• true The end-effector is at the goal location
• false The end-effector is not at the goal location

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

MStatus MIkHandleGroup:: solve ()

Description

Do all ik solving steps for this group.

Return Value

• Status code

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

int MIkHandleGroup:: dofCount ( MStatus *ReturnStatus) const

Description

Return the total number of degrees of freedom of this handle group.

Arguments

• ReturnStatus Status code

Return value

• the total number of dofs

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

int MIkHandleGroup:: handleCount ( MStatus *ReturnStatus) const

Description

Return the number of handles in the handle list for this group.

Arguments

• ReturnStatus Status code

Return value

• the number of handles

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred

MObject MIkHandleGroup:: handle (int ith, MStatus *ReturnStatus)

Description

Return the ith handle in the handle list for this group.

Arguments

• ith the index of the handle
• ReturnStatus Status code

Return value

• An MObject for the handle

Status Codes

• MS::kSuccess The method was successful
• MS::kFailure An object error has occurred
• MS::kInvalidParameter An invalid array index was passed

This class has no child classes.