Python API 2.0 Reference
Public Member Functions | Static Public Member Functions | List of all members
OpenMayaAnim.MFnIkJoint Class Reference
+ Inheritance diagram for OpenMayaAnim.MFnIkJoint:

Public Member Functions

def __init__ ()
 
def create ()
 
def degreesOfFreedom ()
 
def hikJointName ()
 
def maxRotateDampXRange ()
 
def maxRotateDampXStrength ()
 
def maxRotateDampYRange ()
 
def maxRotateDampYStrength ()
 
def maxRotateDampZRange ()
 
def maxRotateDampZStrength ()
 
def minRotateDampXRange ()
 
def minRotateDampXStrength ()
 
def minRotateDampYRange ()
 
def minRotateDampYStrength ()
 
def minRotateDampZRange ()
 
def minRotateDampZStrength ()
 
def orientation ()
 
def orientationComponents ()
 
def preferredAngle ()
 
def scaleOrientation ()
 
def segmentScale ()
 
def setDegreesOfFreedom ()
 
def setMaxRotateDampXRange ()
 
def setMaxRotateDampXStrength ()
 
def setMaxRotateDampYRange ()
 
def setMaxRotateDampYStrength ()
 
def setMaxRotateDampZRange ()
 
def setMaxRotateDampZStrength ()
 
def setMinRotateDampXRange ()
 
def setMinRotateDampXStrength ()
 
def setMinRotateDampYRange ()
 
def setMinRotateDampYStrength ()
 
def setMinRotateDampZRange ()
 
def setMinRotateDampZStrength ()
 
def setOrientation ()
 
def setPreferredAngle ()
 
def setScaleOrientation ()
 
def setSegmentScale ()
 
def setStiffness ()
 
def stiffness ()
 
- Public Member Functions inherited from OpenMaya.MFnTransform
def __init__ ()
 
def clearRestPosition ()
 
def create ()
 
def enableLimit ()
 
def isLimited ()
 
def limitValue ()
 
def resetFromRestPosition ()
 
def resetTransformation ()
 
def restPosition ()
 
def rotateBy ()
 
def rotateByComponents ()
 
def rotateOrientation ()
 
def rotatePivot ()
 
def rotatePivotTranslation ()
 
def rotation ()
 
def rotationComponents ()
 
def rotationOrder ()
 
def scale ()
 
def scaleBy ()
 
def scalePivot ()
 
def scalePivotTranslation ()
 
def setLimit ()
 
def setRestPosition ()
 
def setRotateOrientation ()
 
def setRotatePivot ()
 
def setRotatePivotTranslation ()
 
def setRotation ()
 
def setRotationComponents ()
 
def setRotationOrder ()
 
def setScale ()
 
def setScalePivot ()
 
def setScalePivotTranslation ()
 
def setShear ()
 
def setTransformation ()
 
def setTranslation ()
 
def shear ()
 
def shearBy ()
 
def transformation ()
 
def translateBy ()
 
def translation ()
 
- Public Member Functions inherited from OpenMaya.MFnDagNode
def __init__ ()
 
def addChild ()
 
def child ()
 
def childCount ()
 
def create ()
 
def dagPath ()
 
def dagRoot ()
 
def duplicate ()
 
def fullPathName ()
 
def getAllPaths ()
 
def getConnectedSetsAndMembers ()
 
def getPath ()
 
def hasChild ()
 
def hasParent ()
 
def instanceCount ()
 
def isChildOf ()
 
def isInstanced ()
 
def isInstancedAttribute ()
 
def isParentOf ()
 
def parent ()
 
def parentCount ()
 
def partialPathName ()
 
def removeChild ()
 
def removeChildAt ()
 
def setObject ()
 
def transformationMatrix ()
 
- Public Member Functions inherited from OpenMaya.MFnDependencyNode
def __init__ ()
 
def absoluteName ()
 
def addAttribute ()
 
def addExternalContentForFileAttr ()
 
def affectsAnimation ()
 
def attribute ()
 
def attributeClass ()
 
def attributeCount ()
 
def canBeWritten ()
 
def create ()
 
def dgCallbackIds ()
 
def dgCallbacks ()
 
def dgTimer ()
 
def dgTimerOff ()
 
def dgTimerOn ()
 
def dgTimerQueryState ()
 
def dgTimerReset ()
 
def findAlias ()
 
def findPlug ()
 
def getAffectedAttributes ()
 
def getAffectingAttributes ()
 
def getAliasAttr ()
 
def getAliasList ()
 
def getConnections ()
 
def getExternalContent ()
 
def hasAttribute ()
 
def hasUniqueName ()
 
def isFlagSet ()
 
def isNewAttribute ()
 
def isTrackingEdits ()
 
def name ()
 
def plugsAlias ()
 
def removeAttribute ()
 
def reorderedAttribute ()
 
def setAffectsAnimation ()
 
def setAlias ()
 
def setDoNotWrite ()
 
def setExternalContent ()
 
def setExternalContentForFileAttr ()
 
def setFlag ()
 
def setName ()
 
def setUuid ()
 
def uniqueName ()
 
def userNode ()
 
def uuid ()
 
- Public Member Functions inherited from OpenMaya.MFnBase
def __init__ ()
 
def hasObj ()
 
def object ()
 
def setObject ()
 
def type ()
 

Static Public Member Functions

def __new__ ()
 
- Static Public Member Functions inherited from OpenMaya.MFnTransform
def __new__ ()
 
def balanceTransformation ()
 
- Static Public Member Functions inherited from OpenMaya.MFnDagNode
def __new__ ()
 
- Static Public Member Functions inherited from OpenMaya.MFnDependencyNode
def __new__ ()
 
def allocateFlag ()
 
def classification ()
 
def deallocateAllFlags ()
 
def deallocateFlag ()
 
- Static Public Member Functions inherited from OpenMaya.MFnBase
def __new__ ()
 

Additional Inherited Members

- Static Public Attributes inherited from OpenMaya.MFnTransform
int kRotateMaxX = 13
 
int kRotateMaxY = 15
 
int kRotateMaxZ = 17
 
int kRotateMinX = 12
 
int kRotateMinY = 14
 
int kRotateMinZ = 16
 
int kScaleMaxX = 1
 
int kScaleMaxY = 3
 
int kScaleMaxZ = 5
 
int kScaleMinX = 0
 
int kScaleMinY = 2
 
int kScaleMinZ = 4
 
int kShearMaxXY = 7
 
int kShearMaxXZ = 9
 
int kShearMaxYZ = 11
 
int kShearMinXY = 6
 
int kShearMinXZ = 8
 
int kShearMinYZ = 10
 
int kTranslateMaxX = 19
 
int kTranslateMaxY = 21
 
int kTranslateMaxZ = 23
 
int kTranslateMinX = 18
 
int kTranslateMinY = 20
 
int kTranslateMinZ = 22
 
- Static Public Attributes inherited from OpenMaya.MFnDagNode
int kNextPos = 255
 
- Static Public Attributes inherited from OpenMaya.MFnDependencyNode
int kTimerMetrics = 9
 
int kTimerTypes = 3
 
int kExtensionAttr = 3
 
int kInvalidAttr = 4
 
int kLocalDynamicAttr = 1
 
int kNormalAttr = 2
 
int kTimerInvalidState = 3
 
int kTimerOff = 0
 
int kTimerOn = 1
 
int kTimerUninitialized = 2
 
int kTimerMetric_callback = 0
 
int kTimerMetric_callbackNotViaAPI = 6
 
int kTimerMetric_callbackViaAPI = 5
 
int kTimerMetric_compute = 1
 
int kTimerMetric_computeDuringCallback = 7
 
int kTimerMetric_computeNotDuringCallback = 8
 
int kTimerMetric_dirty = 2
 
int kTimerMetric_draw = 3
 
int kTimerMetric_fetch = 4
 
int kTimerType_count = 2
 
int kTimerType_inclusive = 1
 
int kTimerType_self = 0
 
- Properties inherited from OpenMaya.MFnDagNode
 boundingBox = property(...)
 
 inModel = property(...)
 
 inUnderWorld = property(...)
 
 isInstanceable = property(...)
 
 isIntermediateObject = property(...)
 
 objectColor = property(...)
 
 objectColorRGB = property(...)
 
 objectColorType = property(...)
 
 useObjectColor = property(...)
 
- Properties inherited from OpenMaya.MFnDependencyNode
 isDefaultNode = property(...)
 
 isFromReferencedFile = property(...)
 
 isLocked = property(...)
 
 isShared = property(...)
 
 namespace = property(...)
 
 pluginName = property(...)
 
 typeId = property(...)
 
 typeName = property(...)
 

Detailed Description

Function set joints.

__init__()
Initializes a new, empty MFnIKJoint object.

Method resolution order:
-   MFnIkJoint
-   OpenMaya.MFnTransform
-   OpenMaya.MFnDagNode
-   OpenMaya.MFnDependencyNode
-   OpenMaya.MFnBase
-   builtins.object

Constructor & Destructor Documentation

def OpenMayaAnim.MFnIkJoint.__init__ ( ) 
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaAnim.MFnIkJoint.__new__ ( )
static 
Create and return a new object.  See help(type) for accurate signature.
def OpenMayaAnim.MFnIkJoint.create ( ) 
create(parent=MObject.kNullObj) -> new joint node MObject


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.

parent: the parent object for this in the dag.  A value of
                            NULL specifies the world dag node as parent.
Return: The parent transform of the new joint
def OpenMayaAnim.MFnIkJoint.degreesOfFreedom ( ) 
Gets degrees of freedom for this joint, that is, which axes are free
to rotate
def OpenMayaAnim.MFnIkJoint.hikJointName ( ) 
Get the name that HIK uses to identify this joint
def OpenMayaAnim.MFnIkJoint.maxRotateDampXRange ( ) 
Get the maximum of the damping range in X. This corresponds to the
maxRotateDampXRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.maxRotateDampXStrength ( ) 
Get the maximum of the damping strength in X. This corresponds to the
maxRotateDampXStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.maxRotateDampYRange ( ) 
Get the maximum of the damping range in Y. This corresponds to the
maxRotateDampYRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.maxRotateDampYStrength ( ) 
Get the maximum of the damping strength in Y. This corresponds to the
maxRotateDampYStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.maxRotateDampZRange ( ) 
Get the maximum of the damping range in Z. This corresponds to the
maxRotateDampZRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.maxRotateDampZStrength ( ) 
Get the maximum of the damping strength in Z. This corresponds to the
maxRotateDampZStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.minRotateDampXRange ( ) 
Get the minimum of the damping range in X. This corresponds to the
minRotateDampXRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.minRotateDampXStrength ( ) 
Get the minimum of the damping strength in X. This corresponds to the
minRotateDampXStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.minRotateDampYRange ( ) 
Get the minimum of the damping range in Y. This corresponds to the
minRotateDampYRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.minRotateDampYStrength ( ) 
Get the minimum of the damping strength in Y. This corresponds to the
minRotateDampYStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.minRotateDampZRange ( ) 
Get the minimum of the damping range in Z. This corresponds to the
minRotateDampZRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.minRotateDampZStrength ( ) 
Get the minimum of the damping strength in Z. This corresponds to the
minRotateDampZStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.orientation ( ) 
Gets the joint orientation as either an Euler rotation or a 
quaternion
def OpenMayaAnim.MFnIkJoint.orientationComponents ( ) 
Get the joint orientation

Return: rotation angles and rotation order
def OpenMayaAnim.MFnIkJoint.preferredAngle ( ) 
Get the preferred orientation angle for the joint.

Return: preferred angle
def OpenMayaAnim.MFnIkJoint.scaleOrientation ( ) 
Gets the orientation of the coordinate axes, as either a quaternion
or a sequence of 4 values, namely, the Euler rotation components and
the order
def OpenMayaAnim.MFnIkJoint.segmentScale ( ) 
Get the local space scale values for the joint segment (bone). This is
equivalent to calling MFnTransform::getScale.

Return: segment scale
def OpenMayaAnim.MFnIkJoint.setDegreesOfFreedom ( ) 
Set the degrees of freedom for this joint by specifying which axes
are allowed to rotate
def OpenMayaAnim.MFnIkJoint.setMaxRotateDampXRange ( ) 
Set the maximum of the damping range in X. This corresponds to the
setMaxRotateDampXRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMaxRotateDampXStrength ( ) 
Set the maximum of the damping strength in X. This corresponds to the
setMaxRotateDampXStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMaxRotateDampYRange ( ) 
Set the maximum of the damping range in Y. This corresponds to the
setMaxRotateDampYRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMaxRotateDampYStrength ( ) 
Set the maximum of the damping strength in Y. This corresponds to the
setMaxRotateDampYStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMaxRotateDampZRange ( ) 
Set the maximum of the damping range in Z. This corresponds to the
setMaxRotateDampZRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMaxRotateDampZStrength ( ) 
Set the maximum of the damping strength in Z. This corresponds to the
setMaxRotateDampZStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMinRotateDampXRange ( ) 
Set the minimum of the damping range in X. This corresponds to the
setMinRotateDampXRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMinRotateDampXStrength ( ) 
Set the minimum of the damping strength in X. This corresponds to the
setMinRotateDampXStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMinRotateDampYRange ( ) 
Set the minimum of the damping range in Y. This corresponds to the
setMinRotateDampYRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMinRotateDampYStrength ( ) 
Set the minimum of the damping strength in Y. This corresponds to the
setMinRotateDampYStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMinRotateDampZRange ( ) 
Set the minimum of the damping range in Z. This corresponds to the
setMinRotateDampZRange attribute on the joint
def OpenMayaAnim.MFnIkJoint.setMinRotateDampZStrength ( ) 
Set the minimum of the damping strength in Z. This corresponds to the
setMinRotateDampZStrength attribute on the joint
def OpenMayaAnim.MFnIkJoint.setOrientation ( ) 
Sets the joint orientation, which can be specified as either an Euler
rotation, a quaternion, or a sequence of 4 values, namely, the Euler
rotation components and the order
def OpenMayaAnim.MFnIkJoint.setPreferredAngle ( ) 
Set the preferred orientation angle for the joint.
def OpenMayaAnim.MFnIkJoint.setScaleOrientation ( ) 
Sets the orientation of the coordinate axes, which can be specified as either an Euler
rotation, a quaternion, or a sequence of 4 values, namely, the Euler
rotation components and the order
def OpenMayaAnim.MFnIkJoint.setSegmentScale ( ) 
Set the segment scale for the joint.
def OpenMayaAnim.MFnIkJoint.setStiffness ( ) 
Set the stiffness for the joint. This is equivalent to calling
MFnTransform::setScale
def OpenMayaAnim.MFnIkJoint.stiffness ( ) 
Get the stiffness for the joint.

Return: stiffness