paya.runtime.nodes.Joint#

class Joint(*args, **kwargs)#

Inheritance

Joint Transform Transform DagNode DagNode Entity Entity ContainerBase ContainerBase DependNode DependNode PyNode ProxyUnicode

classmethod create(displayLocalAxis=True, worldMatrix=None, parent=None, name=None, freeze=True, decompose=True, rotateOrder='xyz', radius=1.0)#
Parameters

  • displayLocalAxis/dla (bool) – display the local matrix axes; defaults to True

  • worldMatrix/wm (None, tuple, list, str, Matrix, Matrix) – defines the joint’s default pose; defaults to None

  • parent/p (None, str, Transform) – an optional destination parent for the joint

  • name/n (str) – a name for the joint; defaults to None

  • freeze/fr (bool) – zero-out transformations (except translate) at the initial pose; defaults to True

  • decompose/dec (bool) –

    if False, connect to offsetParentMatrix instead of driving the joint’s SRT channels; note that, if freeze is requested, the initial matrix

    will always be applied via decomposition and then frozen; defaults to True

  • rotateOrder/ro (None, str, int, Math1D) – the rotate order for the joint; defaults to 'xyz'

  • radius/rad (float) – the joint display radius; defaults to 1.0

Returns

The joint.

Return type

Joint

insertCube(size=1.0, name=None)#

Inserts a poly cube under (including transform) under the joint to help test transformations visually.

Parameters

  • name/n (str) – a name for the cube; defaults to None

  • size/siz (float) – a single scalar for the cube’s width, height and depth; defaults to 1.0

Returns

The cube transform.

Return type

Transform

skinClusters()#
Returns

Associated skinClusters, in no particular order.

Return type

list

ikHandles(includeAsTip=True)#
Parameters

includeAsTip/iat (bool) – Include IK systems for which this joint is the tip; defaults to True

Returns

Associated IK handles, in no particular order.

Return type

list of IkHandle

chainFromHere(to=None)#
Parameters

to (str or Joint) – an optional terminator joint; defaults to None

Returns

A chain from this joint up to and including ‘to’ (if provided), or terminating before the first branch.

Return type

Chain

setMatrix(matrix, worldSpace=False)#

Overloads pymel.core.nodetypes.Transform.setMatrix() to include shear, which is observed on joints in Maya >= 2022.

Parameters

  • matrix (list, tuple, Matrix) – the matrix to apply

  • worldSpace (bool) – apply in world space

getJointOrientMatrix(plug=False)#

Returns joint orientation as a rotation matrix.

Parameters

plug/p (bool) – return an attribute instead of a value; this will be cooked only once, and afterwards retrieved via a ‘jointOrientMatrix’ attribute on the node; defaults to False

Returns

The joint orient matrix.

Return type

paya.runtime.data.Matrix or paya.runtime.plugs.Matrix