From 924a5c6573b06497a4438fcbedd4f505be1cf90b Mon Sep 17 00:00:00 2001
From: smix8 <52464204+smix8@users.noreply.github.com>
Date: Sat, 3 Feb 2024 00:33:11 +0100
Subject: [PATCH] Add HeightMapShape3D update with Image data
Adds HeightMapShape3D update with Image data.
---
doc/classes/HeightMapShape3D.xml | 24 +++++
scene/resources/3d/height_map_shape_3d.cpp | 101 +++++++++++++++++++++
scene/resources/3d/height_map_shape_3d.h | 4 +
3 files changed, 129 insertions(+)
diff --git a/doc/classes/HeightMapShape3D.xml b/doc/classes/HeightMapShape3D.xml
index ba79cbc89a58..7e3055b34e5e 100644
--- a/doc/classes/HeightMapShape3D.xml
+++ b/doc/classes/HeightMapShape3D.xml
@@ -6,6 +6,19 @@
A 3D heightmap shape, intended for use in physics. Usually used to provide a shape for a [CollisionShape3D]. This is useful for terrain, but it is limited as overhangs (such as caves) cannot be stored. Holes in a [HeightMapShape3D] are created by assigning very low values to points in the desired area.
[b]Performance:[/b] [HeightMapShape3D] is faster to check collisions against than [ConcavePolygonShape3D], but it is significantly slower than primitive shapes like [BoxShape3D].
+ A heightmap collision shape can also be build by using an [Image] reference:
+ [codeblocks]
+ [gdscript]
+ var heightmap_texture: Texture = ResourceLoader.load("res://heightmap_image.exr")
+ var heightmap_image: Image = heightmap_texture.get_image()
+ heightmap_image.convert(Image.FORMAT_RF)
+
+ var height_min: float = 0.0
+ var height_max: float = 10.0
+
+ update_map_data_from_image(heightmap_image, height_min, height_max)
+ [/gdscript]
+ [/codeblocks]
@@ -22,6 +35,17 @@
Returns the smallest height value found in [member map_data]. Recalculates only when [member map_data] changes.
+
+
+
+
+
+
+ Updates [member map_data] with data read from an [Image] reference. Automatically resizes heightmap [member map_width] and [member map_depth] to fit the full image width and height.
+ The image needs to be in either [constant Image.FORMAT_RF] (32 bit), [constant Image.FORMAT_RH] (16 bit), or [constant Image.FORMAT_R8] (8 bit).
+ Each image pixel is read in as a float on the range from [code]0.0[/code] (black pixel) to [code]1.0[/code] (white pixel). This range value gets remapped to [param height_min] and [param height_max] to form the final height value.
+
+
diff --git a/scene/resources/3d/height_map_shape_3d.cpp b/scene/resources/3d/height_map_shape_3d.cpp
index 35c905bd432d..5b55b6615258 100644
--- a/scene/resources/3d/height_map_shape_3d.cpp
+++ b/scene/resources/3d/height_map_shape_3d.cpp
@@ -30,6 +30,7 @@
#include "height_map_shape_3d.h"
+#include "core/io/image.h"
#include "servers/physics_server_3d.h"
Vector HeightMapShape3D::get_debug_mesh_lines() const {
@@ -187,6 +188,104 @@ real_t HeightMapShape3D::get_max_height() const {
return max_height;
}
+void HeightMapShape3D::update_map_data_from_image(const Ref &p_image, real_t p_height_min, real_t p_height_max) {
+ ERR_FAIL_COND_MSG(p_image.is_null(), "Heightmap update image requires a valid Image reference.");
+ ERR_FAIL_COND_MSG(p_image->get_format() != Image::FORMAT_RF && p_image->get_format() != Image::FORMAT_RH && p_image->get_format() != Image::FORMAT_R8, "Heightmap update image requires Image in format FORMAT_RF (32 bit), FORMAT_RH (16 bit), or FORMAT_R8 (8 bit).");
+ ERR_FAIL_COND_MSG(p_image->get_width() < 2, "Heightmap update image requires a minimum Image width of 2.");
+ ERR_FAIL_COND_MSG(p_image->get_height() < 2, "Heightmap update image requires a minimum Image height of 2.");
+ ERR_FAIL_COND_MSG(p_height_min > p_height_max, "Heightmap update image requires height_max to be greater than height_min.");
+
+ map_width = p_image->get_width();
+ map_depth = p_image->get_height();
+ map_data.resize(map_width * map_depth);
+
+ real_t new_min_height = FLT_MAX;
+ real_t new_max_height = -FLT_MAX;
+
+ float remap_height_min = float(p_height_min);
+ float remap_height_max = float(p_height_max);
+
+ real_t *map_data_ptrw = map_data.ptrw();
+
+ switch (p_image->get_format()) {
+ case Image::FORMAT_RF: {
+ const float *image_data_ptr = (float *)p_image->get_data().ptr();
+
+ for (int i = 0; i < map_data.size(); i++) {
+ float pixel_value = image_data_ptr[i];
+
+ DEV_ASSERT(pixel_value >= 0.0 && pixel_value <= 1.0);
+
+ real_t height_value = Math::remap(pixel_value, 0.0f, 1.0f, remap_height_min, remap_height_max);
+
+ if (height_value < new_min_height) {
+ new_min_height = height_value;
+ }
+ if (height_value > new_max_height) {
+ new_max_height = height_value;
+ }
+
+ map_data_ptrw[i] = height_value;
+ }
+
+ } break;
+
+ case Image::FORMAT_RH: {
+ const uint16_t *image_data_ptr = (uint16_t *)p_image->get_data().ptr();
+
+ for (int i = 0; i < map_data.size(); i++) {
+ float pixel_value = Math::half_to_float(image_data_ptr[i]);
+
+ DEV_ASSERT(pixel_value >= 0.0 && pixel_value <= 1.0);
+
+ real_t height_value = Math::remap(pixel_value, 0.0f, 1.0f, remap_height_min, remap_height_max);
+
+ if (height_value < new_min_height) {
+ new_min_height = height_value;
+ }
+ if (height_value > new_max_height) {
+ new_max_height = height_value;
+ }
+
+ map_data_ptrw[i] = height_value;
+ }
+
+ } break;
+
+ case Image::FORMAT_R8: {
+ const uint8_t *image_data_ptr = (uint8_t *)p_image->get_data().ptr();
+
+ for (int i = 0; i < map_data.size(); i++) {
+ float pixel_value = float(image_data_ptr[i] / 255.0);
+
+ DEV_ASSERT(pixel_value >= 0.0 && pixel_value <= 1.0);
+
+ real_t height_value = Math::remap(pixel_value, 0.0f, 1.0f, remap_height_min, remap_height_max);
+
+ if (height_value < new_min_height) {
+ new_min_height = height_value;
+ }
+ if (height_value > new_max_height) {
+ new_max_height = height_value;
+ }
+
+ map_data_ptrw[i] = height_value;
+ }
+
+ } break;
+
+ default: {
+ return;
+ }
+ }
+
+ min_height = new_min_height;
+ max_height = new_max_height;
+
+ _update_shape();
+ emit_changed();
+}
+
void HeightMapShape3D::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_map_width", "width"), &HeightMapShape3D::set_map_width);
ClassDB::bind_method(D_METHOD("get_map_width"), &HeightMapShape3D::get_map_width);
@@ -197,6 +296,8 @@ void HeightMapShape3D::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_min_height"), &HeightMapShape3D::get_min_height);
ClassDB::bind_method(D_METHOD("get_max_height"), &HeightMapShape3D::get_max_height);
+ ClassDB::bind_method(D_METHOD("update_map_data_from_image", "image", "height_min", "height_max"), &HeightMapShape3D::update_map_data_from_image);
+
ADD_PROPERTY(PropertyInfo(Variant::INT, "map_width", PROPERTY_HINT_RANGE, "0.001,100,0.001,or_greater"), "set_map_width", "get_map_width");
ADD_PROPERTY(PropertyInfo(Variant::INT, "map_depth", PROPERTY_HINT_RANGE, "0.001,100,0.001,or_greater"), "set_map_depth", "get_map_depth");
ADD_PROPERTY(PropertyInfo(Variant::PACKED_FLOAT32_ARRAY, "map_data"), "set_map_data", "get_map_data");
diff --git a/scene/resources/3d/height_map_shape_3d.h b/scene/resources/3d/height_map_shape_3d.h
index 363d9ec0e92c..33ba9c447293 100644
--- a/scene/resources/3d/height_map_shape_3d.h
+++ b/scene/resources/3d/height_map_shape_3d.h
@@ -33,6 +33,8 @@
#include "scene/resources/3d/shape_3d.h"
+class Image;
+
class HeightMapShape3D : public Shape3D {
GDCLASS(HeightMapShape3D, Shape3D);
@@ -57,6 +59,8 @@ class HeightMapShape3D : public Shape3D {
real_t get_min_height() const;
real_t get_max_height() const;
+ void update_map_data_from_image(const Ref &p_image, real_t p_height_min, real_t p_height_max);
+
virtual Vector get_debug_mesh_lines() const override;
virtual real_t get_enclosing_radius() const override;