Skip to content

Commit c0949e6

Browse files
ttencateAThousandShipsMickeon
authored
Apply suggestions from code review
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Co-authored-by: Micky <66727710+Mickeon@users.noreply.github.com>
1 parent 3552c30 commit c0949e6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/classes/HeightMapShape3D.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
A 3D heightmap shape used for physics collision.
55
</brief_description>
66
<description>
7-
A 3D heightmap shape, intended for use in physics to provide a shape for a [CollisionShape3D]. This type is most commonly used for terrain with vertices placed in a fixed width grid.
8-
The heightmap is represented as a 2D grid of height values, which represent the position of grid points on the Y axis. Grid points are spaced 1 unit apart on the X and Z axes, and the grid is centered on the origin of the [HeightMapShape3D] node. Internally, each grid square is divided into two triangles.
7+
A 3D heightmap shape, intended for use in physics to provide a shape for a [CollisionShape3D]. This type is most commonly used for terrain with vertices placed in a fixed-width grid.
8+
The heightmap is represented as a 2D grid of height values, which represent the position of grid points on the Y axis. Grid points are spaced 1 unit apart on the X and Z axes, and the grid is centered on the origin of the [CollisionShape3D] node. Internally, each grid square is divided into two triangles.
99
Due to the nature of the heightmap, it cannot be used to model overhangs or caves, which would require multiple vertices at the same vertical location. Holes can be punched through the collision by assigning [constant @GDScript.NAN] to the height of the desired vertices (this is supported in both GodotPhysics3D and Jolt Physics). You could then insert meshes with their own separate collision to provide overhangs, caves, and so on.
1010
[b]Performance:[/b] [HeightMapShape3D] is faster to check collisions against than [ConcavePolygonShape3D], but it is significantly slower than primitive shapes like [BoxShape3D].
1111
A heightmap collision shape can also be built by using an [Image] reference:
@@ -21,7 +21,7 @@
2121
update_map_data_from_image(heightmap_image, height_min, height_max)
2222
[/gdscript]
2323
[/codeblocks]
24-
[b]Note:[/b] If you need to use a spacing different than 1 unit, you can adjust the [member Node3D.scale] of the shape. However, keep in mind that GodotPhysics3D does not support non-uniform scaling: you'll need to scale the Y axis by the same amount as the X and Z axes, which means the values in [member map_data] will need to be pre-scaled by the inverse of that scale. Also note that GodotPhysics3D does not support scaling at all for dynamic bodies (that is, non-frozen [RigidBody3D]); to use a scaled [HeightMapShape3D] with those, you will need to use Jolt Physics.
24+
[b]Note:[/b] If you need to use a spacing different than 1 unit, you can adjust the [member Node3D.scale] of the shape. However, keep in mind that GodotPhysics3D does not support non-uniform scaling: you'll need to scale the Y axis by the same amount as the X and Z axes, which means the values in [member map_data] will need to be pre-scaled by the inverse of that scale. Also note that GodotPhysics3D does not support scaling at all for dynamic bodies (that is, non-frozen [RigidBody3D] nodes); to use a scaled [HeightMapShape3D] with those, you will need to use Jolt Physics.
2525
</description>
2626
<tutorials>
2727
</tutorials>

0 commit comments

Comments
 (0)