C++ API Reference

Function set for joints. More...

#include <MFnIkJoint.h>

+ Inheritance diagram for MFnIkJoint:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnIkJoint ()
 Destructor. More...
 
 MFnIkJoint ()
 Default constructor.
 
 MFnIkJoint (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
 MFnIkJoint (const MDagPath &object, MStatus *ret=NULL)
 Constructor. More...
 
MObject create (MObject parent=MObject::kNullObj, MStatus *ReturnStatus=NULL)
 Create a new joint in a skeleton. More...
 
MStatus getOrientation (MQuaternion &quaternion) const
 Get the joint orientation. More...
 
MStatus setOrientation (const MQuaternion &quaternion)
 Set the jointOrient value. More...
 
MStatus getOrientation (MEulerRotation &rotation) const
 Get the orientation of the coordinate axes. More...
 
MStatus setOrientation (const MEulerRotation &rotation)
 Set the orientation of the coordinate axes. More...
 
MStatus getOrientation (double rotation[3], MTransformationMatrix::RotationOrder &order) const
 Get the orientation of the coordinate axes. More...
 
MStatus setOrientation (const double rotation[3], MTransformationMatrix::RotationOrder order)
 Set the orientation of the coordinate axes. More...
 
MStatus getScaleOrientation (MQuaternion &quaternion) const
 Get the orientation of the coordinate axes for rotation. More...
 
MStatus setScaleOrientation (const MQuaternion &quaternion)
 Set the orientation of the coordinate axes for rotation. More...
 
MStatus getScaleOrientation (double rotation[3], MTransformationMatrix::RotationOrder &order) const
 Get the orientation of the coordinate axes for rotation. More...
 
MStatus setScaleOrientation (const double rotation[3], MTransformationMatrix::RotationOrder order)
 Set the orientation of the coordinate axes for rotation. More...
 
MStatus getSegmentScale (double scale[3]) const
 Get the local space scale values for the joint segment (bone). More...
 
MStatus setSegmentScale (const double scale[3])
 Set the local space scale values for the joint segment (bone). More...
 
MStatus getStiffness (double stiffness[3]) const
 Get the stiffness (from 0 to 100.0) for the joint. More...
 
MStatus setStiffness (const double stiffness[3])
 Set the stiffness (from 0 to 100.0) for the joint. More...
 
MStatus getPreferredAngle (double rotation[3]) const
 Get the preferred orientation for this joint (in XYZ order) More...
 
MStatus setPreferredAngle (const double rotation[3])
 Set the preferred orientation for this joint (in XYZ order) More...
 
MStatus getDegreesOfFreedom (bool &freeInX, bool &freeInY, bool &freeInZ) const
 Get degrees of freedom of this joint. More...
 
MStatus setDegreesOfFreedom (bool freeInX, bool freeInY, bool freeInZ)
 Set the degrees of freedom of this joint by specifying which axes are allowed to rotate. More...
 
double minRotateDampXRange (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping range in X. More...
 
double minRotateDampYRange (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping range in Y. More...
 
double minRotateDampZRange (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping range in Z. More...
 
double maxRotateDampXRange (MStatus *ReturnStatus=NULL) const
 Get the maximum of the damping range in X. More...
 
double maxRotateDampYRange (MStatus *ReturnStatus=NULL) const
 Get the maximum of the damping range in Y. More...
 
double maxRotateDampZRange (MStatus *ReturnStatus=NULL) const
 Get the maximum of the damping range in Z. More...
 
MStatus setMinRotateDampXRange (double angle)
 Set the minimum of the damping range in X. More...
 
MStatus setMinRotateDampYRange (double angle)
 Set the minimum of the damping range in Y. More...
 
MStatus setMinRotateDampZRange (double angle)
 Set the minimum of the damping range in Z. More...
 
MStatus setMaxRotateDampXRange (double angle)
 Set the maximum of the damping range in X. More...
 
MStatus setMaxRotateDampYRange (double angle)
 Set the maximum of the damping range in Y. More...
 
MStatus setMaxRotateDampZRange (double angle)
 Set the maximum of the damping range in Z. More...
 
double minRotateDampXStrength (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping strength in X. More...
 
double minRotateDampYStrength (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping strength in X. More...
 
double minRotateDampZStrength (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping strength in X. More...
 
double maxRotateDampXStrength (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping strength in X. More...
 
double maxRotateDampYStrength (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping strength in X. More...
 
double maxRotateDampZStrength (MStatus *ReturnStatus=NULL) const
 Get the minimum of the damping strength in X. More...
 
MStatus setMinRotateDampXStrength (double angle)
 Set the maximum of the damping strength in Z. More...
 
MStatus setMinRotateDampYStrength (double angle)
 Set the maximum of the damping strength in Y. More...
 
MStatus setMinRotateDampZStrength (double angle)
 Set the minimum of the damping strength in Z. More...
 
MStatus setMaxRotateDampXStrength (double angle)
 Set the maximum of the damping strength in X. More...
 
MStatus setMaxRotateDampYStrength (double angle)
 Set the maximum of the damping strength in Y. More...
 
MStatus setMaxRotateDampZStrength (double angle)
 Set the maximum of the damping strength in Z. More...
 
MString hikJointName (MStatus *ReturnStatus=NULL) const
 Get the name that the HumanIK solver uses to identify this joint. More...
 
 MFnIkJoint (const MObject &object, MStatus *ret=NULL)
 Constructor. More...
 
MStatus getHikJointName (MString &name) const
 NO SCRIPT SUPPORT. More...
 
MStatus getPreferedAngle (double rotation[3]) const
 Obsolete - use correctly spelled getPreferredAngle.
 
MStatus setPreferedAngle (const double rotation[3])
 Obsolete - use correctly spelled setPreferredAngle.
 
- Public Member Functions inherited from MFnTransform
virtual ~MFnTransform ()
 Destructor. More...
 
 MFnTransform ()
 Default constructor.
 
 MFnTransform (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
 MFnTransform (const MDagPath &object, MStatus *ret=NULL)
 Constructor. More...
 
MObject create (MObject parent=MObject::kNullObj, MStatus *ReturnStatus=nullptr)
 Creates a new transformation node. More...
 
MTransformationMatrix transformation (MStatus *ReturnStatus=nullptr) const
 Retrieve the transformation matrix represented by this transform. More...
 
MStatus set (const MTransformationMatrix &transform)
 Change this transform to equal the given matrix. More...
 
MVector getTranslation (MSpace::Space space, MStatus *ReturnStatus=nullptr) const
 Retrieve the translation component of this transformation in centimeters. More...
 
MStatus setTranslation (const MVector &vec, MSpace::Space space)
 Change the translation component of this transformation. More...
 
MStatus translateBy (const MVector &vec, MSpace::Space space)
 Relatively change the translation component of this transformation. More...
 
MStatus getScale (double scale[3]) const
 Retrieve the scaling component of this transformation. More...
 
MStatus setScale (const double scale[3])
 Set the scaling component of this transformation. More...
 
MStatus scaleBy (const double scale[3])
 Relatively scale this transformation. More...
 
MPoint scalePivot (MSpace::Space space, MStatus *ReturnStatus=nullptr) const
 Returns the pivot around which the scale is applied. More...
 
MStatus setScalePivot (const MPoint &point, MSpace::Space space, bool balance)
 Set the pivot around which the scale is applied in centimeters. More...
 
MVector scalePivotTranslation (MSpace::Space space, MStatus *ReturnStatus=nullptr) const
 Returns the scale pivot translation in centimeters. More...
 
MStatus setScalePivotTranslation (const MVector &vec, MSpace::Space space)
 Set the scale pivot translation in centimeters. More...
 
MStatus getShear (double scale[3]) const
 Retrieve the shearing component of this transformation. More...
 
MStatus setShear (const double shear[3])
 Set the shearing component of this transformation. More...
 
MStatus shearBy (const double shear[3])
 Relatively shear this transformation. More...
 
MStatus getRotation (MQuaternion &quaternion, MSpace::Space=MSpace::kTransform) const
 Retrieve the rotation component of this transformation as a quaternion. More...
 
MStatus setRotation (const MQuaternion &quaternion, MSpace::Space=MSpace::kTransform)
 Change the rotation component of this transformation using a quaternion. More...
 
MStatus rotateBy (const MQuaternion &quaternion, MSpace::Space=MSpace::kTransform)
 Relatively change the rotation of this transformation using a quaternion. More...
 
MStatus getRotation (MEulerRotation &rotation) const
 Retrieve the rotation component of this transformation. More...
 
MStatus setRotation (const MEulerRotation &rotation)
 Change the rotation component of this transformation. More...
 
MStatus rotateBy (const MEulerRotation &rotation, MSpace::Space=MSpace::kTransform)
 Relatively change the rotation component of this transformation. More...
 
MPoint rotatePivot (MSpace::Space space, MStatus *ReturnStatus=nullptr) const
 Returns the pivot about which the rotation is applied. More...
 
MStatus setRotatePivot (const MPoint &point, MSpace::Space space, bool balance)
 Set the rotate pivot in centimeters about which rotation is applied. More...
 
MVector rotatePivotTranslation (MSpace::Space space, MStatus *ReturnStatus=nullptr) const
 Return the rotate pivot translation in centimeters. More...
 
MStatus setRotatePivotTranslation (const MVector &vec, MSpace::Space space)
 Set the rotate pivot translation in centimeters. More...
 
MStatus getRotationQuaternion (double &x, double &y, double &z, double &w, MSpace::Space=MSpace::kTransform) const
 Retrieve the rotation component of this transformation as a quaternion. More...
 
MStatus setRotationQuaternion (double x, double y, double z, double w, MSpace::Space=MSpace::kTransform)
 Change the rotation component of this transformation using a quaternion. More...
 
MStatus rotateByQuaternion (double x, double y, double z, double w, MSpace::Space=MSpace::kTransform)
 Relatively change the rotation of this transformation using a quaternion. More...
 
MStatus getRotation (double rotation[3], MTransformationMatrix::RotationOrder &order) const
 Retrieve the rotation component of this transformation. More...
 
MStatus setRotation (const double rotation[3], MTransformationMatrix::RotationOrder order)
 Change the rotation component of this transformation. More...
 
MStatus rotateBy (const double rotation[3], MTransformationMatrix::RotationOrder order, MSpace::Space=MSpace::kTransform)
 Relatively change the rotation component of this transformation. More...
 
MQuaternion rotateOrientation (MSpace::Space space, MStatus *ReturnStatus=nullptr) const
 Returns the rotation used to orient the local rotation space. More...
 
MStatus setRotateOrientation (const MQuaternion &quat, MSpace::Space space, bool balance)
 Set the rotation used to orient the local rotation space. More...
 
MTransformationMatrix::RotationOrder rotationOrder (MStatus *ReturnStatus=nullptr) const
 Returns the rotation order for the transform matrix - the order in which the Euler angles are applied to create the end rotation. More...
 
MStatus setRotationOrder (MTransformationMatrix::RotationOrder order, bool reorder)
 Change the rotation order for the transform - the order in which the Euler angles are applied to create the end rotation. More...
 
MTransformationMatrix restPosition (MStatus *ReturnStatus) const
 Retrieve the saved rest position of this transform. More...
 
MStatus setRestPosition (const MTransformationMatrix &matrix)
 Change the saved rest position of this transform. More...
 
MStatus resetFromRestPosition ()
 Reset the transform to its rest position. More...
 
MStatus clearRestPosition ()
 Clear the saved rest position of this transform. More...
 
bool isLimited (MFnTransform::LimitType type, MStatus *ReturnStatus=nullptr) const
 Determine if the specified limit attribute is enabled or disabled. More...
 
double limitValue (MFnTransform::LimitType type, MStatus *ReturnStatus=nullptr) const
 Determine the current value of the specified limit. More...
 
MStatus setLimit (MFnTransform::LimitType type, double value)
 Change the limit value for the specified limit type, and automatically enable the limit to be true. More...
 
MStatus enableLimit (MFnTransform::LimitType type, bool flag)
 Enable or disable the limit value for the specified limit type. More...
 
 MFnTransform (const MObject &object, MStatus *ret=NULL)
 Constructor. More...
 
MStatus getRotation (double[3], MTransformationMatrix::RotationOrder &order, MSpace::Space space) const
 This method is obsolete. More...
 
MStatus setRotation (const double[3], MTransformationMatrix::RotationOrder, MSpace::Space space)
 This method is obsolete. More...
 
MVector translation (MSpace::Space, MStatus *=nullptr) const
 This method is obsolete. More...
 
- Public Member Functions inherited from MFnDagNode
virtual ~MFnDagNode ()
 Destructor. More...
 
 MFnDagNode ()
 Class Constructor. More...
 
 MFnDagNode (MObject &object, MStatus *ret=NULL)
 This method is not available in Python. More...
 
 MFnDagNode (const MDagPath &object, MStatus *ret=NULL)
 Class Constructor. More...
 
MObject create (const MTypeId &typeId, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL)
 Creates a new DAG node with the given type tag. More...
 
MObject create (const MTypeId &typeId, const MString &name, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL)
 Creates a new DAG node with the given type tag. More...
 
MObject create (const MString &type, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL)
 Creates a new DAG node with the given type tag. More...
 
MObject create (const MString &type, const MString &name, MObject &parent=MObject::kNullObj, MStatus *ReturnStatus=NULL)
 Creates a new DAG node with the given type tag. More...
 
unsigned int parentCount (MStatus *ReturnStatus=NULL) const
 Determines the number of parent Nodes of the Node. More...
 
MObject parent (unsigned int i, MStatus *ReturnStatus=NULL) const
 Queries the DAG Node attached to the Function Set for the parent Node corresponding to the given index. More...
 
MStatus addChild (MObject &child, unsigned int index=kNextPos, bool keepExistingParents=false)
 Makes the given DAG Node a child of the DAG Node to which this instance of the Function Set is attached. More...
 
MStatus removeChild (MObject &child)
 Removes the given DAG Node from the parent. More...
 
MStatus removeChildAt (unsigned int index)
 Removes the child at the given index from the parent. More...
 
unsigned int childCount (MStatus *ReturnStatus=NULL) const
 Determines the number of child Nodes of the Node. More...
 
MObject child (unsigned int i, MStatus *ReturnStatus=NULL) const
 Queries the DAG Node attached to the Function Set for the child Node corresponding to the given index. More...
 
MObject dagRoot (MStatus *ReturnStatus=NULL)
 Determines the root of the first DAG Path to the DAG Node attached to the Function Set. More...
 
bool hasParent (const MObject &node, MStatus *ReturnStatus=NULL) const
 Determines whether or not the given Node is a parent of the DAG Node attached to the Function Set. More...
 
bool hasChild (const MObject &node, MStatus *ReturnStatus=NULL) const
 Determines whether or not the given Node is a child of the DAG Node attached to the Function Set. More...
 
bool isChildOf (const MObject &node, MStatus *ReturnStatus=NULL) const
 Determines whether or not the DAG Node attached to the Function Set is a child of the given node. More...
 
bool isParentOf (const MObject &node, MStatus *ReturnStatus=NULL) const
 Determines whether or not the DAG Node attached to the Function Set is a parent of the given node. More...
 
bool inUnderWorld (MStatus *ReturnStatus=NULL) const
 Determines whether or not the DAG Node is an underworld node. More...
 
bool inModel (MStatus *ReturnStatus=NULL) const
 Determines whether or not the DAG Node is in the model. More...
 
bool isInstanceable (MStatus *ReturnStatus=NULL) const
 Returns true if the DAG node can be instanced, and false otherwise. More...
 
MStatus setInstanceable (const bool how)
 Sets whether or not the DAG node is instanceable. More...
 
bool isInstanced (bool indirect=true, MStatus *ReturnStatus=NULL) const
 Determines whether the DAG Node attached to the Function Set is directly or indirectly instanced. More...
 
bool isInstancedAttribute (const MObject &attr, MStatus *ReturnStatus=NULL) const
 Returns true if the specified attribute is instanced. More...
 
unsigned int instanceCount (bool total, MStatus *ReturnStatus=NULL) const
 Determines the number of times the Node attached to the Function Set is instanced. More...
 
MObject duplicate (bool instance=false, bool instanceLeaf=false, MStatus *ReturnStatus=NULL) const
 This method duplicates the DAG hierarchy rooted at the current node. More...
 
MStatus getPath (MDagPath &path) const
 Returns a DAG Path to the DAG Node attached to the Function Set. More...
 
MStatus getAllPaths (MDagPathArray &paths) const
 Determines all DAG Paths to the DAG Node attached to the Function Set. More...
 
MString fullPathName (MStatus *ReturnStatus=NULL) const
 Return a string representing the full path from the root of the dag to this object. More...
 
MString partialPathName (MStatus *ReturnStatus=NULL) const
 Return a string representing the partial path from the root of the dag to this object. More...
 
MMatrix transformationMatrix (MStatus *ReturnStatus=NULL) const
 Returns the object space transformation matrix for this DAG node. More...
 
bool isIntermediateObject (MStatus *ReturnStatus=NULL) const
 Returns true if this object is an intermediate in a geometry calculation. More...
 
MStatus setIntermediateObject (bool isIntermediate)
 Sets whether this object is an intermediate in a geometry calculation. More...
 
int objectColor (MStatus *ReturnStatus=NULL) const
 This method is obsolete. More...
 
MStatus setObjectColor (int color)
 Sets the index for the current user defined inactive color used by the node. More...
 
bool usingObjectColor (MStatus *ReturnStatus=NULL) const
 This method is obsolete. More...
 
MStatus setUseObjectColor (bool useObjectColor)
 This method is obsolete. More...
 
MObjectColorType objectColorType (MStatus *ReturnStatus=NULL) const
 Determines whether or not the user defined inactive color will be used for the node, or whether the default inactive color will be used. More...
 
MStatus setObjectColorType (MObjectColorType type)
 Sets whether or not the user defined inactive object color will be used. More...
 
MStatus setObjectColor (const MColor &color)
 Sets the color value for the current user defined inactive color used by the node. More...
 
MColor objectColorRGB (MStatus *ReturnStatus=NULL) const
 Determines the RGB color for the current user defined inactive color used by the node. More...
 
int objectColorIndex (MStatus *ReturnStatus=NULL) const
 Determines the index for the current user defined inactive color used by the node. More...
 
MColor hiliteColor (MStatus *ReturnStatus=NULL) const
 Determines the current hilite color used by the node. More...
 
bool usingHiliteColor (MStatus *ReturnStatus=NULL) const
 Determines whether or not the hilite color will be used for the node. More...
 
MColor dormantColor (MStatus *ReturnStatus=NULL) const
 Determines the dormant color used by this node. More...
 
MColor activeColor (MStatus *ReturnStatus=NULL) const
 Determines the active color used by this node. More...
 
bool drawOverrideEnabled (MStatus *ReturnStatus=NULL) const
 Determines whether or not draw override is turned on for this node. More...
 
bool drawOverrideIsReference (MStatus *ReturnStatus=NULL) const
 Determines whether or not Display Type of the draw override is Reference for this node. More...
 
bool drawOverrideIsTemplate (MStatus *ReturnStatus=NULL) const
 Determines whether or not Display Type of the draw override is Template for this node. More...
 
bool drawOverrideColor (MColor &color, MStatus *ReturnStatus=NULL) const
 Determines the draw override color used by this node. More...
 
MStatus getConnectedSetsAndMembers (unsigned int instanceNumber, MObjectArray &sets, MObjectArray &comps, bool renderableSetsOnly) const
 Returns all the sets connected to the specified instance of this DAG object. More...
 
MBoundingBox boundingBox (MStatus *ReturnStatus=NULL) const
 Returns the bounding box for the dag node in object space. More...
 
MDagPath dagPath (MStatus *ReturnStatus=NULL) const
 Returns the DagPath to which the Function Set is attached. More...
 
virtual MStatus setObject (const MDagPath &path)
 Attaches Function Set to the DAG Node that has the given DAG Path. More...
 
MStatus setObject (MObject &object) override
 Attaches Function Set to given DAG Node. More...
 
MObject model (MStatus *ReturnStatus=NULL) const
 This method is obsolete. More...
 
 MFnDagNode (const MObject &object, MStatus *ret=NULL)
 No script support. More...
 
MStatus setObject (const MObject &object) override
 No script support. More...
 
- Public Member Functions inherited from MFnDependencyNode
virtual ~MFnDependencyNode ()
 Destructor.
 
 MFnDependencyNode ()
 Default constructor.
 
 MFnDependencyNode (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MObject create (const MTypeId &typeId, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type tag. More...
 
MObject create (const MTypeId &typeId, const MString &name, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type tag. More...
 
MObject create (const MString &type, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type. More...
 
MObject create (const MString &type, const MString &name, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type. More...
 
MTypeId typeId (MStatus *ReturnStatus=NULL) const
 Returns the type id of this node. More...
 
MString typeName (MStatus *ReturnStatus=NULL) const
 Returns the type name of this node. More...
 
MString name (MStatus *ReturnStatus=NULL) const
 Returns the name of this node. More...
 
MString absoluteName (MStatus *ReturnStatus=NULL) const
 Returns the absolute name of this node. More...
 
MString uniqueName (MStatus *ReturnStatus=NULL) const
 Returns the unique name of this node. More...
 
MString pluginName (MStatus *ReturnStatus=NULL) const
 Returns the name of the plug-in this MFnDependendencyNode was defined in. More...
 
MString setName (const MString &name, bool createNamespace=false, MStatus *ReturnStatus=NULL)
 Sets the name of this node. More...
 
MUuid uuid (MStatus *ReturnStatus=NULL) const
 Returns the node's UUID. More...
 
void setUuid (const MUuid &uuid, MStatus *ReturnStatus=NULL)
 Sets the node's UUID. More...
 
MStatus getConnections (MPlugArray &array) const
 Get all of the current connections to this node as an array of plugs. More...
 
unsigned int attributeCount (MStatus *ReturnStatus=NULL) const
 Returns the number of attributes that this node has. More...
 
MObject attribute (unsigned int index, MStatus *ReturnStatus=NULL) const
 Finds the attribute of this node at the given index. More...
 
MObject reorderedAttribute (unsigned int index, MStatus *ReturnStatus=NULL) const
 Some nodes, such as the various animCurve nodes, require that their attributes be set in a specific order for proper operation. More...
 
MObject attribute (const MString &attrName, MStatus *ReturnStatus=NULL) const
 Finds the attribute of this node that has the given name. More...
 
MAttrClass attributeClass (const MObject &attr, MStatus *ReturnStatus=NULL) const
 Returns the class (normal, dynamic, extension) of the specified attribute. More...
 
MStatus getAffectedAttributes (const MObject &attr, MObjectArray &affectedAttributes) const
 Returns an array of attributes that are affected by the attribute passed in. More...
 
MStatus getAffectedByAttributes (const MObject &attr, MObjectArray &affectedByAttributes) const
 Returns an array of attributes that affect the attribute passed in, attr. More...
 
MPlug findPlug (const MObject &attr, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
 Attempt to find a plug for the given attribute. More...
 
MPlug findPlug (const MString &attrName, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
 Attempt to find a plug for the given attribute. More...
 
MPlug findPlug (const MObject &attr, MStatus *ReturnStatus=NULL) const
 This method is obsolete. More...
 
MPlug findPlug (const MString &attrName, MStatus *ReturnStatus=NULL) const
 This method is obsolete. More...
 
MStatus addAttribute (const MObject &attr)
 Add a new dynamic attibute to this node. More...
 
MStatus removeAttribute (const MObject &attr)
 Remove a dynamic attribute from a node. More...
 
MPxNodeuserNode (MStatus *ReturnStatus=NULL) const
 If the function set's node is a plug-in node, then this method will extract the MPxNode pointer from it. More...
 
bool isFromReferencedFile (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node came from a referenced file. More...
 
bool isShared (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node is shared. More...
 
bool isTrackingEdits (MStatus *ReturnStatus=NULL) const
 Returns whether or not edits on the given node are being tracked by the generalized edit system. More...
 
bool hasUniqueName (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node's name is unique within the scene. More...
 
MString parentNamespace (MStatus *ReturnStatus=NULL) const
 Returns the name of the namespace in which this node resides. More...
 
bool isLocked (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node is locked. More...
 
MStatus setLocked (bool locked)
 Locks or unlocks this node. More...
 
bool isNewAttribute (const MObject &attr, MStatus *ReturnStatus=NULL) const
 Indicates whether or not the specified attribute was added to this node within the current scene. More...
 
MStatus setFlag (unsigned int flag, bool state)
 Sets the state of the specified flag for the node. More...
 
bool isFlagSet (unsigned int flag, MStatus *ReturnStatus=NULL) const
 Retrieves the current state of the specified flag for a node. More...
 
bool isDefaultNode (MStatus *ReturnStatus=NULL) const
 Returns true if the node is a default node. More...
 
MStatus setDoNotWrite (bool flag)
 Use this method to mark the "do not write" state of this node. More...
 
bool canBeWritten (MStatus *ReturnStatus=NULL) const
 Returns the do not write state of the node. More...
 
bool hasAttribute (const MString &name, MStatus *ReturnStatus=NULL) const
 Returns true if the node already has an attribute with the given name. More...
 
MObject getAliasAttr (bool force, MStatus *ReturnStatus=NULL)
 Returns the node's alias attribute, which is a special attribute used to store information about the node's attribute aliases. More...
 
bool setAlias (const MString &alias, const MString &name, const MPlug &plug, bool add=true, MStatus *ReturnStatus=NULL)
 Sets or removes an alias (i.e. More...
 
bool findAlias (const MString &alias, MObject &attrObj, MStatus *ReturnStatus=NULL) const
 Retrieves the attribute with the given alias. More...
 
bool getAliasList (MStringArray &strArray, MStatus *ReturnStatus=NULL)
 Returns a list of all attribute aliases for this node. More...
 
MString plugsAlias (const MPlug &plug, MStatus *ReturnStatus=NULL)
 Returns the alias for the plug's attribute or the empty string if that attribute has no alias. More...
 
MStatus setIcon (const MString &filename)
 Associates a custom icon with the node for display in the Maya UI. More...
 
MString icon (MStatus *ReturnStatus=NULL) const
 Returns the custom icon filename associated with the node. More...
 
MStatus getExternalContent (MExternalContentInfoTable &table) const
 Returns the external content (files) that this node depends on. More...
 
MStatus addExternalContentForFileAttr (MExternalContentInfoTable &table, const MObject &attr) const
 Adds content info to the specified table from a file path attribute. More...
 
MStatus setExternalContentForFileAttr (const MObject &attr, const MExternalContentLocationTable &table)
 Sets content info in the specified attribute from the table. More...
 
MStatus setExternalContent (const MExternalContentLocationTable &table)
 Changes the location of external content. More...
 
bool affectsAnimation (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node is allowed to animate. More...
 
MStatus setAffectsAnimation ()
 Define a node can affect animation. More...
 
MString setName (const MString &name, MStatus *ReturnStatus)
 This method is obsolete. More...
 
 MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL)
 This method is not available in Python. More...
 
bool getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL)
 This method is not available in Python. More...
 
virtual const adsk::Data::Associationsmetadata (MStatus *ReturnStatus=NULL) const
 This method is not available in Python. More...
 
virtual MStatus setMetadata (const adsk::Data::Associations &)
 This method is not available in Python. More...
 
virtual MStatus deleteMetadata ()
 This method is not available in Python. More...
 
virtual MStatus validateMetadata (MString &errors) const
 This method is not available in Python. More...
 
MStatus dgTimerOn ()
 Indicates that this node should collect DG timing data whenever DG timing is enabled. More...
 
MStatus dgTimerOff ()
 Indicates that this node should no longer collect DG timing data when DG timing is enabled. More...
 
MdgTimerState dgTimerQueryState (MStatus *ReturnStatus=NULL)
 The function returns the current on/off state of the node's timer. More...
 
MStatus dgTimerReset ()
 The function resets the dependency graph timers and counters for this node to zero. More...
 
double dgTimer (const MdgTimerMetric timerMetric, const MdgTimerType timerType, MStatus *ReturnStatus=NULL) const
 The function returns the specified timer value for the current node. More...
 
MStatus dgCallbacks (const MdgTimerType type, MStringArray &callbackName, MDoubleArray &value)
 Node callbacks that occur when timing is enabled get logged with the node and can be queried via this method. More...
 
MStatus dgCallbackIds (const MdgTimerType type, const MString &callbackName, MCallbackIdArray &callbackId, MDoubleArray &value)
 This method provides a further breakdown of the per-callback time returned via dgCallbacks() by returning the data on a per-callbackId basis. More...
 
MStatus addAttribute (const MObject &attr, MAttrClass type)
 This method is obsolete. More...
 
MStatus removeAttribute (const MObject &attr, MAttrClass type)
 This method is obsolete. More...
 
- Public Member Functions inherited from MFnBase
virtual ~MFnBase ()
 Class Destructor. More...
 
bool hasObj (MFn::Type) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
bool hasObj (const MObject &) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
MObject object (MStatus *ReturnStatus=nullptr) const
 Returns the MObject that is attached to the Function Set. More...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnTransform
static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnDagNode
static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnDependencyNode
static const char * className ()
 Returns the name of this class. More...
 
static MString classification (const MString &nodeTypeName)
 Retrieves the classification string for a node type. More...
 
static unsigned int allocateFlag (const MString pluginName, MStatus *ReturnStatus=NULL)
 Allocates a node flag for sole use by the caller. More...
 
static MStatus deallocateFlag (const MString pluginName, unsigned int flag)
 Deallocates a node flag which was previously allocated by a call to allocateFlag. More...
 
static MStatus deallocateAllFlags (const MString pluginName)
 Deallocates all of the node flags which are currently allocated to the specified plugin. More...
 
static void enableDGTiming (bool enable)
 Globally enables or disables the DG node timing mechanism. More...
 
- Static Public Member Functions inherited from MFnBase
static const char * className ()
 Returns the name of this class. More...
 
static const char * typeString (MFn::Type)
 Returns the type string for a given type. More...
 
static bool isValid (MFn::Type)
 Returns true if type is in the range of valid types. More...
 

Additional Inherited Members

- Public Types inherited from MFnTransform
enum  LimitType {
  kScaleMinX, kScaleMaxX, kScaleMinY, kScaleMaxY,
  kScaleMinZ, kScaleMaxZ, kShearMinXY, kShearMaxXY,
  kShearMinXZ, kShearMaxXZ, kShearMinYZ, kShearMaxYZ,
  kRotateMinX, kRotateMaxX, kRotateMinY, kRotateMaxY,
  kRotateMinZ, kRotateMaxZ, kTranslateMinX, kTranslateMaxX,
  kTranslateMinY, kTranslateMaxY, kTranslateMinZ, kTranslateMaxZ
}
 Limit types. More...
 
- Public Types inherited from MFnDagNode
enum  { kNextPos = 0xff }
 Anonymous enum to store constant values. More...
 
enum  MObjectColorType { kUseDefaultColor = 0, kUseIndexColor, kUseRGBColor }
 Enum to set how an object is colored. More...
 
- Public Types inherited from MFnDependencyNode
enum  MAttrClass { kLocalDynamicAttr = 1, kNormalAttr, kExtensionAttr, kInvalidAttr }
 Specifies the scope of the attribute. More...
 
enum  MdgTimerState { kTimerOff, kTimerOn, kTimerUninitialized, kTimerInvalidState }
 Possible states for the node's timer. More...
 
enum  MdgTimerMetric {
  kTimerMetric_callback, kTimerMetric_compute, kTimerMetric_dirty, kTimerMetric_draw,
  kTimerMetric_fetch, kTimerMetric_callbackViaAPI, kTimerMetric_callbackNotViaAPI, kTimerMetric_computeDuringCallback,
  kTimerMetric_computeNotDuringCallback, kTimerMetrics
}
 The different timer metrics which can be queried. More...
 
enum  MdgTimerType { kTimerType_self, kTimerType_inclusive, kTimerType_count, kTimerTypes }
 The types of timers which can be queried. More...
 

Detailed Description

Function set for joints.

This is the function set for joints.

The transformation matrix for a joint node is below.

  • matrix = [S] * [RO] * [R] * [JO] * [IS] * [T]

(where '*' denotes matrix multiplication).

These matrices are defined as follows:

  • [S] : scale
  • [RO] : rotateOrient (attribute name is rotateAxis)
  • [R] : rotate
  • [JO] : jointOrient
  • [IS] : parentScaleInverse
  • [T] : translate

The methods to get the value of these matrices are:

  • [S] : getScale
  • [RO] : getScaleOrientation
  • [R] : getRotation
  • [JO] : getOrientation
  • [IS] : (the inverse of the getScale on the parent transformation matrix)
  • [T] : translation
Examples:
AbcBullet/MayaTransformWriter.cpp, AbcBullet/MayaTransformWriter.h, AbcExport/MayaTransformWriter.cpp, AbcExport/MayaTransformWriter.h, AbcExport/MayaUtility.cpp, AbcExport/MayaUtility.h, and ik2Bsolver/ik2Bsolver.cpp.

Constructor & Destructor Documentation

~MFnIkJoint ( )
virtual

Destructor.

Class destructor.

MFnIkJoint ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
  • 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
MFnIkJoint ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
  • 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
MFnIkJoint ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
  • 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

Member Function Documentation

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kJoint.

Returns
the class type.

Reimplemented from MFnTransform.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnIkJoint".

Returns
Name of this class.
MObject create ( MObject  parent = MObject::kNullObj,
MStatus ReturnStatus = NULL 
)

Create a new joint in a skeleton.

In maya, skeletons are defined entirely by DAG hierarchy. So, giving the joint you want to attach to as a parent will add this joint to that skeleton.

Parameters
[in]parentthe parent object for this in the dag. A value of NULL specifies the world dag node as parent.
[out]ReturnStatusStatus Code (see below)
Returns
The parent transform of the new joint
Status Codes:
  • MS::kSuccess The joint was successfully created and added to the DAG
  • MS::kInsufficientMemory Not enough memory available to create the new joint
  • MS::kLicenseFailure Application not licensed for attempted operation
  • MS::kFailure An error occurred adding the new joint to the DAG.
MStatus getOrientation ( MQuaternion quaternion) const

Get the joint orientation.

This corresponds to the jointOrient attribute on the joint, which is stored internally as a quaternion. It is different from the rotation orientation defined in the transform node. Modifying the jointOrient changes the coordinate axes, which affects how scaling a joint behaves.

The matrix equations used to combine the jointOrient with the other transformation attributes of the joint are described in the description for the MFnIkJoint class.

Parameters
[out]quaternionthe quaternion representing the jointOrient
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The orientation was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
Examples:
AbcBullet/MayaTransformWriter.cpp, and AbcExport/MayaTransformWriter.cpp.
MStatus setOrientation ( const MQuaternion quaternion)

Set the jointOrient value.

This corresponds to the jointOrient attribute on the joint, which is stored internally as a quaternion. It is different from the rotation orientation defined in the transform node. Modifying the jointOrient changes the coordinate axes, which affects how scaling a joint behaves.

The matrix equations used to combine the jointOrient with the other transformation attributes of the joint are described in the description for the MFnIkJoint class.

Parameters
[in]quaternionthe joint orientation
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The jointOrient was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getOrientation ( MEulerRotation rotation) const

Get the orientation of the coordinate axes.

Parameters
[out]rotationthe euler rotation into which we will store the orientation
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The orientation was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setOrientation ( const MEulerRotation rotation)

Set the orientation of the coordinate axes.

Parameters
[in]rotationthe orientation
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The orientation was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getOrientation ( double  rotation[3],
MTransformationMatrix::RotationOrder order 
) const

Get the orientation of the coordinate axes.

Parameters
[out]rotationthe array into which we will store the angles
[out]orderstorage for the order to do the rotation in
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The orientation was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setOrientation ( const double  rotation[3],
MTransformationMatrix::RotationOrder  order 
)

Set the orientation of the coordinate axes.

Parameters
[in]rotationthe orientation
[in]orderthe order to do the rotation in
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The orientation was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getScaleOrientation ( MQuaternion quaternion) const

Get the orientation of the coordinate axes for rotation.

This is equivalent to calling the MFnTransform::rotateOrientation method, and corresponds to the rotateAxis attribute on the joint node.

Parameters
[out]quaternionthe quaternion into which we will store the rotate orientation
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The rotate orientation was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
Examples:
AbcBullet/MayaTransformWriter.cpp, and AbcExport/MayaTransformWriter.cpp.
MStatus setScaleOrientation ( const MQuaternion quaternion)

Set the orientation of the coordinate axes for rotation.

This is equivalent to calling the MFnTransform::setRotateOrientation method, and corresponds to the rotateAxis attribute on the joint node. The matrix equations used to combine the rotateAxis with the other transformation attributes of the joint are described in the description for the MFnIkJoint class.

Parameters
[out]quaternionthe rotate orientation
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The scale orientation was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getScaleOrientation ( double  rotation[3],
MTransformationMatrix::RotationOrder order 
) const

Get the orientation of the coordinate axes for rotation.

This is equivalent to calling the MFnTransform::rotateOrientation method but returns the Euler rotation rather than the quaternion rotation. The matrix equations used to combine the rotateAxis with the other transformation attributes of the joint are described in the description for the MFnIkJoint class.

Parameters
[out]rotationthe array into which we will store the angles
[out]orderstorage for the order to do the rotation in
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The rotate orientation was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setScaleOrientation ( const double  rotation[3],
MTransformationMatrix::RotationOrder  order 
)

Set the orientation of the coordinate axes for rotation.

This is equivalent to calling the MFnTransform::setRotateOrientation method, and corresponds to the rotateAxis attribute on the joint node. The matrix equations used to combine the rotateAxis with the other transformation attributes of the joint are described in the description for the MFnIkJoint class.

Parameters
[in]rotationthe rotate orientation
[in]orderthe order to do the rotation in
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The rotate orientation was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getSegmentScale ( double  scale[3]) const

Get the local space scale values for the joint segment (bone).

This is equivalent to calling MFnTransform::getScale.

Parameters
[out]scaleStorage for the scale values
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The scale values were successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setSegmentScale ( const double  scale[3])

Set the local space scale values for the joint segment (bone).

This is equivalent to calling Ttransform::setScale.

Parameters
[in]scalethe new scale values to set
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The scale values were successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getStiffness ( double  stiffness[3]) const

Get the stiffness (from 0 to 100.0) for the joint.

The stiffness attribute is used by ik solvers to generate a resistance to a joint motion. The higher the stiffness the less it will rotate. Stiffness works in relative sense: it determines the willingness of this joint to rotate with respect to the other joint in the ik chain.

Parameters
[out]stiffnessstorage for the stiffness values
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The stiffness was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setStiffness ( const double  stiffness[3])

Set the stiffness (from 0 to 100.0) for the joint.

The stiffness attribute is used by ik solvers to generate a resistance to a joint motion. The higher the stiffness the less it will rotate. Stiffness works in relative sense: it determines the willingness of this joint to rotate with respect to the other joint in the ik chain.

Parameters
[in]stiffnessthe X, Y, and Z stiffness values
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The stiffness was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getPreferredAngle ( double  rotation[3]) const

Get the preferred orientation for this joint (in XYZ order)

Parameters
[out]rotationthe array into which we will store the angles
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The preferred angles were returned successfully
  • MS::kFailure This function set has not been attached to a valid object
MStatus setPreferredAngle ( const double  rotation[3])

Set the preferred orientation for this joint (in XYZ order)

Parameters
[in]rotationthe array into which we will store the angles
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The preferred angles were successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus getDegreesOfFreedom ( bool &  freeInX,
bool &  freeInY,
bool &  freeInZ 
) const

Get degrees of freedom of this joint.

Parameters
[out]freeInXthe first degree of freedom
[out]freeInYthe second degree of freedom
[out]freeInZthe third degree of freedom
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The degrees of freedom values were successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setDegreesOfFreedom ( bool  freeInX,
bool  freeInY,
bool  freeInZ 
)

Set the degrees of freedom of this joint by specifying which axes are allowed to rotate.

Parameters
[in]freeInXthe first degree of freedom
[in]freeInYthe second degree of freedom
[in]freeInZthe third degree of freedom
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The degrees of freedom were successfully set
  • MS::kFailure This function set has not been attached to a valid object
double minRotateDampXRange ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping range in X.

This corresponds to the minRotateDampXRange attribute on the joint.

The minRotateDampRange and minRotateDampStrength are attributes used by ik to apply resistance to a joint rotation as it approaches the lower boundary of its rotation limits. This functionality allows joint motion to slow down smoothly until the joint reaches its rotation limits instead of stopping abruptly. The minRotateDampRange specifies when the deceleration should start, and the minRotateDampStrength defines the rate of deceleration.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The minimum damping range in X
Status Codes:
  • MS::kSuccess The damping range was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double minRotateDampYRange ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping range in Y.

This corresponds to the minRotateDampYRange attribute on the joint.

The minRotateDampRange and minRotateDampStrength are attributes used by ik to apply resistance to a joint rotation as it approaches the lower boundary of its rotation limits. This functionality allows joint motion to slow down smoothly until the joint reaches its rotation limits instead of stopping abruptly. The minRotateDampRange specifies when the deceleration should start, and the minRotateDampStrength defines the rate of deceleration.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The minimum damping range in Y
Status Codes:
  • MS::kSuccess The damping range was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double minRotateDampZRange ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping range in Z.

This corresponds to the minRotateDampZRange attribute on the joint.

The minRotateDampRange and minRotateDampStrength are attributes used by ik to apply resistance to a joint rotation as it approaches the lower boundary of its rotation limits. This functionality allows joint motion to slow down smoothly until the joint reaches its rotation limits instead of stopping abruptly. The minRotateDampRange specifies when the deceleration should start, and the minRotateDampStrength defines the rate of deceleration.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The minimum damping range in Z
Status Codes:
  • MS::kSuccess The damping range was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double maxRotateDampXRange ( MStatus ReturnStatus = NULL) const

Get the maximum of the damping range in X.

This corresponds to the maxRotateDampXRange attribute on the joint.

The minRotateDampRange and minRotateDampStrength are attributes used by ik to apply resistance to a joint rotation as it approaches the upper boundary of its rotation limits. This functionality allows joint motion to slow down smoothly until the joint reaches its rotation limits instead of stopping abruptly. The maxRotateDampRange specifies when the deceleration should start, and the maxRotateDampStrength defines the rate of deceleration.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The maximum of the damping range in X
Status Codes:
  • MS::kSuccess The damping range was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double maxRotateDampYRange ( MStatus ReturnStatus = NULL) const

Get the maximum of the damping range in Y.

This corresponds to the maxRotateDampYRange attribute on the joint.

The minRotateDampRange and minRotateDampStrength are attributes used by ik to apply resistance to a joint rotation as it approaches the upper boundary of its rotation limits. This functionality allows joint motion to slow down smoothly until the joint reaches its rotation limits instead of stopping abruptly. The maxRotateDampRange specifies when the deceleration should start, and the maxRotateDampStrength defines the rate of deceleration.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The maximum of the damping range in Y
Status Codes:
  • MS::kSuccess The damping range was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double maxRotateDampZRange ( MStatus ReturnStatus = NULL) const

Get the maximum of the damping range in Z.

This corresponds to the maxRotateDampZRange attribute on the joint.

The minRotateDampRange and minRotateDampStrength are attributes used by ik to apply resistance to a joint rotation as it approaches the upper boundary of its rotation limits. This functionality allows joint motion to slow down smoothly until the joint reaches its rotation limits instead of stopping abruptly. The maxRotateDampRange specifies when the deceleration should start, and the maxRotateDampStrength defines the rate of deceleration.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
The maximum of the damping range in Z
Status Codes:
  • MS::kSuccess The damping range was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMinRotateDampXRange ( double  angle)

Set the minimum of the damping range in X.

Parameters
[in]angleThe damping range to set
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping range was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMinRotateDampYRange ( double  angle)

Set the minimum of the damping range in Y.

Parameters
[in]anglethe damping range to set
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping range was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMinRotateDampZRange ( double  angle)

Set the minimum of the damping range in Z.

Parameters
[in]anglethe damping range to set
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping range was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMaxRotateDampXRange ( double  angle)

Set the maximum of the damping range in X.

Parameters
[in]anglethe damping range to set
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping range was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMaxRotateDampYRange ( double  angle)

Set the maximum of the damping range in Y.

Parameters
[in]anglethe damping range to set
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping range was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMaxRotateDampZRange ( double  angle)

Set the maximum of the damping range in Z.

Parameters
[in]anglethe damping range to set
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping range was successfully set
  • MS::kFailure This function set has not been attached to a valid object
double minRotateDampXStrength ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping strength in X.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double minRotateDampYStrength ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping strength in X.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double minRotateDampZStrength ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping strength in X.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double maxRotateDampXStrength ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping strength in X.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double maxRotateDampYStrength ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping strength in X.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
double maxRotateDampZStrength ( MStatus ReturnStatus = NULL) const

Get the minimum of the damping strength in X.

Parameters
[out]ReturnStatusStatus Code (see below)
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully returned
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMinRotateDampXStrength ( double  angle)

Set the maximum of the damping strength in Z.

Parameters
[in]angleThe new damping strength value
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMinRotateDampYStrength ( double  angle)

Set the maximum of the damping strength in Y.

Parameters
[in]angleThe new damping strength value
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMinRotateDampZStrength ( double  angle)

Set the minimum of the damping strength in Z.

Parameters
[in]angleThe new damping strength value
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMaxRotateDampXStrength ( double  angle)

Set the maximum of the damping strength in X.

Parameters
[in]angleThe new damping strength value
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMaxRotateDampYStrength ( double  angle)

Set the maximum of the damping strength in Y.

Parameters
[in]angleThe new damping strength value
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MStatus setMaxRotateDampZStrength ( double  angle)

Set the maximum of the damping strength in Z.

Parameters
[in]angleThe new damping strength value
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The damping strength value was successfully set
  • MS::kFailure This function set has not been attached to a valid object
MString hikJointName ( MStatus ReturnStatus = NULL) const

Get the name that the HumanIK solver uses to identify this joint.

Parameters
[out]ReturnStatusStatus code (see below)
Returns
The name used to identify this joint for HumanIK
Status Codes:
  • MS::kSuccess The name was successfully found
  • MS::kFailure The joint is not part of a humanIK handle
Examples:
AbcBullet/MayaTransformWriter.cpp, and AbcExport/MayaUtility.cpp.
MStatus getHikJointName ( MString name) const

NO SCRIPT SUPPORT.

Get the name that the HumanIK solver uses to identify this joint.

Python Notes

This method is not supported in Python. See the version which returns a string.

Parameters
[out]nameThe name used to identify this joint for HumanIK
Returns
Status code (see below)
Status Codes:
  • MS::kSuccess The name was successfully found
  • MS::kFailure The joint is not part of a humanIK handle

The documentation for this class was generated from the following files: