Inheritance #

HeightMapShape3D #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A 3D height map shape used for physics collision.

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.

Performance: 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:

var heightmap_texture = ResourceLoader.load("res://heightmap_image.exr")
var heightmap_image = heightmap_texture.get_image()
heightmap_image.convert(Image.FORMAT_RF)

var height_min = 0.0
var height_max = 10.0

update_map_data_from_image(heightmap_image, height_min, height_max)

Members #

var map_data: PackedFloat32Array = PackedFloat32Array(0, 0, 0, 0)#

Height map data. The array's size must be equal to map_width multiplied by map_depth.

var map_depth: int = 2#

Number of vertices in the depth of the height map. Changing this will resize the map_data.

var map_width: int = 2#

Number of vertices in the width of the height map. Changing this will resize the map_data.

Methods #

Annotations #

Constants #

Constructors #

Enums #

Operators #

Signals #

Theme Items #

Tutorials #