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.

Generic6DOFJoint3D

繼承: Joint3D < Node3D < Node < Object

一種物理關節,允許在兩個 3D 物理物件之間進行複雜的移動和旋轉。

說明

Generic6DOFJoint3D(6 Degrees Of Freedom,六自由度)關節允許通過鎖定某些軸的旋轉和平移來實作自訂型別的關節。

前三個自由度代表物理體的線性運動,後三個自由度代表物理題的角度運動。每個軸都可以進行鎖定或限制。

屬性

float

angular_drive_x/torque_limit

3.4028235e+38

float

angular_drive_y/torque_limit

3.4028235e+38

float

angular_drive_z/torque_limit

3.4028235e+38

float

angular_limit_x/damping

1.0

bool

angular_limit_x/enabled

true

float

angular_limit_x/erp

0.5

float

angular_limit_x/force_limit

0.0

float

angular_limit_x/lower_angle

0.0

float

angular_limit_x/restitution

0.0

float

angular_limit_x/softness

0.5

float

angular_limit_x/upper_angle

0.0

float

angular_limit_y/damping

1.0

bool

angular_limit_y/enabled

true

float

angular_limit_y/erp

0.5

float

angular_limit_y/force_limit

0.0

float

angular_limit_y/lower_angle

0.0

float

angular_limit_y/restitution

0.0

float

angular_limit_y/softness

0.5

float

angular_limit_y/upper_angle

0.0

float

angular_limit_z/damping

1.0

bool

angular_limit_z/enabled

true

float

angular_limit_z/erp

0.5

float

angular_limit_z/force_limit

0.0

float

angular_limit_z/lower_angle

0.0

float

angular_limit_z/restitution

0.0

float

angular_limit_z/softness

0.5

float

angular_limit_z/upper_angle

0.0

bool

angular_motor_x/enabled

false

float

angular_motor_x/force_limit

300.0

float

angular_motor_x/target_velocity

0.0

bool

angular_motor_y/enabled

false

float

angular_motor_y/force_limit

300.0

float

angular_motor_y/target_velocity

0.0

bool

angular_motor_z/enabled

false

float

angular_motor_z/force_limit

300.0

float

angular_motor_z/target_velocity

0.0

float

angular_spring_x/damping

0.0

bool

angular_spring_x/enabled

false

float

angular_spring_x/equilibrium_point

0.0

float

angular_spring_x/stiffness

0.0

float

angular_spring_y/damping

0.0

bool

angular_spring_y/enabled

false

float

angular_spring_y/equilibrium_point

0.0

float

angular_spring_y/stiffness

0.0

float

angular_spring_z/damping

0.0

bool

angular_spring_z/enabled

false

float

angular_spring_z/equilibrium_point

0.0

float

angular_spring_z/stiffness

0.0

float

linear_drive_x/force_limit

3.4028235e+38

float

linear_drive_y/force_limit

3.4028235e+38

float

linear_drive_z/force_limit

3.4028235e+38

float

linear_limit_x/damping

1.0

bool

linear_limit_x/enabled

true

float

linear_limit_x/lower_distance

0.0

float

linear_limit_x/restitution

0.5

float

linear_limit_x/softness

0.7

float

linear_limit_x/upper_distance

0.0

float

linear_limit_y/damping

1.0

bool

linear_limit_y/enabled

true

float

linear_limit_y/lower_distance

0.0

float

linear_limit_y/restitution

0.5

float

linear_limit_y/softness

0.7

float

linear_limit_y/upper_distance

0.0

float

linear_limit_z/damping

1.0

bool

linear_limit_z/enabled

true

float

linear_limit_z/lower_distance

0.0

float

linear_limit_z/restitution

0.5

float

linear_limit_z/softness

0.7

float

linear_limit_z/upper_distance

0.0

bool

linear_motor_x/enabled

false

float

linear_motor_x/force_limit

0.0

float

linear_motor_x/target_velocity

0.0

bool

linear_motor_y/enabled

false

float

linear_motor_y/force_limit

0.0

float

linear_motor_y/target_velocity

0.0

bool

linear_motor_z/enabled

false

float

linear_motor_z/force_limit

0.0

float

linear_motor_z/target_velocity

0.0

float

linear_spring_x/damping

0.01

bool

linear_spring_x/enabled

false

float

linear_spring_x/equilibrium_point

0.0

float

linear_spring_x/stiffness

0.01

float

linear_spring_y/damping

0.01

bool

linear_spring_y/enabled

false

float

linear_spring_y/equilibrium_point

0.0

float

linear_spring_y/stiffness

0.01

float

linear_spring_z/damping

0.01

bool

linear_spring_z/enabled

false

float

linear_spring_z/equilibrium_point

0.0

float

linear_spring_z/stiffness

0.01

方法

void

clear_angular_target_rotation()

Quaternion

get_angular_target_rotation() const

bool

get_flag_x(flag: Flag) const

bool

get_flag_y(flag: Flag) const

bool

get_flag_z(flag: Flag) const

float

get_param_x(param: Param) const

float

get_param_y(param: Param) const

float

get_param_z(param: Param) const

bool

has_target_rotation() const

void

set_angular_target_rotation(target_rotation: Quaternion)

void

set_flag_x(flag: Flag, value: bool)

void

set_flag_y(flag: Flag, value: bool)

void

set_flag_z(flag: Flag, value: bool)

void

set_param_x(param: Param, value: float)

void

set_param_y(param: Param, value: float)

void

set_param_z(param: Param, value: float)


列舉

enum Param: 🔗

Param PARAM_LINEAR_LOWER_LIMIT = 0

軸心點的軸之間的最小差異。

Param PARAM_LINEAR_UPPER_LIMIT = 1

軸心點的軸之間的最大差異。

Param PARAM_LINEAR_LIMIT_SOFTNESS = 2

適用於跨軸移動的一個係數。值越低,移動的就越慢。

Param PARAM_LINEAR_RESTITUTION = 3

軸的運動的恢復量。值越低,動量損失越大。

Param PARAM_LINEAR_DAMPING = 4

發生在跨軸線性運動的阻尼量。

Param PARAM_LINEAR_MOTOR_TARGET_VELOCITY = 5

線性馬達將嘗試達到的速度。

Param PARAM_LINEAR_MOTOR_FORCE_LIMIT = 6

已棄用: Use PARAM_LINEAR_DRIVE_FORCE_LIMIT instead, which applies in both spring and motor modes.

線性馬達在試圖達到速度目標時將施加的最大力。

Param PARAM_LINEAR_SPRING_STIFFNESS = 7

There is currently no description for this enum. Please help us by contributing one!

Param PARAM_LINEAR_SPRING_DAMPING = 8

There is currently no description for this enum. Please help us by contributing one!

Param PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT = 9

There is currently no description for this enum. Please help us by contributing one!

Param PARAM_ANGULAR_LOWER_LIMIT = 10

負方向的最小旋轉,以脫離和繞軸旋轉。

Param PARAM_ANGULAR_UPPER_LIMIT = 11

正方向的最小旋轉,以掙脫和繞軸旋轉。

Param PARAM_ANGULAR_LIMIT_SOFTNESS = 12

所有跨軸旋轉的速度。

Param PARAM_ANGULAR_DAMPING = 13

跨該軸的旋轉阻尼量。值越低,發生的阻尼就越多。

Param PARAM_ANGULAR_RESTITUTION = 14

在各軸上的旋轉恢復量。值越低,發生的恢復量越大。

Param PARAM_ANGULAR_FORCE_LIMIT = 15

圍繞 Z 軸旋轉時,可能發生的最大力。

Param PARAM_ANGULAR_ERP = 16

當跨軸旋轉時,這個誤差容限係數定義了修正的速度被減慢的程度。值越低,旋轉越慢。

Param PARAM_ANGULAR_MOTOR_TARGET_VELOCITY = 17

軸上馬達的目標速度。

Param PARAM_ANGULAR_MOTOR_FORCE_LIMIT = 18

已棄用: Use PARAM_ANGULAR_DRIVE_TORQUE_LIMIT instead, which applies in both spring and motor modes.

馬達在軸上的最大加速度。

Param PARAM_ANGULAR_SPRING_STIFFNESS = 19

There is currently no description for this enum. Please help us by contributing one!

Param PARAM_ANGULAR_SPRING_DAMPING = 20

There is currently no description for this enum. Please help us by contributing one!

Param PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT = 21

There is currently no description for this enum. Please help us by contributing one!

Param PARAM_LINEAR_DRIVE_FORCE_LIMIT = 22

The maximum force the joint can apply along this linear axis.

Used by both the spring drive and the linear motor; supersedes PARAM_LINEAR_MOTOR_FORCE_LIMIT when set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.

Param PARAM_ANGULAR_DRIVE_TORQUE_LIMIT = 23

The maximum torque the joint can apply around this angular axis.

Used by both the spring drive and the angular motor; supersedes PARAM_ANGULAR_MOTOR_FORCE_LIMIT when set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.

Param PARAM_MAX = 24

代表 Param 列舉的大小。


enum Flag: 🔗

Flag FLAG_ENABLE_LINEAR_LIMIT = 0

如果啟用,在給定範圍內可以進行線性運動。

Flag FLAG_ENABLE_ANGULAR_LIMIT = 1

如果啟用,在給定的限度內可以進行旋轉運動。

Flag FLAG_ENABLE_LINEAR_SPRING = 3

There is currently no description for this enum. Please help us by contributing one!

Flag FLAG_ENABLE_ANGULAR_SPRING = 2

There is currently no description for this enum. Please help us by contributing one!

Flag FLAG_ENABLE_ANGULAR_MOTOR = 4

If enabled, there is a rotational or angular motor across these axes.

Flag FLAG_ENABLE_MOTOR = 4

已棄用: Use FLAG_ENABLE_ANGULAR_MOTOR instead.

If enabled, there is a rotational or angular motor across these axes.

Flag FLAG_ENABLE_LINEAR_MOTOR = 5

如果啟用,則存在跨這些軸的線性馬達。

Flag FLAG_MAX = 6

代表 Flag 列舉的大小。


屬性說明

float angular_drive_x/torque_limit = 3.4028235e+38 🔗

The maximum torque the joint can apply around the X angular axis. Used by both the spring drive and the angular motor; supersedes angular_motor_x/force_limit when explicitly set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.


float angular_drive_y/torque_limit = 3.4028235e+38 🔗

The maximum torque the joint can apply around the Y angular axis. Used by both the spring drive and the angular motor; supersedes angular_motor_y/force_limit when explicitly set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.


float angular_drive_z/torque_limit = 3.4028235e+38 🔗

The maximum torque the joint can apply around the Z angular axis. Used by both the spring drive and the angular motor; supersedes angular_motor_z/force_limit when explicitly set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.


float angular_limit_x/damping = 1.0 🔗

跨 X 軸的旋轉阻尼量。

越低,來自一側的脈衝到達另一側的時間越長。


bool angular_limit_x/enabled = true 🔗

如果為 true,則跨越 X 軸的旋轉將受到限制。


float angular_limit_x/erp = 0.5 🔗

當在X軸上旋轉時,這個誤差容限係數定義了修正的速度被減慢的程度。值越低,旋轉越慢。


float angular_limit_x/force_limit = 0.0 🔗

繞 X 軸旋轉時所能產生的最大力。


float angular_limit_x/lower_angle = 0.0 🔗

負方向的最小旋轉,以掙脫並圍繞 X 軸旋轉。


float angular_limit_x/restitution = 0.0 🔗

X 軸上的旋轉恢復量。值越小,產生的恢復量越大。


float angular_limit_x/softness = 0.5 🔗

跨越 X 軸的所有旋轉的速度。


float angular_limit_x/upper_angle = 0.0 🔗

正方向的最小旋轉,以掙脫並繞 X 軸旋轉。


float angular_limit_y/damping = 1.0 🔗

Y軸上的旋轉阻尼量。值越小,產生的阻尼就越大。


bool angular_limit_y/enabled = true 🔗

如果為 true,則跨越 Y 軸的旋轉將受到限制。


float angular_limit_y/erp = 0.5 🔗

當在 Y 軸上旋轉時,這個誤差容限係數定義了修正的速度被減慢的程度。值越低,旋轉越慢。


float angular_limit_y/force_limit = 0.0 🔗

圍繞 Y 軸旋轉時,可能發生的最大力。


float angular_limit_y/lower_angle = 0.0 🔗

負方向的最小旋轉,以掙脫並圍繞 Y 軸旋轉。


float angular_limit_y/restitution = 0.0 🔗

跨越 Y 軸的旋轉恢復量。越低,發生的恢復量越大。


float angular_limit_y/softness = 0.5 🔗

跨越 Y 軸的所有旋轉的速度。


float angular_limit_y/upper_angle = 0.0 🔗

正方向的最小旋轉,以掙脫並繞 Y 軸旋轉。


float angular_limit_z/damping = 1.0 🔗

跨越 Z 軸的旋轉阻尼量。值越小,產生的阻尼就越大。


bool angular_limit_z/enabled = true 🔗

如果為 true,則跨越 Z 軸的旋轉將受到限制。


float angular_limit_z/erp = 0.5 🔗

當在 Z 軸上旋轉時,這個誤差容限係數定義了修正的速度被減慢的程度。值越低,旋轉越慢。


float angular_limit_z/force_limit = 0.0 🔗

圍繞 Z 軸旋轉時,可能發生的最角度。


float angular_limit_z/lower_angle = 0.0 🔗

負方向的最小旋轉,以掙脫並圍繞 Z 軸旋轉。


float angular_limit_z/restitution = 0.0 🔗

跨越 Z 軸的旋轉恢復量。越低,發生的恢復量越大。


float angular_limit_z/softness = 0.5 🔗

跨越 Z 軸的所有旋轉的速度。


float angular_limit_z/upper_angle = 0.0 🔗

正方向的最小旋轉,並繞 Z 軸旋轉。


bool angular_motor_x/enabled = false 🔗

如果為 true,則啟用 X 軸的旋轉馬達。


float angular_motor_x/force_limit = 300.0 🔗

已棄用: Use angular_drive_x/torque_limit instead, which applies in both spring and motor modes.

在 X 軸旋轉的最大加速度。


float angular_motor_x/target_velocity = 0.0 🔗

X 軸上馬達的目標速度。


bool angular_motor_y/enabled = false 🔗

如果為 true,則啟用 Y 軸的旋轉馬達。


float angular_motor_y/force_limit = 300.0 🔗

已棄用: Use angular_drive_y/torque_limit instead, which applies in both spring and motor modes.

馬達在 X 軸的最大加速度。


float angular_motor_y/target_velocity = 0.0 🔗

馬達在 Y 軸的目標速度。


bool angular_motor_z/enabled = false 🔗

如果為 true,則啟用 Z 軸的旋轉馬達。


float angular_motor_z/force_limit = 300.0 🔗

已棄用: Use angular_drive_z/torque_limit instead, which applies in both spring and motor modes.

馬達在 Z 軸的最大加速度。


float angular_motor_z/target_velocity = 0.0 🔗

Z 軸上馬達的目標速度。


float angular_spring_x/damping = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


bool angular_spring_x/enabled = false 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_x/equilibrium_point = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_x/stiffness = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_y/damping = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


bool angular_spring_y/enabled = false 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_y/equilibrium_point = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_y/stiffness = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_z/damping = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


bool angular_spring_z/enabled = false 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_z/equilibrium_point = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float angular_spring_z/stiffness = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_drive_x/force_limit = 3.4028235e+38 🔗

The maximum force the joint can apply along the X linear axis. Used by both the spring drive and the linear motor; supersedes linear_motor_x/force_limit when explicitly set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.


float linear_drive_y/force_limit = 3.4028235e+38 🔗

The maximum force the joint can apply along the Y linear axis. Used by both the spring drive and the linear motor; supersedes linear_motor_y/force_limit when explicitly set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.


float linear_drive_z/force_limit = 3.4028235e+38 🔗

The maximum force the joint can apply along the Z linear axis. Used by both the spring drive and the linear motor; supersedes linear_motor_z/force_limit when explicitly set.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.


float linear_limit_x/damping = 1.0 🔗

發生在 X 運動的阻尼量。


bool linear_limit_x/enabled = true 🔗

如果為 true,則跨越 X 軸的線性運動將受到限制。


float linear_limit_x/lower_distance = 0.0 🔗

軸心點的 X 軸之間的最小差異。


float linear_limit_x/restitution = 0.5 🔗

X 軸運動的恢復量。越低,動量損失越大。


float linear_limit_x/softness = 0.7 🔗

套用於 X 軸上移動的一個係數。值越低,移動的就越慢。


float linear_limit_x/upper_distance = 0.0 🔗

軸心點的 X 軸之間的最大差異。


float linear_limit_y/damping = 1.0 🔗

發生在 Y 運動的阻尼量。


bool linear_limit_y/enabled = true 🔗

如果為 true,則跨越 Y 軸的線性運動將受到限制。


float linear_limit_y/lower_distance = 0.0 🔗

軸心點的 Y 軸之間的最小差異。


float linear_limit_y/restitution = 0.5 🔗

Y 軸運動的恢復量。值越低,動量損失越大。


float linear_limit_y/softness = 0.7 🔗

套用於 Y 軸上移動的一個係數。值越低,移動的就越慢。


float linear_limit_y/upper_distance = 0.0 🔗

軸心點的 Y 軸之間的最大差異。


float linear_limit_z/damping = 1.0 🔗

發生在 Z 運動的阻尼量。


bool linear_limit_z/enabled = true 🔗

如果為 true,則跨越 Z 軸的線性運動將受到限制。


float linear_limit_z/lower_distance = 0.0 🔗

軸心點的 Z 軸之間的最小差異。


float linear_limit_z/restitution = 0.5 🔗

Y 軸運動的恢復量。越低,動量損失越大。


float linear_limit_z/softness = 0.7 🔗

適用於跨 Z 軸移動的一個係數。值越低,移動的就越慢。


float linear_limit_z/upper_distance = 0.0 🔗

軸心點的 Z 軸之間的最大差異。


bool linear_motor_x/enabled = false 🔗

如果為 true,則 X 軸上存線上性馬達。它將試圖達到目標速度,同時保持在力的限度內。


float linear_motor_x/force_limit = 0.0 🔗

已棄用: Use linear_drive_x/force_limit instead, which applies in both spring and motor modes.

當嘗試達到目標速度時,線性馬達可以在 X 軸上套用的最大力。


float linear_motor_x/target_velocity = 0.0 🔗

線性馬達在 X 軸上嘗試達到的速度。


bool linear_motor_y/enabled = false 🔗

如果為 true,則 Y 軸上存線上性馬達。它將試圖達到目標速度,同時保持在力的限度內。


float linear_motor_y/force_limit = 0.0 🔗

已棄用: Use linear_drive_y/force_limit instead, which applies in both spring and motor modes.

直線馬達在試圖達到目標速度時可施加在 Y 軸上的最大力。


float linear_motor_y/target_velocity = 0.0 🔗

線性馬達在 Y 軸上將會達到的速度。


bool linear_motor_z/enabled = false 🔗

如果為 true,則 Z 軸上存線上性馬達。它將試圖達到目標速度,同時保持在力的限度內。


float linear_motor_z/force_limit = 0.0 🔗

已棄用: Use linear_drive_z/force_limit instead, which applies in both spring and motor modes.

當試圖達到目標速度時,線性馬達可以在 X 軸上套用的最大力。


float linear_motor_z/target_velocity = 0.0 🔗

線性馬達在 Z 軸上試圖達到的速度。


float linear_spring_x/damping = 0.01 🔗

There is currently no description for this property. Please help us by contributing one!


bool linear_spring_x/enabled = false 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_x/equilibrium_point = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_x/stiffness = 0.01 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_y/damping = 0.01 🔗

There is currently no description for this property. Please help us by contributing one!


bool linear_spring_y/enabled = false 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_y/equilibrium_point = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_y/stiffness = 0.01 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_z/damping = 0.01 🔗

There is currently no description for this property. Please help us by contributing one!


bool linear_spring_z/enabled = false 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_z/equilibrium_point = 0.0 🔗

There is currently no description for this property. Please help us by contributing one!


float linear_spring_z/stiffness = 0.01 🔗

There is currently no description for this property. Please help us by contributing one!


方法說明

void clear_angular_target_rotation() 🔗

Clears the quaternion angular target. After clearing, the joint is driven by PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT on each axis as configured.


Quaternion get_angular_target_rotation() const 🔗

Returns the joint's current angular target as a body-space quaternion. If no explicit target was set via set_angular_target_rotation(), the value is derived from PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT on backends that support it; other backends return the identity quaternion.


bool get_flag_x(flag: Flag) const 🔗

There is currently no description for this method. Please help us by contributing one!


bool get_flag_y(flag: Flag) const 🔗

There is currently no description for this method. Please help us by contributing one!


bool get_flag_z(flag: Flag) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_param_x(param: Param) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_param_y(param: Param) const 🔗

There is currently no description for this method. Please help us by contributing one!


float get_param_z(param: Param) const 🔗

There is currently no description for this method. Please help us by contributing one!


bool has_target_rotation() const 🔗

Returns true if a quaternion angular target was explicitly set via set_angular_target_rotation() and has not been cleared. Returns false when the joint is driven by PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT only.


void set_angular_target_rotation(target_rotation: Quaternion) 🔗

Sets the target angular orientation as a body-space quaternion describing the desired orientation of body B relative to body A. Replaces any previously set target and supersedes PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT until clear_angular_target_rotation() is called.

Note: Only for Jolt backend. Other 3D physics backends may ignore this value.


void set_flag_x(flag: Flag, value: bool) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_flag_y(flag: Flag, value: bool) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_flag_z(flag: Flag, value: bool) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_param_x(param: Param, value: float) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_param_y(param: Param, value: float) 🔗

There is currently no description for this method. Please help us by contributing one!


void set_param_z(param: Param, value: float) 🔗

There is currently no description for this method. Please help us by contributing one!