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.

Curve

繼承: Resource < RefCounted < Object

數學曲線。

說明

該資源通過定義一組點和每個點的切線來描述數學曲線。預設情況下,X 軸和 Y 軸的範圍都在 0 到 1 之間,但是範圍可以調整。

請注意,許多資源和節點會假設使用者設定的是單位曲線。單位曲線即域(X 軸)在 0 到 1 之間的曲線。例如 CPUParticles2D.angle_curve 和 Line2D.width_curve 用的就是單位曲線。

屬性

int

bake_resolution

100

float

max_domain

1.0

float

max_value

1.0

float

min_domain

0.0

float

min_value

0.0

int

point_count

0

int

point_{index}/left_mode

0

float

point_{index}/left_tangent

0.0

Vector2

point_{index}/position

Vector2(0, 0)

int

point_{index}/right_mode

0

float

point_{index}/right_tangent

0.0

方法

int

add_point(position: Vector2, left_tangent: float = 0, right_tangent: float = 0, left_mode: TangentMode = 0, right_mode: TangentMode = 0)

void

bake()

void

clean_dupes()

void

clear_points()

float

get_domain_range() const

TangentMode

get_point_left_mode(index: int) const

float

get_point_left_tangent(index: int) const

Vector2

get_point_position(index: int) const

TangentMode

get_point_right_mode(index: int) const

float

get_point_right_tangent(index: int) const

float

get_value_range() const

void

remove_point(index: int)

float

sample(offset: float) const

float

sample_baked(offset: float) const

void

set_point_left_mode(index: int, mode: TangentMode)

void

set_point_left_tangent(index: int, tangent: float)

int

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() 🔗

更改 max_value 或 min_value 時發出。


列舉

enum TangentMode: 🔗

TangentMode TANGENT_FREE = 0

點這邊的切線是使用者自訂的。

TangentMode TANGENT_LINEAR = 1

曲線計算點的這一側的切線,作為向相鄰點的一半的斜率。

TangentMode TANGENT_MODE_COUNT = 2

可用切線模式的總數。


屬性說明

int bake_resolution = 100 🔗

  • void set_bake_resolution(value: int)

  • int get_bake_resolution()

烘焙(即快取)曲線資料中包含的點的數量。


float max_domain = 1.0 🔗

  • void set_max_domain(value: float)

  • float get_max_domain()

點能夠達到的最大域(X 座標)。


float max_value = 1.0 🔗

  • void set_max_value(value: float)

  • float get_max_value()

點能夠達到的最大值(Y 座標)。切線可能導致兩點之間存在更大的值。


float min_domain = 0.0 🔗

  • void set_min_domain(value: float)

  • float get_min_domain()

點能夠達到的最小域(X 座標)。


float min_value = 0.0 🔗

  • void set_min_value(value: float)

  • float get_min_value()

點能夠達到的最小值(Y 座標)。切線可能導致兩點之間存在更小的值。


int point_count = 0 🔗

  • void set_point_count(value: int)

  • int get_point_count()

描述該曲線的點的數量。


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 🔗

回傳 min_value 和 max_value 的差。


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。