SkeletonModification2DFABRIK

Experimental: This class may be changed or removed in future versions.

Hereda: SkeletonModification2D < Resource < RefCounted < Object

A modification that uses FABRIK to manipulate a series of Bone2D nodes to reach a target.

Descripción

This SkeletonModification2D uses an algorithm called Forward And Backward Reaching Inverse Kinematics, or FABRIK, to rotate a bone chain so that it reaches a target.

FABRIK works by knowing the positions and lengths of a series of bones, typically called a "bone chain". It first starts by running a forward pass, which places the final bone at the target's position. Then all other bones are moved towards the tip bone, so they stay at the defined bone length away. Then a backwards pass is performed, where the root/first bone in the FABRIK chain is placed back at the origin. Then all other bones are moved so they stay at the defined bone length away. This positions the bone chain so that it reaches the target when possible, but all of the bones stay the correct length away from each other.

Because of how FABRIK works, it often gives more natural results than those seen in SkeletonModification2DCCDIK.

Note: The FABRIK modifier has fabrik_joints, which are the data objects that hold the data for each joint in the FABRIK chain. This is different from Bone2D nodes! FABRIK joints hold the data needed for each Bone2D in the bone chain used by FABRIK.

To help control how the FABRIK joints move, a magnet vector can be passed, which can nudge the bones in a certain direction prior to solving, giving a level of control over the final result.

Propiedades

int

fabrik_data_chain_length

0

NodePath

target_nodepath

NodePath("")

Métodos

NodePath

get_fabrik_joint_bone2d_node(joint_idx: int) const

int

get_fabrik_joint_bone_index(joint_idx: int) const

Vector2

get_fabrik_joint_magnet_position(joint_idx: int) const

bool

get_fabrik_joint_use_target_rotation(joint_idx: int) const

void

set_fabrik_joint_bone2d_node(joint_idx: int, bone2d_nodepath: NodePath)

void

set_fabrik_joint_bone_index(joint_idx: int, bone_idx: int)

void

set_fabrik_joint_magnet_position(joint_idx: int, magnet_position: Vector2)

void

set_fabrik_joint_use_target_rotation(joint_idx: int, use_target_rotation: bool)

Descripciones de Propiedades

int fabrik_data_chain_length = 0 🔗

  • void set_fabrik_data_chain_length(value: int)

  • int get_fabrik_data_chain_length()

El número de articulaciones FABRIK en la modificación FABRIK.

NodePath target_nodepath = NodePath("") 🔗

The NodePath to the node that is the target for the FABRIK modification. This node is what the FABRIK chain will attempt to rotate the bone chain to.

Descripciones de Métodos

NodePath get_fabrik_joint_bone2d_node(joint_idx: int) const 🔗

Devuelve el nodo Bone2D asignado a la articulación FABRIK en joint_idx.

int get_fabrik_joint_bone_index(joint_idx: int) const 🔗

Devuelve el índice del nodo Bone2D asignado a la articulación FABRIK en joint_idx.

Vector2 get_fabrik_joint_magnet_position(joint_idx: int) const 🔗

Devuelve el vector de posición del imán para la articulación en joint_idx.

bool get_fabrik_joint_use_target_rotation(joint_idx: int) const 🔗

Devuelve si la articulación está usando la rotación del objetivo en lugar de permitir que FABRIK rote la articulación. Esta opción solo se aplica a la articulación punta/final de la cadena.

void set_fabrik_joint_bone2d_node(joint_idx: int, bone2d_nodepath: NodePath) 🔗

Establece el nodo Bone2D asignado a la articulación FABRIK en joint_idx.

void set_fabrik_joint_bone_index(joint_idx: int, bone_idx: int) 🔗

Establece el índice de hueso, bone_idx, de la articulación FABRIK en joint_idx. Cuando sea posible, esto también actualizará el bone2d_node de la articulación FABRIK basándose en los datos proporcionados por el esqueleto vinculado.

void set_fabrik_joint_magnet_position(joint_idx: int, magnet_position: Vector2) 🔗

Establece el vector de posición del imán para la articulación en joint_idx.

void set_fabrik_joint_use_target_rotation(joint_idx: int, use_target_rotation: bool) 🔗

Establece si la articulación en joint_idx usará la rotación del nodo objetivo en lugar de dejar que FABRIK rote el nodo.

Nota: Esta opción solo funciona para la articulación punta/final de la cadena. Para todos los demás nodos, esta opción será ignorada.