Index · Object → RefCounted → Resource → SkeletonProfile

SkeletonProfile

Base class for a profile of a virtual skeleton used as a target for retargeting.

Inherited by (1): SkeletonProfileHumanoid
Class Description

This resource is used in EditorScenePostImport. Some parameters are referring to bones in Skeleton3D, Skin, Animation, and some other nodes are rewritten based on the parameters of SkeletonProfile.

Note: These parameters need to be set only when creating a custom profile. In SkeletonProfileHumanoid, they are defined internally as read-only values.

Properties

var bone_size: int = 0

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

The size of elements in BoneMap updates when changing this property in it's assigned SkeletonProfile.

var group_size: int = 0

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.

var root_bone: StringName = &""

A bone name that will be used as the root bone in AnimationTree. This should be the bone of the parent of hips that exists at the world origin.

var scale_base_bone: StringName = &""

A bone name which will use model's height as the coefficient for normalization. For example, SkeletonProfileHumanoid defines it as Hips.

Inherited from Resource (4)

Methods

func find_bone(bone_name: StringName) -> int

Returns the bone index that matches bone_name as its name.

func get_bone_name(bone_idx: int) -> StringName

Returns the name of the bone at bone_idx that will be the key name in the BoneMap.

In the retargeting process, the returned bone name is the bone name of the target skeleton.

func get_bone_parent(bone_idx: int) -> StringName

Returns the name of the bone which is the parent to the bone at bone_idx. The result is empty if the bone has no parent.

func get_bone_tail(bone_idx: int) -> StringName

Returns the name of the bone which is the tail of the bone at bone_idx.

func get_group(bone_idx: int) -> StringName

Returns the group of the bone at bone_idx.

func get_group_name(group_idx: int) -> StringName

Returns the name of the group at group_idx that will be the drawing group in the BoneMap editor.

func get_handle_offset(bone_idx: int) -> Vector2

Returns the offset of the bone at bone_idx that will be the button position in the BoneMap editor.

This is the offset with origin at the top left corner of the square.

func get_reference_pose(bone_idx: int) -> Transform3D

Returns the reference pose transform for bone bone_idx.

func get_tail_direction(bone_idx: int) -> SkeletonProfile.TailDirection

Returns the tail direction of the bone at bone_idx.

func get_texture(group_idx: int) -> Texture2D

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

func is_required(bone_idx: int) -> bool

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.

func set_bone_name(bone_idx: int, bone_name: StringName) -> void

Sets the name of the bone at bone_idx that will be the key name in the BoneMap.

In the retargeting process, the setting bone name is the bone name of the target skeleton.

func set_bone_parent(bone_idx: int, bone_parent: StringName) -> void

Sets the bone with name bone_parent as the parent of the bone at bone_idx. If an empty string is passed, then the bone has no parent.

func set_bone_tail(bone_idx: int, bone_tail: StringName) -> void

Sets the bone with name bone_tail as the tail of the bone at bone_idx.

func set_group(bone_idx: int, group: StringName) -> void

Sets the group of the bone at bone_idx.

func set_group_name(group_idx: int, group_name: StringName) -> void

Sets the name of the group at group_idx that will be the drawing group in the BoneMap editor.

func set_handle_offset(bone_idx: int, handle_offset: Vector2) -> void

Sets the offset of the bone at bone_idx that will be the button position in the BoneMap editor.

This is the offset with origin at the top left corner of the square.

func set_reference_pose(bone_idx: int, bone_name: Transform3D) -> void

Sets the reference pose transform for bone bone_idx.

func set_required(bone_idx: int, required: bool) -> void

Sets the required status for bone bone_idx to required.

func set_tail_direction(bone_idx: int, tail_direction: SkeletonProfile.TailDirection) -> void

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.

func set_texture(group_idx: int, texture: Texture2D) -> void

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

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

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

Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum TailDirection
TAIL_DIRECTION_AVERAGE_CHILDREN = 0

Direction to the average coordinates of bone children.

TAIL_DIRECTION_SPECIFIC_CHILD = 1

Direction to the coordinates of specified bone child.

TAIL_DIRECTION_END = 2

Direction is not calculated.