paya.runtime.nodes.IkHandle

class IkHandle(*args, **kwargs)

Inheritance

IkHandle Transform Transform DagNode DagNode Entity Entity ContainerBase ContainerBase DependNode DependNode PyNode ProxyUnicode

classmethod create(name=None, **mayaOptions)

Parameters

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

• **mayaOptions – all overflow keyword arguments are forwarded to ikHandle()

Returns

The constructed node.

Return type

PyNode

getEndJoint()

Returns

The tip joint for the chain driven by this IK handle.

Return type

Joint

getJointList(includeTip=False)

Overloads getJointList() to add the includeTip/it option. Note that, for parity with PyMEL, this is set to False by default.

Parameters

includeTip/it (bool) – include the tip joint; defaults to False

Returns

Joints driven by this IK handle.

Return type

list

chain()

Returns

The driven chain, including tip.

Return type

Chain

setTwistVectors(startVector, endVector, upAxis, downAxis=None)

For spline handles only. Activates advanced twist options and configures the start / end vectors.

Parameters

• startVector (list, Vector, Math3D) – the start ‘up’ vector

• endVector (list, Vector, Math3D) – the end ‘up’ vector

• upAxis (str) – the chain axis to map to the ‘up’ vectors, for example ‘z’

• downAxis/da (str) – if you know the ‘bone’ axis of the chain, provide it here to avoid extraneous calculations; defaults to None

Returns

self

setPolePoint(point, maintainOffset=False)

Configures the pole vector by aiming towards point in world-space.

Parameters

• point (list, tuple, Point or Math3D) – the point to aim towards

• maintainOffset/mo (bool) – preserve chain state; defaults to False

Returns

self