Index · Object → RefCounted → Resource → SkeletonModification2D → SkeletonModification2DTwoBoneIK

SkeletonModification2DTwoBoneIK

A modification that rotates two bones using the law of cosines to reach the target.

Class Description

This SkeletonModification2D uses an algorithm typically called TwoBoneIK. This algorithm works by leveraging the law of cosines and the lengths of the bones to figure out what rotation the bones currently have, and what rotation they need to make a complete triangle, where the first bone, the second bone, and the target form the three vertices of the triangle. Because the algorithm works by making a triangle, it can only operate on two bones.

TwoBoneIK is great for arms, legs, and really any joints that can be represented by just two bones that bend to reach a target. This solver is more lightweight than SkeletonModification2DFABRIK, but gives similar, natural looking results.

Properties

var flip_bend_direction: bool = false

If true, the bones in the modification will bend outward as opposed to inwards when contracting. If false, the bones will bend inwards when contracting.

var target_maximum_distance: float = 0.0

The maximum distance the target can be at. If the target is farther than this distance, the modification will solve as if it's at this maximum distance. When set to 0, the modification will solve without distance constraints.

var target_minimum_distance: float = 0.0

The minimum distance the target can be at. If the target is closer than this distance, the modification will solve as if it's at this minimum distance. When set to 0, the modification will solve without distance constraints.

var target_nodepath: NodePath = NodePath("")

The NodePath to the node that is the target for the TwoBoneIK modification. This node is what the modification will use when bending the Bone2D nodes.

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

Methods

func get_joint_one_bone2d_node() -> NodePath

Returns the Bone2D node that is being used as the first bone in the TwoBoneIK modification.

func get_joint_one_bone_idx() -> int

Returns the index of the Bone2D node that is being used as the first bone in the TwoBoneIK modification.

func get_joint_two_bone2d_node() -> NodePath

Returns the Bone2D node that is being used as the second bone in the TwoBoneIK modification.

func get_joint_two_bone_idx() -> int

Returns the index of the Bone2D node that is being used as the second bone in the TwoBoneIK modification.

func set_joint_one_bone2d_node(bone2d_node: NodePath) -> void

Sets the Bone2D node that is being used as the first bone in the TwoBoneIK modification.

func set_joint_one_bone_idx(bone_idx: int) -> void

Sets the index of the Bone2D node that is being used as the first bone in the TwoBoneIK modification.

func set_joint_two_bone2d_node(bone2d_node: NodePath) -> void

Sets the Bone2D node that is being used as the second bone in the TwoBoneIK modification.

func set_joint_two_bone_idx(bone_idx: int) -> void

Sets the index of the Bone2D node that is being used as the second bone in the TwoBoneIK modification.

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)