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

SkeletonProfile

Hérite de : Resource < RefCounted < Object

Hérité par : SkeletonProfileHumanoid

Classe de base pour un profil d'un squelette virtuel utilisé comme cible pour le re-ciblage.

Description

Cette ressource est utilisée dans EditorScenePostImport. Certains paramètres font référence aux os dans Skeleton3D, Skin, Animation, et certains autres nœuds sont réécrits en fonction des paramètres du SkeletonProfile.

Note : Ces paramètres ne doivent être définis que lors de la création d'un profil personnalisé. Dans SkeletonProfileHumanoid, ils sont définis en interne comme des valeurs en lecture seule.

Tutoriels

Re-ciblage des squelettes 3D

Propriétés

int	bone_size	`0`
int	group_size	`0`
StringName	root_bone	`&""`
StringName	scale_base_bone	`&""`

Méthodes

int	find_bone(bone_name: StringName) const
StringName	get_bone_name(bone_idx: int) const
StringName	get_bone_parent(bone_idx: int) const
StringName	get_bone_tail(bone_idx: int) const
StringName	get_group(bone_idx: int) const
StringName	get_group_name(group_idx: int) const
Vector2	get_handle_offset(bone_idx: int) const
Transform3D	get_reference_pose(bone_idx: int) const
TailDirection	get_tail_direction(bone_idx: int) const
Texture2D	get_texture(group_idx: int) const
bool	is_required(bone_idx: int) const
void	set_bone_name(bone_idx: int, bone_name: StringName)
void	set_bone_parent(bone_idx: int, bone_parent: StringName)
void	set_bone_tail(bone_idx: int, bone_tail: StringName)
void	set_group(bone_idx: int, group: StringName)
void	set_group_name(group_idx: int, group_name: StringName)
void	set_handle_offset(bone_idx: int, handle_offset: Vector2)
void	set_reference_pose(bone_idx: int, bone_name: Transform3D)
void	set_required(bone_idx: int, required: bool)
void	set_tail_direction(bone_idx: int, tail_direction: TailDirection)
void	set_texture(group_idx: int, texture: Texture2D)

Signaux

profile_updated() 🔗

This signal is emitted when change the value in profile. This is used to update key name in the BoneMap and to redraw the BoneMap editor.

Note: This signal is not connected directly to editor to simplify the reference, instead it is passed on to editor through the BoneMap.

Énumérations

enum TailDirection: 🔗

TailDirection TAIL_DIRECTION_AVERAGE_CHILDREN = 0

Direction vers les coordonnées moyennes des os enfants.

TailDirection TAIL_DIRECTION_SPECIFIC_CHILD = 1

Direction vers les coordonnées de l'os enfant spécifié.

TailDirection TAIL_DIRECTION_END = 2

La direction n'est pas calculée.

Descriptions des propriétés

int bone_size = 0 🔗

void set_bone_size(value: int)
int get_bone_size()

La quantité d'os dans la section re-ciblage de l'éditeur BoneMap. Par exemple, SkeletonProfileHumanoid a 56 os.

La taille des éléments dans la BoneMap set met à jour lors de la modification de cette propriété dans son SkeletonProfile assigné.

int group_size = 0 🔗

void set_group_size(value: int)
int get_group_size()

The amount of groups of bones in retargeting section's BoneMap editor. For example, SkeletonProfileHumanoid has 4 groups.

This property exists to separate the bone list into several sections in the editor.

StringName root_bone = &"" 🔗

void set_root_bone(value: StringName)
StringName get_root_bone()

Un nom d'os qui sera utilisé comme os racine dans AnimationTree. Cela devrait être l'os du parent des hanches qui existe à l'origine du monde.

StringName scale_base_bone = &"" 🔗

void set_scale_base_bone(value: StringName)
StringName get_scale_base_bone()

Un nom d'os qui utilisera la hauteur du modèle comme coefficient de normalisation. Par exemple, SkeletonProfileHumanoid le définit comme Hips.

Descriptions des méthodes

int find_bone(bone_name: StringName) const 🔗

Renvoie l'index de l'os dont le nom correspond à bone_name.

StringName get_bone_name(bone_idx: int) const 🔗

Renvoie le nom de l'os à l'index bone_idx qui sera le nom de la clé dans la BoneMap.

Dans le processus de re-ciblage, le nom d'os renvoyé est le nom de l'os du squelette cible.

StringName get_bone_parent(bone_idx: int) const 🔗

Renvoie le nom de l'os qui est le parent de l'os à l'index bone_idx. Le résultat est vide si l'os n'a pas de parent.

StringName get_bone_tail(bone_idx: int) const 🔗

Renvoie le nom de l'os qui est la queue de l'os à l'index bone_idx.

StringName get_group(bone_idx: int) const 🔗

Renvoie le groupe de l'os à l'index bone_idx.

StringName get_group_name(group_idx: int) const 🔗

Renvoie le nom du groupe à l'index group_idx qui sera le groupe de dessin dans l'éditeur BoneMap.

Vector2 get_handle_offset(bone_idx: int) const 🔗

Renvoie le décalage de l'os à l'index bone_idx qui sera la position du bouton dans l'éditeur BoneMap.

Il s'agit du décalage avec l'origine du coin supérieur gauche du carré.

Transform3D get_reference_pose(bone_idx: int) const 🔗

Renvoie la transformation de la pose de référence pour l'os à l'index bone_idx.

TailDirection get_tail_direction(bone_idx: int) const 🔗

Renvoie la direction de queue de l'os à l'index bone_idx.

Texture2D get_texture(group_idx: int) const 🔗

Returns the texture of the group at group_idx that will be the drawing group background image in the BoneMap editor.

bool is_required(bone_idx: int) const 🔗

Returns whether the bone at bone_idx is required for retargeting.

This value is used by the bone map editor. If this method returns true, and no bone is assigned, the handle color will be red on the bone map editor.

void set_bone_name(bone_idx: int, bone_name: StringName) 🔗

Définit le nom de l'os à l'index bone_idx qui sera le nom de la clé dans la BoneMap.

Dans le processus de re-ciblage, le nom d'os défini est le nom de l'os du squelette cible.

void set_bone_parent(bone_idx: int, bone_parent: StringName) 🔗

Définit l'os avec le nom bone_parent comme le parent de l'os à l'index bone_idx. Si une chaîne vide est passée, l'os n'a pas de parent.

void set_bone_tail(bone_idx: int, bone_tail: StringName) 🔗

Définit l'os avec le nom bone_tail comme queue de l'os à l'index bone_idx.

void set_group(bone_idx: int, group: StringName) 🔗

Définit le groupe de l'os à l'index bone_idx.

void set_group_name(group_idx: int, group_name: StringName) 🔗

Définit le nom du groupe à l'index group_idx qui sera le groupe de dessin dans l'éditeur BoneMap.

void set_handle_offset(bone_idx: int, handle_offset: Vector2) 🔗

Définit le décalage de l'os à l'index bone_idx qui sera la position du bouton dans l'éditeur BoneMap.

Il s'agit du décalage avec l'origine du coin supérieur gauche du carré.

void set_reference_pose(bone_idx: int, bone_name: Transform3D) 🔗

Définit la transformation de la pose de référence pour l'os à l'index bone_idx.

void set_required(bone_idx: int, required: bool) 🔗

Définit le statut de nécessité pour l'os à l'index bone_idx à required.

void set_tail_direction(bone_idx: int, tail_direction: TailDirection) 🔗

Sets the tail direction of the bone at bone_idx.

Note: This only specifies the method of calculation. The actual coordinates required should be stored in an external skeleton, so the calculation itself needs to be done externally.

void set_texture(group_idx: int, texture: Texture2D) 🔗

Sets the texture of the group at group_idx that will be the drawing group background image in the BoneMap editor.