Index · Object → RefCounted → Resource → SkeletonModification2D → SkeletonModification2DFABRIK

SkeletonModification2DFABRIK

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

Class Description

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.

Properties

var fabrik_data_chain_length: int = 0

The number of FABRIK joints in the FABRIK modification.

var target_nodepath: 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.

Inherited from SkeletonModification2D (2)
var enabled: bool = true
Inherited from Resource (4)

Methods

func get_fabrik_joint_bone2d_node(joint_idx: int) -> NodePath

Returns the Bone2D node assigned to the FABRIK joint at joint_idx.

func get_fabrik_joint_bone_index(joint_idx: int) -> int

Returns the index of the Bone2D node assigned to the FABRIK joint at joint_idx.

func get_fabrik_joint_magnet_position(joint_idx: int) -> Vector2

Returns the magnet position vector for the joint at joint_idx.

func get_fabrik_joint_use_target_rotation(joint_idx: int) -> bool

Returns whether the joint is using the target's rotation rather than allowing FABRIK to rotate the joint. This option only applies to the tip/final joint in the chain.

func set_fabrik_joint_bone2d_node(joint_idx: int, bone2d_nodepath: NodePath) -> void

Sets the Bone2D node assigned to the FABRIK joint at joint_idx.

func set_fabrik_joint_bone_index(joint_idx: int, bone_idx: int) -> void

Sets the bone index, bone_idx, of the FABRIK joint at joint_idx. When possible, this will also update the bone2d_node of the FABRIK joint based on data provided by the linked skeleton.

func set_fabrik_joint_magnet_position(joint_idx: int, magnet_position: Vector2) -> void

Sets the magnet position vector for the joint at joint_idx.

func set_fabrik_joint_use_target_rotation(joint_idx: int, use_target_rotation: bool) -> void

Sets whether the joint at joint_idx will use the target node's rotation rather than letting FABRIK rotate the node.

Note: This option only works for the tip/final joint in the chain. For all other nodes, this option will be ignored.

Inherited from SkeletonModification2D (9)
func _draw_editor_gizmo() -> void
func _execute(delta: float) -> void
func _setup_modification(modification_stack: SkeletonModificationStack2D) -> void
func clamp_angle(angle: float, min: float, max: float, invert: bool) -> float
func get_is_setup() -> bool
func set_editor_draw_gizmo(draw_gizmo: bool) -> void
func set_is_setup(is_setup: bool) -> void
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

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