Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

IKModifier3D

Inherits: SkeletonModifier3D < Node3D < Node < Object

Inherited By: ChainIK3D, TwoBoneIK3D

A node for inverse kinematics which may modify more than one bone.

Description

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.

Properties

bool

mutable_bone_axes

true

Methods

void

clear_settings()

int

get_setting_count() const

void

reset()

void

set_setting_count(count: int)

Property Descriptions

bool mutable_bone_axes = true 🔗

  • void set_mutable_bone_axes(value: bool)

  • bool 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.

Method Descriptions

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.