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.

GPUParticlesCollisionHeightField3D

繼承: GPUParticlesCollision3D < VisualInstance3D < Node3D < Node < Object

球狀的 3D 粒子碰撞形狀,影響 GPUParticles3D 節點。

說明

即時高度圖形狀的 3D 粒子吸引器會影響 GPUParticles3D 節點。

高度圖形狀允許有效地表示凸面和凹面物件與單個“地板”(例如地形)的碰撞。它不如 GPUParticlesCollisionSDF3D 靈活,但不需要烘焙步驟。

也可以在移動時、相機移動時、甚至連續時,即時重新生成 GPUParticlesCollisionHeightField3D。這對雨雪等天氣效果、以及具有高度動態幾何體的遊戲來說,GPUParticlesCollisionHeightField3D 是一個不錯的選擇。但是,由於高度圖不能表示懸垂,因此 GPUParticlesCollisionHeightField3D 不適用於室內粒子碰撞。

注意:在 GPUParticles3D 的處理材質上,ParticleProcessMaterial.collision_mode 必須為 true,才能使碰撞生效。

注意:粒子碰撞只影響 GPUParticles3D,不影響 CPUParticles3D。

屬性

bool

follow_camera_enabled

false

int

heightfield_mask

1048575

Resolution

resolution

2

Vector3

size

Vector3(2, 2, 2)

UpdateMode

update_mode

0

方法

bool

get_heightfield_mask_value(layer_number: int) const

void

set_heightfield_mask_value(layer_number: int, value: bool)


列舉

enum Resolution: 🔗

Resolution RESOLUTION_256 = 0

生成 256×256 的高度圖。適用於小規模場景,或沒有遠景粒子的較大場景。

Resolution RESOLUTION_512 = 1

生成 512×512 的高度圖。適用於中等規模的場景,或沒有遠景粒子的較大場景。

Resolution RESOLUTION_1024 = 2

生成 1024×1024 的高度圖。適用於具有遠景粒子的大型場景。

Resolution RESOLUTION_2048 = 3

生成 2048×2048 的高度圖。適用於具有遠景粒子的非常大的場景。

Resolution RESOLUTION_4096 = 4

生成 4096×4096 的高度圖。適用於具有遠景粒子的巨大場景。

Resolution RESOLUTION_8192 = 5

生成 8192×8192 的高度圖。適用於具有遠景粒子的巨大場景。

Resolution RESOLUTION_MAX = 6

代表 Resolution 列舉的大小。


enum UpdateMode: 🔗

UpdateMode UPDATE_MODE_WHEN_MOVED = 0

僅在 GPUParticlesCollisionHeightField3D 節點移動時,或者當 follow_camera_enabled 為 true 且相機移動時,更新高度圖。可以通過向任意方向稍微移動 GPUParticlesCollisionHeightField3D 或者呼叫 RenderingServer.particles_collision_height_field_update() 來強制更新。

UpdateMode UPDATE_MODE_ALWAYS = 1

每影格更新高度圖。這具有顯著的效能成本。只有當粒子可以碰撞的幾何體在遊戲過程中發生顯著變化時,才應使用該更新選項。


屬性說明

bool follow_camera_enabled = false 🔗

  • void set_follow_camera_enabled(value: bool)

  • bool is_follow_camera_enabled()

如果為 true,則 GPUParticlesCollisionHeightField3D 將在全域空間中跟隨目前相機。GPUParticlesCollisionHeightField3D 不需要是該 Camera3D 節點的子節點也能工作。

跟隨相機會有效能成本,因為它會在相機移動時強制更新高度圖。如果 follow_camera_enabled 為 true,請考慮降低 resolution 以提高效能。


int heightfield_mask = 1048575 🔗

  • void set_heightfield_mask(value: int)

  • int get_heightfield_mask()

更新高度圖時要考慮的可視層。高度圖碰撞更新中只會包含 VisualInstance3D.layers 與 heightfield_mask 匹配的 MeshInstance3D。預設情況下,更新高度圖碰撞時會考慮全部 20 個使用者可見層。

注意:由於 heightfield_mask 總共能夠儲存 32 個層,還有 12 個層是僅限引擎內部使用的,未在編輯器中暴露。通過腳本設定 heightfield_mask 就可以開關這些保留的層,適用於編輯器外掛。

腳本中可以使用 get_heightfield_mask_value() 和 set_heightfield_mask_value() 更方便地調整 heightfield_mask。


Resolution resolution = 2 🔗

更高的解析度可以更準確地表示大場景中的小細節,但會降低效能。如果 update_mode 為 UPDATE_MODE_ALWAYS,請考慮使用可能的最低解析度。


Vector3 size = Vector3(2, 2, 2) 🔗

碰撞高度圖的 3D 單位大小。為了提高高度圖品質,size 應被設定得盡可能小,同時覆蓋需要的場景部分。


UpdateMode update_mode = 0 🔗

生成的高度圖的更新策略。


方法說明

bool get_heightfield_mask_value(layer_number: int) const 🔗

如果啟用了 heightfield_mask 中的指定層,則回傳 true,給定的 layer_number 在 1 到 20 之間,包括端點。


void set_heightfield_mask_value(layer_number: int, value: bool) 🔗

根據 value 啟用或停用 heightfield_mask 中的指定層,給定的 layer_number 在 1 到 20 之間,包括端點。