class MFnIkSolver

Jump to documentation

Inheritance:

MFnIkSolver < MFnDependencyNode < MFnBase

public members:

	MFnIkSolver ()
	MFnIkSolver ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnIkSolver ()
virtual MFn::Type	type () const
unsigned int	maxIterations ( MStatus * ReturnStatus = NULL )
MStatus	setMaxIterations ( unsigned int maxIters )
double	tolerance ( MStatus * ReturnStatus = NULL )
MStatus	setTolerance ( double tolerance )
	MFnIkSolver ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnDependencyNode:

public members:

virtual MFn::Type	type () const
enum	MAttrClass kGlobalDynamicAttr kLocalDynamicAttr
MObject	create ( const MTypeId & typeId , MStatus * ReturnStatus = NULL )
MObject	create ( const MTypeId & typeId , const MString & name , MStatus * ReturnStatus = NULL )
MObject	create ( const MString & type , MStatus * ReturnStatus = NULL )
MObject	create ( const MString & type , const MString & name , MStatus * ReturnStatus = NULL )
MTypeId	typeId ( MStatus * ReturnStatus = NULL ) const
MString	typeName ( MStatus * ReturnStatus = NULL ) const
MString	name ( MStatus * ReturnStatus = NULL ) const
MString	setName ( const MString & name , MStatus * ReturnStatus = NULL )
MStatus	getConnections ( MPlugArray & array ) const
unsigned int	attributeCount ( MStatus * ReturnStatus=NULL) const
MObject	attribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject	reorderedAttribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject	attribute ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MAttrClass	attributeClass ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MStatus	getAffectedAttributes ( const MObject & attr, MObjectArray & affectedAttributes ) const
MStatus	getAffectedByAttributes ( const MObject & attr, MObjectArray & affectedByAttributes ) const
MPlug	findPlug ( const MObject & attr, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MString & attrName, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MStatus	addAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MStatus	removeAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MPxNode *	userNode ( MStatus * ReturnStatus=NULL ) const
bool	isFromReferencedFile ( MStatus * ReturnStatus=NULL) const
bool	isShared ( MStatus * ReturnStatus=NULL) const
bool	hasUniqueName ( MStatus * ReturnStatus=NULL) const
MString	parentNamespace ( MStatus * ReturnStatus=NULL) const
bool	isLocked ( MStatus * ReturnStatus=NULL) const
MStatus	setLocked ( bool locked )
static MString	classification ( const MString & nodeTypeName )
bool	isNewAttribute ( const MObject & attr, MStatus * ReturnStatus=NULL) const
static unsigned int	allocateFlag ( const MString pluginName, MStatus * ReturnStatus=NULL )
static MStatus	deallocateFlag (const MString pluginName, unsigned int flag)
static MStatus	deallocateAllFlags (const MString pluginName)
MStatus	setFlag (unsigned int flag, bool state)
bool	isFlagSet (unsigned int flag, MStatus * ReturnStatus=NULL) const
bool	isDefaultNode ( MStatus * ReturnStatus=NULL) const
MStatus	setDoNotWrite ( bool flag )
bool	canBeWritten ( MStatus * ReturnStatus=NULL) const
bool	hasAttribute (const MString & name , MStatus * ReturnStatus=NULL) const
MObject	getAliasAttr (bool force, MStatus * ReturnStatus=NULL)
bool	setAlias (const MString & alias,const MString & name , const MPlug & plug, bool add=true, MStatus * ReturnStatus=NULL)
bool	findAlias (const MString & alias, MObject & attrObj, MStatus * ReturnStatus=NULL) const
bool	getAliasList ( MStringArray & strArray, MStatus * ReturnStatus=NULL)
MString	plugsAlias (const MPlug & plug, MStatus * ReturnStatus=NULL)
	public
bool	getPlugsAlias (const MPlug & plug, MString & aliasName, MStatus * ReturnStatus=NULL)

Inherited from MFnBase:

public members:

virtual MFn::Type	type () const
bool	hasObj ( MFn::Type ) const
bool	hasObj ( const MObject & ) const
MObject	object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( MObject & object )
virtual MStatus	setObject ( const MObject & object )

Documentation

Description

This is the function set for inverse kinematics (IK) solvers. This function set is used for setting and querying attached ik solvers.

Functions

MFnIkSolver:: MFnIkSolver ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnIkSolver:: MFnIkSolver ( MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given MObject.

Arguments

• object the MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnIkSolver:: MFnIkSolver ( const MObject & object, MStatus * ReturnStatus )

Description

Class constructor that initializes the function set to the given constant MObject.

Arguments

• object the const MObject to attach the function set to
• ReturnStatus the return status
  • MS::kSuccess if the function set is successfully attached
  • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnIkSolver:: ~MFnIkSolver ()

Description

The class destructor.

MFn::Type MFnIkSolver:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kIkSolver

unsigned int MFnIkSolver:: maxIterations ( MStatus * ReturnStatus )

Description

Returns the maximum number of iterations used when solving.

Arguments

• ReturnStatus Status Code (see below)

Return value

• The maximum number of iterations used by this solver when solving

Status Codes

• MS::kSuccess The maximum number if iterations was successfully returned
• MS::kFailure This function set has not been attached to a valid object

MStatus MFnIkSolver:: setMaxIterations ( unsigned int maxIters )

Description

Sets the maximum number of iterations used when solving.

Arguments

• maxIters the new value for the maximum number of iterations for the solver

Return value

• Status Code (see below)

Status Codes

• MS::kSuccess The maximum number of iterations for this solver has been successfully set
• MS::kFailure This function set has not been attached to a valid object

double MFnIkSolver:: tolerance ( MStatus * ReturnStatus )

Description

Returns the tolerance used when solving.

Arguments

• ReturnStatus Status Code (see below)

Return value

• The tolerance value for this solver

Status Codes

• MS::kSuccess The tolerance value was successfully returned
• MS::kFailure This function set has not been attached to a valid object

MStatus MFnIkSolver:: setTolerance ( double tolerance )

Description

Sets the tolerance used when solving.

Arguments

• tolerance The tolerance value to be set

Return value

• Status Code (see below)

Status Codes

• MS::kSuccess The tolerance value was successfully set
• MS::kFailure This function set has not been attached to a valid object

This class has no child classes.