Browse Source

Document MeshLibrary navmesh export (#5863)

Co-authored-by: Rémi Verschelde <[email protected]>
(cherry picked from commit 869830c6ba62a1f3d5e1f10a55847c000750ca86)
smix8 3 years ago
parent
commit
62fa96f033
2 changed files with 26 additions and 0 deletions
  1. BIN
      tutorials/3d/img/meshlibrary_scene.png
  2. 26 0
      tutorials/3d/using_gridmaps.rst

BIN
tutorials/3d/img/meshlibrary_scene.png


+ 26 - 0
tutorials/3d/using_gridmaps.rst

@@ -62,6 +62,32 @@ Materials
 Only the materials from within the meshes are used when generating the mesh
 Only the materials from within the meshes are used when generating the mesh
 library. Materials set on the node will be ignored.
 library. Materials set on the node will be ignored.
 
 
+NavigationMeshes
+----------------
+
+Like all mesh instances, MeshLibrary items can be assigned a :ref:`class_NavigationMesh`
+resource, which can be created manually, or baked as described below.
+
+To create the NavigationMesh from a MeshLibrary scene export, place a
+:ref:`class_NavigationMeshInstance` child node below the main MeshInstance for the GridMap
+item. Add a valid NavigationMesh resource to the NavigationMeshInstance and some source
+geometry nodes below and bake the NavigationMesh.
+
+.. note::
+
+    With small grid cells it is often necessary to reduce the NavigationMesh properties
+    for agent radius and region minimum size.
+
+.. image:: img/meshlibrary_scene.png
+
+Nodes below the NavigationMeshInstance are ignored for the MeshLibrary scene export, so
+additional nodes can be added as source geometry just for baking the navmesh.
+
+.. warning::
+
+    The baked cell size of the NavigationMesh must match the NavigationServer map cell
+    size to properly merge the navigation meshes of different grid cells.
+
 Exporting the MeshLibrary
 Exporting the MeshLibrary
 -------------------------
 -------------------------