Skip to content
Download
API reference

IKModifier3D

Inherits: SkeletonModifier3D < Spatial3D < Actor < Object

Inherited by: ChainIK3D, TwoBoneIK3D

An actor for inverse kinematics which may modify more than one bone.

Base class of SkeletonModifier3Ds that has some joint lists and applies inverse kinematics. This class has some structs, enums, and helper methods which are useful to solve inverse kinematics.

TypeNameDefault
boolmutable_bone_axestrue
ReturnsMethod
voidclear_settings()
intget_setting_count()
voidreset()
voidset_setting_count(count)

bool mutable_bone_axes = true

Setter/getter: set_mutable_bone_axes(), are_bone_axes_mutable()

If true, the solver retrieves the bone axis from the bone pose every frame.

If false, the solver retrieves the bone axis from the bone rest and caches it, which increases performance slightly, but position changes in the bone pose made before processing this IKModifier3D are ignored.

void clear_settings()

Clears all settings.

int get_setting_count() const

Returns the number of settings.

void reset()

Resets a state with respect to the current bone pose.

void set_setting_count(count: int)

Sets the number of settings.