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

SkeletonModification2DFABRIK

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

Eredita: SkeletonModification2D < Resource < RefCounted < Object

Una modificazione che utilizza FABRIK per manipolare una serie di nodi Bone2D per raggiungere un obiettivo.

Descrizione

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.

Proprietà

int	fabrik_data_chain_length	`0`
NodePath	target_nodepath	`NodePath("")`

Metodi

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)

Descrizioni delle proprietà

int fabrik_data_chain_length = 0 🔗

void set_fabrik_data_chain_length(value: int)
int get_fabrik_data_chain_length()

Il numero di articolazioni FABRIK nella modificazione FABRIK.

NodePath target_nodepath = NodePath("") 🔗

void set_target_node(value: NodePath)
NodePath get_target_node()

Il NodePath al nodo che è l'obiettivo per la modificazione FABRIK. Questo nodo è ciò verso cui la catena FABRIK tenterà di ruotare la catena d'ossa.

Descrizioni dei metodi

NodePath get_fabrik_joint_bone2d_node(joint_idx: int) const 🔗

Restituisce il nodo Bone2D assegnato all'articolazione FABRIK all'indice joint_idx.

int get_fabrik_joint_bone_index(joint_idx: int) const 🔗

Restituisce l'indice del nodo Bone2D assegnato all'articolazione FABRIK all'indice joint_idx.

Vector2 get_fabrik_joint_magnet_position(joint_idx: int) const 🔗

Restituisce il vettore di posizione magnete per l'articolazione all'indice joint_idx.

bool get_fabrik_joint_use_target_rotation(joint_idx: int) const 🔗

Restituisce se l'articolazione sta usando la rotazione dell'obiettivo anziché consentire a FABRIK di ruotare l'articolazione. Questa opzione si applica solo all'articolazione di punta/finale nella catena.

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

Imposta il nodo Bone2D assegnato all'articolazione FABRIK all'indice joint_idx.

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

Imposta l'indice osseo, bone_idx, dell'articolazione FABRIK su joint_idx. Quando possibile, questo aggiornerà anche il bone2d_node dell'articolazione FABRIK in base ai dati forniti dallo scheletro collegato.

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

Imposta il vettore di posizione magnete per l'articolazione all'indice joint_idx.

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

Imposta se l'articolazione all'indice joint_idx utilizzerà la rotazione del nodo obiettivo anziché lasciare che FABRIK ruoti il nodo.

Nota: Questa opzione funziona solo per l'articolazione di punta/finale nella catena. Per tutti gli altri nodi, questa opzione verrà ignorata.