Index · Object → RefCounted → Resource → SkeletonModification2D → SkeletonModification2DCCDIK

SkeletonModification2DCCDIK

A modification that uses CCDIK to manipulate a series of bones to reach a target in 2D.

Class Description

This SkeletonModification2D uses an algorithm called Cyclic Coordinate Descent Inverse Kinematics, or CCDIK, to manipulate a chain of bones in a Skeleton2D so it reaches a defined target.

CCDIK works by rotating a set of bones, typically called a "bone chain", on a single axis. Each bone is rotated to face the target from the tip (by default), which over a chain of bones allow it to rotate properly to reach the target. Because the bones only rotate on a single axis, CCDIK can look more robotic than other IK solvers.

Note: The CCDIK modifier has ccdik_joints, which are the data objects that hold the data for each joint in the CCDIK chain. This is different from a bone! CCDIK joints hold the data needed for each bone in the bone chain used by CCDIK.

CCDIK also fully supports angle constraints, allowing for more control over how a solution is met.

Properties

var ccdik_data_chain_length: int = 0

The number of CCDIK joints in the CCDIK modification.

var target_nodepath: NodePath = NodePath("")

The NodePath to the node that is the target for the CCDIK modification. This node is what the CCDIK chain will attempt to rotate the bone chain to.

var tip_nodepath: NodePath = NodePath("")

The end position of the CCDIK chain. Typically, this should be a child of a Bone2D node attached to the final Bone2D in the CCDIK chain.

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

Methods

func get_ccdik_joint_bone2d_node(joint_idx: int) -> NodePath

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

func get_ccdik_joint_bone_index(joint_idx: int) -> int

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

func get_ccdik_joint_constraint_angle_invert(joint_idx: int) -> bool

Returns whether the CCDIK joint at joint_idx uses an inverted joint constraint. See set_ccdik_joint_constraint_angle_invert() for details.

func get_ccdik_joint_constraint_angle_max(joint_idx: int) -> float

Returns the maximum angle constraint for the joint at joint_idx.

func get_ccdik_joint_constraint_angle_min(joint_idx: int) -> float

Returns the minimum angle constraint for the joint at joint_idx.

func get_ccdik_joint_enable_constraint(joint_idx: int) -> bool

Returns whether angle constraints on the CCDIK joint at joint_idx are enabled.

func get_ccdik_joint_rotate_from_joint(joint_idx: int) -> bool

Returns whether the joint at joint_idx is set to rotate from the joint, true, or to rotate from the tip, false. The default is to rotate from the tip.

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

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

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

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

func set_ccdik_joint_constraint_angle_invert(joint_idx: int, invert: bool) -> void

Sets whether the CCDIK joint at joint_idx uses an inverted joint constraint.

An inverted joint constraint only constraints the CCDIK joint to the angles outside of the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values.

func set_ccdik_joint_constraint_angle_max(joint_idx: int, angle_max: float) -> void

Sets the maximum angle constraint for the joint at joint_idx.

func set_ccdik_joint_constraint_angle_min(joint_idx: int, angle_min: float) -> void

Sets the minimum angle constraint for the joint at joint_idx.

func set_ccdik_joint_enable_constraint(joint_idx: int, enable_constraint: bool) -> void

Determines whether angle constraints on the CCDIK joint at joint_idx are enabled. When true, constraints will be enabled and taken into account when solving.

func set_ccdik_joint_rotate_from_joint(joint_idx: int, rotate_from_joint: bool) -> void

Sets whether the joint at joint_idx is set to rotate from the joint, true, or to rotate from the tip, false.

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)