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.
Checking the stable version of the documentation...
Curve
繼承: Resource < RefCounted < Object
數學曲線。
說明
該資源通過定義一組點和每個點的切線來描述數學曲線。預設情況下,X 軸和 Y 軸的範圍都在 0 到 1 之間,但是範圍可以調整。
請注意,許多資源和節點會假設使用者設定的是單位曲線。單位曲線即域(X 軸)在 0 到 1 之間的曲線。例如 CPUParticles2D.angle_curve 和 Line2D.width_curve 用的就是單位曲線。
屬性
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
方法
add_point(position: Vector2, left_tangent: float = 0, right_tangent: float = 0, left_mode: TangentMode = 0, right_mode: TangentMode = 0) |
|
void |
bake() |
void |
|
void |
|
get_domain_range() const |
|
get_point_left_mode(index: int) const |
|
get_point_left_tangent(index: int) const |
|
get_point_position(index: int) const |
|
get_point_right_mode(index: int) const |
|
get_point_right_tangent(index: int) const |
|
get_value_range() const |
|
void |
remove_point(index: int) |
sample_baked(offset: float) const |
|
void |
set_point_left_mode(index: int, mode: TangentMode) |
void |
set_point_left_tangent(index: int, tangent: float) |
set_point_offset(index: int, offset: float) |
|
void |
set_point_right_mode(index: int, mode: TangentMode) |
void |
set_point_right_tangent(index: int, tangent: float) |
void |
set_point_value(index: int, y: float) |
訊號
domain_changed() 🔗
更改 max_domain 或 min_domain 時發出。
range_changed() 🔗
列舉
enum TangentMode: 🔗
TangentMode TANGENT_FREE = 0
點這邊的切線是使用者自訂的。
TangentMode TANGENT_LINEAR = 1
曲線計算點的這一側的切線,作為向相鄰點的一半的斜率。
TangentMode TANGENT_MODE_COUNT = 2
可用切線模式的總數。
屬性說明
烘焙(即快取)曲線資料中包含的點的數量。
點能夠達到的最大域(X 座標)。
點能夠達到的最大值(Y 座標)。切線可能導致兩點之間存在更大的值。
點能夠達到的最小域(X 座標)。
點能夠達到的最小值(Y 座標)。切線可能導致兩點之間存在更小的值。
描述該曲線的點的數量。
int point_{index}/left_mode = 0 🔗
位於 index 處那個點的左側 TangentMode(切線模式)。
注意: index 的取值範圍是 0 到 point_count - 1。
float point_{index}/left_tangent = 0.0 🔗
位於 index 處那個點的左側切線角度(以度為單位)。
注意: index 的取值範圍是 0 到 point_count - 1。
Vector2 point_{index}/position = Vector2(0, 0) 🔗
位於 index 處那個點的位置。
注意: index 的取值範圍是 0 到 point_count - 1。
int point_{index}/right_mode = 0 🔗
“位於 index 處那個點的右側 TangentMode(切線模式)。
注意: index 的取值範圍是 0 到 point_count - 1。
float point_{index}/right_tangent = 0.0 🔗
位於 index 處那個點的右側切線角度(以度為單位)。
注意: index 的取值範圍是 0 到 point_count - 1。
方法說明
int add_point(position: Vector2, left_tangent: float = 0, right_tangent: float = 0, left_mode: TangentMode = 0, right_mode: TangentMode = 0) 🔗
在曲線上新增一個點。對於每一側,如果 *_mode 為 TANGENT_LINEAR,則 *_tangent 角度(以度為單位)將使用曲線到鄰近點的一半的斜率。如果 *_mode 設定為 TANGENT_FREE,則允許自訂分配給 *_tangent 的角度。
void bake() 🔗
重新計算曲線的烘焙點快取。
void clean_dupes() 🔗
移除重複點,即與曲線上相鄰點的距離小於 0.00001 個單位(引擎中的 epsilon 值)的點。
void clear_points() 🔗
從曲線中移除所有點。
float get_domain_range() const 🔗
回傳 min_domain 和 max_domain 的差。
TangentMode get_point_left_mode(index: int) const 🔗
返回索引為 index 的點的左側切線模式 TangentMode。
float get_point_left_tangent(index: int) const 🔗
返回索引為 index 的點的左側切線夾角(單位為度)。
Vector2 get_point_position(index: int) const 🔗
返回索引為 index 的點的曲線座標。
TangentMode get_point_right_mode(index: int) const 🔗
返回索引為 index 的點的右側切線模式 TangentMode。
float get_point_right_tangent(index: int) const 🔗
返回索引為 index 的點的右側切線夾角(單位為度)。
float get_value_range() const 🔗
void remove_point(index: int) 🔗
移除曲線中索引為 index 的點。
float sample(offset: float) const 🔗
返回沿曲線的 X 位置 offset 處將存在的點的 Y 值。
float sample_baked(offset: float) const 🔗
使用烘焙的快取返回沿曲線的 X 位置 offset 處將存在的點的 Y 值。烘焙尚未烘焙的曲線的點。
void set_point_left_mode(index: int, mode: TangentMode) 🔗
將索引為 index 的點的左側 TangentMode 設定為 mode。
void set_point_left_tangent(index: int, tangent: float) 🔗
將索引為 index 的點的左側切線角度設定為 tangent。
int set_point_offset(index: int, offset: float) 🔗
將水平位置 offset 分配給 index 處的點。
void set_point_right_mode(index: int, mode: TangentMode) 🔗
將索引為 index 的點的右側 TangentMode 設定為 mode。
void set_point_right_tangent(index: int, tangent: float) 🔗
將索引為 index 的點的右側切線角度設定為 tangent。
void set_point_value(index: int, y: float) 🔗
將索引為 index 的點的垂直位置設定為 y。