KinematicConstraint(Constraint)

base classes — bpy_struct, Constraint

class bpy.types.KinematicConstraint(Constraint)

Inverse Kinematics

chain_count

How many bones are included in the IK effect - 0 uses all bones (in [0, 255], default 0)

Type:

int

distance

Radius of limiting sphere (in [0, 100], default 0.0)

Type:

float

ik_type

(default 'COPY_POSE')

Type:

Literal[‘COPY_POSE’, ‘DISTANCE’]

iterations

Maximum number of solving iterations (in [0, 10000], default 0)

Type:

int

limit_mode

Distances in relation to sphere of influence to allow (default 'LIMITDIST_INSIDE')

  • LIMITDIST_INSIDE Inside – The object is constrained inside a virtual sphere around the target object, with a radius defined by the limit distance.

  • LIMITDIST_OUTSIDE Outside – The object is constrained outside a virtual sphere around the target object, with a radius defined by the limit distance.

  • LIMITDIST_ONSURFACE On Surface – The object is constrained on the surface of a virtual sphere around the target object, with a radius defined by the limit distance.

Type:

Literal[‘LIMITDIST_INSIDE’, ‘LIMITDIST_OUTSIDE’, ‘LIMITDIST_ONSURFACE’]

lock_location_x

Constraint position along X axis (default True)

Type:

bool

lock_location_y

Constraint position along Y axis (default True)

Type:

bool

lock_location_z

Constraint position along Z axis (default True)

Type:

bool

lock_rotation_x

Constraint rotation along X axis (default True)

Type:

bool

lock_rotation_y

Constraint rotation along Y axis (default True)

Type:

bool

lock_rotation_z

Constraint rotation along Z axis (default True)

Type:

bool

orient_weight

For Tree-IK: Weight of orientation control for this target (in [0.01, 1], default 0.0)

Type:

float

pole_angle

Pole rotation offset (in [-3.14159, 3.14159], default 0.0)

Type:

float

pole_subtarget

(default “”, never None)

Type:

str

pole_target

Object for pole rotation

Type:

Object

reference_axis

Constraint axis Lock options relative to Bone or Target reference (default 'BONE')

Type:

Literal[‘BONE’, ‘TARGET’]

subtarget

Armature bone, mesh or lattice vertex group, … (default “”, never None)

Type:

str

target

Target object

Type:

Object

use_location

Chain follows position of target (default False)

Type:

bool

use_rotation

Chain follows rotation of target (default False)

Type:

bool

use_stretch

Enable IK Stretching (default False)

Type:

bool

use_tail

Include bone’s tail as last element in chain (default False)

Type:

bool

weight

For Tree-IK: Weight of position control for this target (in [0.01, 1], default 0.0)

Type:

float

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions