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.

ChainIK3D

Hereda: IKModifier3D < SkeletonModifier3D < Node3D < Node < Object

Heredado por: IterateIK3D, SplineIK3D

A SkeletonModifier3D to apply inverse kinematics to bone chains containing an arbitrary number of bones.

Descripción

Base class of SkeletonModifier3D that automatically generates a joint list from the bones between the root bone and the end bone.

Note: All the methods in this class take an index parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. settings/<index>/root_bone_name).

Métodos

int

get_end_bone(index: int) const

BoneDirection

get_end_bone_direction(index: int) const

float

get_end_bone_length(index: int) const

String

get_end_bone_name(index: int) const

int

get_joint_bone(index: int, joint: int) const

String

get_joint_bone_name(index: int, joint: int) const

int

get_joint_count(index: int) const

int

get_root_bone(index: int) const

String

get_root_bone_name(index: int) const

bool

is_end_bone_extended(index: int) const

void

set_end_bone(index: int, bone: int)

void

set_end_bone_direction(index: int, bone_direction: BoneDirection)

void

set_end_bone_length(index: int, length: float)

void

set_end_bone_name(index: int, bone_name: String)

void

set_extend_end_bone(index: int, enabled: bool)

void

set_root_bone(index: int, bone: int)

void

set_root_bone_name(index: int, bone_name: String)


Descripciones de Métodos

int get_end_bone(index: int) const 🔗

Devuelve el índice del hueso final de la cadena de huesos.


BoneDirection get_end_bone_direction(index: int) const 🔗

Returns the tail direction of the end bone of the bone chain when is_end_bone_extended() is true.


float get_end_bone_length(index: int) const 🔗

Returns the end bone tail length of the bone chain when is_end_bone_extended() is true.


String get_end_bone_name(index: int) const 🔗

Devuelve el nombre del hueso final de la cadena de huesos.


int get_joint_bone(index: int, joint: int) const 🔗

Devuelve el índice del hueso en la articulación joint de la lista de articulaciones de la cadena de huesos.


String get_joint_bone_name(index: int, joint: int) const 🔗

Devuelve el nombre del hueso en la articulación joint de la lista de articulaciones de la cadena de huesos.


int get_joint_count(index: int) const 🔗

Devuelve el número de articulaciones de la lista de articulaciones de la cadena de huesos.


int get_root_bone(index: int) const 🔗

Devuelve el índice del hueso raíz de la cadena de huesos.


String get_root_bone_name(index: int) const 🔗

Devuelve el nombre del hueso raíz de la cadena de huesos.


bool is_end_bone_extended(index: int) const 🔗

Returns true if the end bone is extended to have a tail.


void set_end_bone(index: int, bone: int) 🔗

Establece el índice del hueso final de la cadena de huesos.


void set_end_bone_direction(index: int, bone_direction: BoneDirection) 🔗

Establece la dirección de la cola del hueso final de la cadena de huesos cuando is_end_bone_extended() es true.


void set_end_bone_length(index: int, length: float) 🔗

Establece la longitud de la cola del hueso final de la cadena de huesos cuando is_end_bone_extended() es true.


void set_end_bone_name(index: int, bone_name: String) 🔗

Sets the end bone name of the bone chain.

Note: The end bone must be the root bone or a child of the root bone. If they are the same, the tail must be extended by set_extend_end_bone() to modify the bone.


void set_extend_end_bone(index: int, enabled: bool) 🔗

Si enabled es true, el hueso final se extiende para tener una cola.

La configuración de la cola extendida se asigna al último elemento de la lista de articulaciones. En otras palabras, si estableces enabled en false, la configuración del último elemento de la lista de articulaciones no tiene efecto en el resultado simulado.


void set_root_bone(index: int, bone: int) 🔗

Establece el índice del hueso raíz de la cadena de huesos.


void set_root_bone_name(index: int, bone_name: String) 🔗

Establece el nombre del hueso raíz de la cadena de huesos.