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.

SkeletonIK3D

已棄用: This class may be changed or removed in future versions.

繼承: SkeletonModifier3D < Node3D < Node < Object

可以將 Skeleton3D 骨骼鏈中的所有骨骼進行旋轉,從而將末端骨骼放置在正確的 3D 位置的節點。

說明

SkeletonIK3D 可以將 Skeleton3D 骨骼鏈中的所有骨骼進行旋轉,從而將末端骨骼放置在正確的 3D 位置。遊戲中 IK 的典型場景是將角色的腳放在地面上,或者將角色的手放在目前持有的物體上。SkeletonIK 在內部使用 FabrikInverseKinematic 來解決骨骼鏈,並將結果套用至 Skeleton3D bones_global_pose_override 屬性中所有受影響的骨骼鏈。如果完全應用,這將覆蓋任何來自 Animation 的骨骼變換或使用者設定的骨骼自訂姿勢。應用量可以用 SkeletonModifier3D.influence 屬性來控制。

# 在每一個新的影格上自動應用 IK 效果(不是目前的)。
skeleton_ik_node.start()

# 只在目前影格上應用 IK 效果
skeleton_ik_node.start(true)

# 停止 IK 效果並重設骨骼上的 bones_global_pose_override
skeleton_ik_node.stop()

# 應用完整的 IK 效果
skeleton_ik_node.set_influence(1.0)

# 應用一半的 IK 效果
skeleton_ik_node.set_influence(0.5)

# 應用零 IK 效果(數值為 0.01 或低於 0.01 也會移除 Skeleton 上的 bones_global_pose_override)
skeleton_ik_node.set_influence(0.0)

屬性

float

interpolation

Vector3

magnet

Vector3(0, 0, 0)

int

max_iterations

10

float

min_distance

0.01

bool

override_tip_basis

true

StringName

root_bone

&""

Transform3D

target

Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)

NodePath

target_node

NodePath("")

StringName

tip_bone

&""

bool

use_magnet

false

方法

Skeleton3D

get_parent_skeleton() const

bool

is_running()

void

start(one_time: bool = false)

void

stop()


屬性說明

float interpolation 🔗

  • void set_interpolation(value: float)

  • float get_interpolation()

已棄用: Use SkeletonModifier3D.influence instead.

IK 效果被套用至目前骨架骨骼鏈的程度的插值。1.0 的值將完全覆蓋所有骨架骨骼變換,而 0.0 的值將在視覺上停用 SkeletonIK。


Vector3 magnet = Vector3(0, 0, 0) 🔗

  • void set_magnet_position(value: Vector3)

  • Vector3 get_magnet_position()

IK 鏈的次要目標位置(首先是 target 屬性或 target_node)。使用磁鐵位置(極點目標)來控制 IK 鏈的彎曲。僅當骨骼鏈具有 2 個以上的骨骼時才有效。中間鏈骨位置將與磁鐵位置進行線性插值。


int max_iterations = 10 🔗

  • void set_max_iterations(value: int)

  • int get_max_iterations()

IK解算器使用的反覆運算迴圈的數量,以產生更準確(和優雅)的骨鏈效果。


float min_distance = 0.01 🔗

  • void set_min_distance(value: float)

  • float get_min_distance()

骨骼與目標物件之間的最小距離。如果距離低於這個值,IK解算器將停止進一步的迭代。


bool override_tip_basis = true 🔗

  • void set_override_tip_basis(value: bool)

  • bool is_override_tip_basis()

如果為 true,則用 target(或者如果定義了 target_node])的旋轉覆蓋尖端骨骼的旋轉。


StringName root_bone = &"" 🔗

目前的根骨骼的名稱,即 IK 鏈中的第一條骨骼。


Transform3D target = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0) 🔗

The first target of the IK chain where the tip bone is placed and, if override_tip_basis is true, how the tip bone is rotated. If target_node points to a valid node, that node's transform is used instead and this property is ignored.


NodePath target_node = NodePath("") 🔗

IK 鏈的目標節點 NodePath。如果有的話,將使用節點目前的 Transform3D,而不是 target 屬性。


StringName tip_bone = &"" 🔗

目前尖端骨骼的名稱,IK 鏈中放置在 target 變換處的最後一個骨骼(或者已定義 target_node)。


bool use_magnet = false 🔗

  • void set_use_magnet(value: bool)

  • bool is_using_magnet()

如果為 true,指示 IK 求解器在解算器鏈時考慮次要磁鐵目標(極點目標)。使用磁鐵位置(磁極目標)來控制 IK 鏈的彎曲。


方法說明

Skeleton3D get_parent_skeleton() const 🔗

回傳 SkeletonIK 進入場景樹時存在的父級 Skeleton3D 節點。如果 SkeletonIK3D 進入場景樹時父節點不是 Skeleton3D 節點,則回傳 null。


bool is_running() 🔗

如果 SkeletonIK 正將 IK 效果套用到 Skeleton3D 骨骼的連續影格上,則返回 true。如果 SkeletonIK 被停止或 start() 被使用時 one_time 參數被設定為 true,則返回 false。


void start(one_time: bool = false) 🔗

開始將 IK 效果套用到每一影格的 Skeleton3D 骨骼,但只會在下一影格開始生效。如果 one_time 為 true 則將立即生效,但仍會在下一影格重設。


void stop() 🔗

停止將 IK 效果套用到每影格的 Skeleton3D 骨骼,並呼叫 Skeleton3D.clear_bones_global_pose_override() 來移除所有骨骼上的現有覆蓋。