godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Navigation API abbreviations inconsistency 

Schema for navigation to name user facing API with  "navigation" without abbreviation and e.g. NavigationServer internals with abbr "nav".
This commit is contained in:
smix8 2022-12-11 18:02:35 +01:00
parent 10bc1d8710
commit 34e7628f5f
40 changed files with 331 additions and 331 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/classes/MeshLibrary.xml
View File

@ -59,14 +59,14 @@
Returns the item's name. Returns the item's name.
</description> </description>
</method> </method>
<method name="get_item_navmesh" qualifiers="const"> <method name="get_item_navigation_mesh" qualifiers="const">
<return type="NavigationMesh" /> <return type="NavigationMesh" />
<param index="0" name="id" type="int" /> <param index="0" name="id" type="int" />
<description> <description>
Returns the item's navigation mesh. Returns the item's navigation mesh.
</description> </description>
</method> </method>
<method name="get_item_navmesh_transform" qualifiers="const"> <method name="get_item_navigation_mesh_transform" qualifiers="const">
<return type="Transform3D" /> <return type="Transform3D" />
<param index="0" name="id" type="int" /> <param index="0" name="id" type="int" />
<description> <description>
@ -126,18 +126,18 @@
This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name]. This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name].
</description> </description>
</method> </method>
<method name="set_item_navmesh"> <method name="set_item_navigation_mesh">
<return type="void" /> <return type="void" />
<param index="0" name="id" type="int" /> <param index="0" name="id" type="int" />
<param index="1" name="navmesh" type="NavigationMesh" /> <param index="1" name="navigation_mesh" type="NavigationMesh" />
<description> <description>
Sets the item's navigation mesh. Sets the item's navigation mesh.
</description> </description>
</method> </method>
<method name="set_item_navmesh_transform"> <method name="set_item_navigation_mesh_transform">
<return type="void" /> <return type="void" />
<param index="0" name="id" type="int" /> <param index="0" name="id" type="int" />
<param index="1" name="navmesh" type="Transform3D" /> <param index="1" name="navigation_mesh" type="Transform3D" />
<description> <description>
Sets the transform to apply to the item's navigation mesh. Sets the transform to apply to the item's navigation mesh.
</description> </description>

16
doc/classes/NavigationAgent2D.xml
View File

@ -16,24 +16,24 @@
Returns the distance to the target location, using the agent's global position. The user must set [member target_location] in order for this to be accurate. Returns the distance to the target location, using the agent's global position. The user must set [member target_location] in order for this to be accurate.
</description> </description>
</method> </method>
<method name="get_final_location"> <method name="get_current_navigation_path" qualifiers="const">
<return type="Vector2" />
<description>
Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
</description>
</method>
<method name="get_nav_path" qualifiers="const">
<return type="PackedVector2Array" /> <return type="PackedVector2Array" />
<description> <description>
Returns this agent's current path from start to finish in global coordinates. The path only updates when the target location is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_location] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. Returns this agent's current path from start to finish in global coordinates. The path only updates when the target location is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_location] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic.
</description> </description>
</method> </method>
<method name="get_nav_path_index" qualifiers="const"> <method name="get_current_navigation_path_index" qualifiers="const">
<return type="int" /> <return type="int" />
<description> <description>
Returns which index the agent is currently on in the navigation path's [PackedVector2Array]. Returns which index the agent is currently on in the navigation path's [PackedVector2Array].
</description> </description>
</method> </method>
<method name="get_final_location">
<return type="Vector2" />
<description>
Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
</description>
</method>
<method name="get_navigation_layer_value" qualifiers="const"> <method name="get_navigation_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <param index="0" name="layer_number" type="int" />

16
doc/classes/NavigationAgent3D.xml
View File

@ -16,24 +16,24 @@
Returns the distance to the target location, using the agent's global position. The user must set [member target_location] in order for this to be accurate. Returns the distance to the target location, using the agent's global position. The user must set [member target_location] in order for this to be accurate.
</description> </description>
</method> </method>
<method name="get_final_location"> <method name="get_current_navigation_path" qualifiers="const">
<return type="Vector3" />
<description>
Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
</description>
</method>
<method name="get_nav_path" qualifiers="const">
<return type="PackedVector3Array" /> <return type="PackedVector3Array" />
<description> <description>
Returns this agent's current path from start to finish in global coordinates. The path only updates when the target location is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_location] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. Returns this agent's current path from start to finish in global coordinates. The path only updates when the target location is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_location] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic.
</description> </description>
</method> </method>
<method name="get_nav_path_index" qualifiers="const"> <method name="get_current_navigation_path_index" qualifiers="const">
<return type="int" /> <return type="int" />
<description> <description>
Returns which index the agent is currently on in the navigation path's [PackedVector3Array]. Returns which index the agent is currently on in the navigation path's [PackedVector3Array].
</description> </description>
</method> </method>
<method name="get_final_location">
<return type="Vector3" />
<description>
Returns the reachable final location in global coordinates. This can change if the navigation path is altered in any way. Because of this, it would be best to check this each frame.
</description>
</method>
<method name="get_navigation_layer_value" qualifiers="const"> <method name="get_navigation_layer_value" qualifiers="const">
<return type="bool" /> <return type="bool" />
<param index="0" name="layer_number" type="int" /> <param index="0" name="layer_number" type="int" />

2
doc/classes/NavigationLink2D.xml
View File

@ -38,7 +38,7 @@
The distance the link will search is controlled by [method NavigationServer2D.map_set_link_connection_radius]. The distance the link will search is controlled by [method NavigationServer2D.map_set_link_connection_radius].
</member> </member>
<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
When pathfinding enters this link from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. When pathfinding enters this link from another regions navigation mesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
</member> </member>
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer2D.map_get_path]. A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer2D.map_get_path].

2
doc/classes/NavigationLink3D.xml
View File

@ -38,7 +38,7 @@
The distance the link will search is controlled by [method NavigationServer3D.map_set_link_connection_radius]. The distance the link will search is controlled by [method NavigationServer3D.map_set_link_connection_radius].
</member> </member>
<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
When pathfinding enters this link from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. When pathfinding enters this link from another regions navigation mesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
</member> </member>
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer3D.map_get_path]. A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer3D.map_get_path].

8
doc/classes/NavigationMesh.xml
View File

@ -133,11 +133,11 @@
<member name="geometry_source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" enum="NavigationMesh.SourceGeometryMode" default="0"> <member name="geometry_source_geometry_mode" type="int" setter="set_source_geometry_mode" getter="get_source_geometry_mode" enum="NavigationMesh.SourceGeometryMode" default="0">
The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values. The source of the geometry used when baking. See [enum SourceGeometryMode] for possible values.
</member> </member>
<member name="geometry_source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name" default="&amp;&quot;navmesh&quot;"> <member name="geometry_source_group_name" type="StringName" setter="set_source_group_name" getter="get_source_group_name" default="&amp;&quot;navigation_mesh_source_group&quot;">
The name of the group to scan for geometry. The name of the group to scan for geometry.
Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT]. Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
</member> </member>
<member name="polygon_verts_per_poly" type="float" setter="set_verts_per_poly" getter="get_verts_per_poly" default="6.0"> <member name="polygon_vertices_per_polyon" type="float" setter="set_vertices_per_polyon" getter="get_vertices_per_polyon" default="6.0">
The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process.
</member> </member>
<member name="region_merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0"> <member name="region_merge_size" type="float" setter="set_region_merge_size" getter="get_region_merge_size" default="20.0">
@ -177,8 +177,8 @@
<constant name="PARSED_GEOMETRY_MAX" value="3" enum="ParsedGeometryType"> <constant name="PARSED_GEOMETRY_MAX" value="3" enum="ParsedGeometryType">
Represents the size of the [enum ParsedGeometryType] enum. Represents the size of the [enum ParsedGeometryType] enum.
</constant> </constant>
<constant name="SOURCE_GEOMETRY_NAVMESH_CHILDREN" value="0" enum="SourceGeometryMode"> <constant name="SOURCE_GEOMETRY_ROOT_NODE_CHILDREN" value="0" enum="SourceGeometryMode">
Scans the child nodes of [NavigationRegion3D] recursively for geometry. Scans the child nodes of the root node recursively for geometry.
</constant> </constant>
<constant name="SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN" value="1" enum="SourceGeometryMode"> <constant name="SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN" value="1" enum="SourceGeometryMode">
Scans nodes in a group and their child nodes recursively for geometry. The group is specified by [member geometry_source_group_name]. Scans nodes in a group and their child nodes recursively for geometry. The group is specified by [member geometry_source_group_name].

8
doc/classes/NavigationMeshGenerator.xml
View File

@ -15,17 +15,17 @@
<methods> <methods>
<method name="bake"> <method name="bake">
<return type="void" /> <return type="void" />
<param index="0" name="nav_mesh" type="NavigationMesh" /> <param index="0" name="navigation_mesh" type="NavigationMesh" />
<param index="1" name="root_node" type="Node" /> <param index="1" name="root_node" type="Node" />
<description> <description>
Bakes navigation data to the provided [param nav_mesh] by parsing child nodes under the provided [param root_node] or a specific group of nodes for potential source geometry. The parse behavior can be controlled with the [member NavigationMesh.geometry_parsed_geometry_type] and [member NavigationMesh.geometry_source_geometry_mode] properties on the [NavigationMesh] resource. Bakes navigation data to the provided [param navigation_mesh] by parsing child nodes under the provided [param root_node] or a specific group of nodes for potential source geometry. The parse behavior can be controlled with the [member NavigationMesh.geometry_parsed_geometry_type] and [member NavigationMesh.geometry_source_geometry_mode] properties on the [NavigationMesh] resource.
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
<return type="void" /> <return type="void" />
<param index="0" name="nav_mesh" type="NavigationMesh" /> <param index="0" name="navigation_mesh" type="NavigationMesh" />
<description> <description>
Removes all polygons and vertices from the provided [param nav_mesh] resource. Removes all polygons and vertices from the provided [param navigation_mesh] resource.
</description> </description>
</method> </method>
</methods> </methods>

4
doc/classes/NavigationPathQueryParameters2D.xml
View File

@ -33,10 +33,10 @@
The path query uses the default A* pathfinding algorithm. The path query uses the default A* pathfinding algorithm.
</constant> </constant>
<constant name="PATH_POSTPROCESSING_CORRIDORFUNNEL" value="0" enum="PathPostProcessing"> <constant name="PATH_POSTPROCESSING_CORRIDORFUNNEL" value="0" enum="PathPostProcessing">
Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navmesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes. Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navigation mesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes.
</constant> </constant>
<constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing"> <constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing">
Centers every path position in the middle of the traveled navmesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center. Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center.
</constant> </constant>
</constants> </constants>
</class> </class>

4
doc/classes/NavigationPathQueryParameters3D.xml
View File

@ -33,10 +33,10 @@
The path query uses the default A* pathfinding algorithm. The path query uses the default A* pathfinding algorithm.
</constant> </constant>
<constant name="PATH_POSTPROCESSING_CORRIDORFUNNEL" value="0" enum="PathPostProcessing"> <constant name="PATH_POSTPROCESSING_CORRIDORFUNNEL" value="0" enum="PathPostProcessing">
Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navmesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes. Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navigation mesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes.
</constant> </constant>
<constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing"> <constant name="PATH_POSTPROCESSING_EDGECENTERED" value="1" enum="PathPostProcessing">
Centers every path position in the middle of the traveled navmesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center. Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center.
</constant> </constant>
</constants> </constants>
</class> </class>

12
doc/classes/NavigationPolygon.xml
View File

@ -12,14 +12,14 @@
var outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)]) var outline = PackedVector2Array([Vector2(0, 0), Vector2(0, 50), Vector2(50, 50), Vector2(50, 0)])
polygon.add_outline(outline) polygon.add_outline(outline)
polygon.make_polygons_from_outlines() polygon.make_polygons_from_outlines()
$NavigationRegion2D.navpoly = polygon $NavigationRegion2D.navigation_polygon = polygon
[/gdscript] [/gdscript]
[csharp] [csharp]
var polygon = new NavigationPolygon(); var polygon = new NavigationPolygon();
var outline = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) }; var outline = new Vector2[] { new Vector2(0, 0), new Vector2(0, 50), new Vector2(50, 50), new Vector2(50, 0) };
polygon.AddOutline(outline); polygon.AddOutline(outline);
polygon.MakePolygonsFromOutlines(); polygon.MakePolygonsFromOutlines();
GetNode&lt;NavigationRegion2D&gt;("NavigationRegion2D").Navpoly = polygon; GetNode&lt;NavigationRegion2D&gt;("NavigationRegion2D").NavigationPolygon = polygon;
[/csharp] [/csharp]
[/codeblocks] [/codeblocks]
Using [method add_polygon] and indices of the vertices array. Using [method add_polygon] and indices of the vertices array.
@ -30,7 +30,7 @@
polygon.vertices = vertices polygon.vertices = vertices
var indices = PackedInt32Array([0, 1, 2, 3]) var indices = PackedInt32Array([0, 1, 2, 3])
polygon.add_polygon(indices) polygon.add_polygon(indices)
$NavigationRegion2D.navpoly = polygon $NavigationRegion2D.navigation_polygon = polygon
[/gdscript] [/gdscript]
[csharp] [csharp]
var polygon = new NavigationPolygon(); var polygon = new NavigationPolygon();
@ -38,7 +38,7 @@
polygon.Vertices = vertices; polygon.Vertices = vertices;
var indices = new int[] { 0, 1, 2, 3 }; var indices = new int[] { 0, 1, 2, 3 };
polygon.AddPolygon(indices); polygon.AddPolygon(indices);
GetNode&lt;NavigationRegion2D&gt;("NavigationRegion2D").Navpoly = polygon; GetNode&lt;NavigationRegion2D&gt;("NavigationRegion2D").NavigationPolygon = polygon;
[/csharp] [/csharp]
[/codeblocks] [/codeblocks]
</description> </description>
@ -80,10 +80,10 @@
Clears the array of polygons, but it doesn't clear the array of outlines and vertices. Clears the array of polygons, but it doesn't clear the array of outlines and vertices.
</description> </description>
</method> </method>
<method name="get_mesh"> <method name="get_navigation_mesh">
<return type="NavigationMesh" /> <return type="NavigationMesh" />
<description> <description>
Returns the [NavigationMesh] resulting from this navigation polygon. This navmesh can be used to update the navmesh of a region with the [method NavigationServer3D.region_set_navmesh] API directly (as 2D uses the 3D server behind the scene). Returns the [NavigationMesh] resulting from this navigation polygon. This navigation mesh can be used to update the navigation mesh of a region with the [method NavigationServer3D.region_set_navigation_mesh] API directly (as 2D uses the 3D server behind the scene).
</description> </description>
</method> </method>
<method name="get_outline" qualifiers="const"> <method name="get_outline" qualifiers="const">

8
doc/classes/NavigationRegion2D.xml
View File

@ -6,7 +6,7 @@
<description> <description>
A region of the navigation map. It tells the [NavigationServer2D] what can be navigated and what cannot, based on its [NavigationPolygon] resource. A region of the navigation map. It tells the [NavigationServer2D] what can be navigated and what cannot, based on its [NavigationPolygon] resource.
Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using [method NavigationServer2D.map_set_edge_connection_margin]. Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using [method NavigationServer2D.map_set_edge_connection_margin].
[b]Note:[/b] Overlapping two regions' polygons is not enough for connecting two regions. They must share a similar edge. [b]Note:[/b] Overlapping two regions' navigation polygons is not enough for connecting two regions. They must share a similar edge.
The pathfinding cost of entering this region from another region can be controlled with the [member enter_cost] value. The pathfinding cost of entering this region from another region can be controlled with the [member enter_cost] value.
[b]Note:[/b] This value is not added to the path cost when the start position is already inside this region. [b]Note:[/b] This value is not added to the path cost when the start position is already inside this region.
The pathfinding cost of traveling distances inside this region can be controlled with the [member travel_cost] multiplier. The pathfinding cost of traveling distances inside this region can be controlled with the [member travel_cost] multiplier.
@ -42,16 +42,16 @@
Determines if the [NavigationRegion2D] is enabled or disabled. Determines if the [NavigationRegion2D] is enabled or disabled.
</member> </member>
<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
When pathfinding enters this region's navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. When pathfinding enters this region's navigation mesh from another regions navigation mesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
</member> </member>
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer2D.map_get_path].
</member> </member>
<member name="navpoly" type="NavigationPolygon" setter="set_navigation_polygon" getter="get_navigation_polygon"> <member name="navigation_polygon" type="NavigationPolygon" setter="set_navigation_polygon" getter="get_navigation_polygon">
The [NavigationPolygon] resource to use. The [NavigationPolygon] resource to use.
</member> </member>
<member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0"> <member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0">
When pathfinding moves inside this region's navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path. When pathfinding moves inside this region's navigation mesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path.
</member> </member>
</members> </members>
</class> </class>

8
doc/classes/NavigationRegion3D.xml
View File

@ -6,7 +6,7 @@
<description> <description>
A region of the navigation map. It tells the [NavigationServer3D] what can be navigated and what cannot, based on its [NavigationMesh] resource. A region of the navigation map. It tells the [NavigationServer3D] what can be navigated and what cannot, based on its [NavigationMesh] resource.
Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using [method NavigationServer3D.map_set_edge_connection_margin]. Two regions can be connected to each other if they share a similar edge. You can set the minimum distance between two vertices required to connect two edges by using [method NavigationServer3D.map_set_edge_connection_margin].
[b]Note:[/b] Overlapping two regions' navmeshes is not enough for connecting two regions. They must share a similar edge. [b]Note:[/b] Overlapping two regions' navigation meshes is not enough for connecting two regions. They must share a similar edge.
The cost of entering this region from another region can be controlled with the [member enter_cost] value. The cost of entering this region from another region can be controlled with the [member enter_cost] value.
[b]Note:[/b] This value is not added to the path cost when the start position is already inside this region. [b]Note:[/b] This value is not added to the path cost when the start position is already inside this region.
The cost of traveling distances inside this region can be controlled with the [member travel_cost] multiplier. The cost of traveling distances inside this region can be controlled with the [member travel_cost] multiplier.
@ -49,16 +49,16 @@
Determines if the [NavigationRegion3D] is enabled or disabled. Determines if the [NavigationRegion3D] is enabled or disabled.
</member> </member>
<member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0"> <member name="enter_cost" type="float" setter="set_enter_cost" getter="get_enter_cost" default="0.0">
When pathfinding enters this region's navmesh from another regions navmesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path. When pathfinding enters this region's navigation mesh from another regions navigation mesh the [code]enter_cost[/code] value is added to the path distance for determining the shortest path.
</member> </member>
<member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1"> <member name="navigation_layers" type="int" setter="set_navigation_layers" getter="get_navigation_layers" default="1">
A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer3D.map_get_path]. A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer3D.map_get_path].
</member> </member>
<member name="navmesh" type="NavigationMesh" setter="set_navigation_mesh" getter="get_navigation_mesh"> <member name="navigation_mesh" type="NavigationMesh" setter="set_navigation_mesh" getter="get_navigation_mesh">
The [NavigationMesh] resource to use. The [NavigationMesh] resource to use.
</member> </member>
<member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0"> <member name="travel_cost" type="float" setter="set_travel_cost" getter="get_travel_cost" default="1.0">
When pathfinding moves inside this region's navmesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path. When pathfinding moves inside this region's navigation mesh the traveled distances are multiplied with [code]travel_cost[/code] for determining the shortest path.
</member> </member>
</members> </members>
<signals> <signals>

6
doc/classes/NavigationServer2D.xml
View File

@ -489,12 +489,12 @@
Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]). Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer2D.map_get_path]).
</description> </description>
</method> </method>
<method name="region_set_navpoly" qualifiers="const"> <method name="region_set_navigation_polygon" qualifiers="const">
<return type="void" /> <return type="void" />
<param index="0" name="region" type="RID" /> <param index="0" name="region" type="RID" />
<param index="1" name="nav_poly" type="NavigationPolygon" /> <param index="1" name="navigation_polygon" type="NavigationPolygon" />
<description> <description>
Sets the navigation mesh for the region. Sets the [param navigation_polygon] for the region.
</description> </description>
</method> </method>
<method name="region_set_owner_id" qualifiers="const"> <method name="region_set_owner_id" qualifiers="const">

12
doc/classes/NavigationServer3D.xml
View File

@ -433,12 +433,12 @@
Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters3D]. Updates the provided [NavigationPathQueryResult3D] result object with the path among other results requested by the query. Queries a path in a given navigation map. Start and target position and other parameters are defined through [NavigationPathQueryParameters3D]. Updates the provided [NavigationPathQueryResult3D] result object with the path among other results requested by the query.
</description> </description>
</method> </method>
<method name="region_bake_navmesh" qualifiers="const"> <method name="region_bake_navigation_mesh" qualifiers="const">
<return type="void" /> <return type="void" />
<param index="0" name="mesh" type="NavigationMesh" /> <param index="0" name="navigation_mesh" type="NavigationMesh" />
<param index="1" name="node" type="Node" /> <param index="1" name="root_node" type="Node" />
<description> <description>
Bakes the navigation mesh. Bakes the [param navigation_mesh] with bake source geometry collected starting from the [param root_node].
</description> </description>
</method> </method>
<method name="region_create" qualifiers="const"> <method name="region_create" qualifiers="const">
@ -539,10 +539,10 @@
Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]). Set the region's navigation layers. This allows selecting regions from a path request (when using [method NavigationServer3D.map_get_path]).
</description> </description>
</method> </method>
<method name="region_set_navmesh" qualifiers="const"> <method name="region_set_navigation_mesh" qualifiers="const">
<return type="void" /> <return type="void" />
<param index="0" name="region" type="RID" /> <param index="0" name="region" type="RID" />
<param index="1" name="nav_mesh" type="NavigationMesh" /> <param index="1" name="navigation_mesh" type="NavigationMesh" />
<description> <description>
Sets the navigation mesh for the region. Sets the navigation mesh for the region.
</description> </description>

16
editor/plugins/mesh_library_editor_plugin.cpp
View File

@ -160,23 +160,23 @@ void MeshLibraryEditor::_import_scene(Node *p_scene, Ref<MeshLibrary> p_library,
p_library->set_item_shapes(id, collisions); p_library->set_item_shapes(id, collisions);
Ref<NavigationMesh> navmesh; Ref<NavigationMesh> navigation_mesh;
Transform3D navmesh_transform; Transform3D navigation_mesh_transform;
for (int j = 0; j < mi->get_child_count(); j++) { for (int j = 0; j < mi->get_child_count(); j++) {
Node *child2 = mi->get_child(j); Node *child2 = mi->get_child(j);
if (!Object::cast_to<NavigationRegion3D>(child2)) { if (!Object::cast_to<NavigationRegion3D>(child2)) {
continue; continue;
} }
NavigationRegion3D *sb = Object::cast_to<NavigationRegion3D>(child2); NavigationRegion3D *sb = Object::cast_to<NavigationRegion3D>(child2);
navmesh = sb->get_navigation_mesh(); navigation_mesh = sb->get_navigation_mesh();
navmesh_transform = sb->get_transform(); navigation_mesh_transform = sb->get_transform();
if (!navmesh.is_null()) { if (!navigation_mesh.is_null()) {
break; break;
} }
} }
if (!navmesh.is_null()) { if (!navigation_mesh.is_null()) {
p_library->set_item_navmesh(id, navmesh); p_library->set_item_navigation_mesh(id, navigation_mesh);
p_library->set_item_navmesh_transform(id, navmesh_transform); p_library->set_item_navigation_mesh_transform(id, navigation_mesh_transform);
} }
} }

68
modules/gridmap/grid_map.cpp
View File

@ -230,7 +230,7 @@ void GridMap::set_navigation_map(RID p_navigation_map) {
map_override = p_navigation_map; map_override = p_navigation_map;
for (const KeyValue<OctantKey, Octant *> &E : octant_map) { for (const KeyValue<OctantKey, Octant *> &E : octant_map) {
Octant &g = *octant_map[E.key]; Octant &g = *octant_map[E.key];
for (KeyValue<IndexKey, Octant::NavMesh> &F : g.navmesh_ids) { for (KeyValue<IndexKey, Octant::NavigationCell> &F : g.navigation_cell_ids) {
if (F.value.region.is_valid()) { if (F.value.region.is_valid()) {
NavigationServer3D::get_singleton()->region_set_map(F.value.region, map_override); NavigationServer3D::get_singleton()->region_set_map(F.value.region, map_override);
} }
@ -542,13 +542,13 @@ void GridMap::_octant_transform(const OctantKey &p_key) {
} }
// update transform for NavigationServer regions and navigation debugmesh instances // update transform for NavigationServer regions and navigation debugmesh instances
for (const KeyValue<IndexKey, Octant::NavMesh> &E : g.navmesh_ids) { for (const KeyValue<IndexKey, Octant::NavigationCell> &E : g.navigation_cell_ids) {
if (bake_navigation) { if (bake_navigation) {
if (E.value.region.is_valid()) { if (E.value.region.is_valid()) {
NavigationServer3D::get_singleton()->region_set_transform(E.value.region, get_global_transform() * E.value.xform); NavigationServer3D::get_singleton()->region_set_transform(E.value.region, get_global_transform() * E.value.xform);
} }
if (E.value.navmesh_debug_instance.is_valid()) { if (E.value.navigation_mesh_debug_instance.is_valid()) {
RS::get_singleton()->instance_set_transform(E.value.navmesh_debug_instance, get_global_transform() * E.value.xform); RS::get_singleton()->instance_set_transform(E.value.navigation_mesh_debug_instance, get_global_transform() * E.value.xform);
} }
} }
} }
@ -574,13 +574,13 @@ bool GridMap::_octant_update(const OctantKey &p_key) {
} }
//erase navigation //erase navigation
for (const KeyValue<IndexKey, Octant::NavMesh> &E : g.navmesh_ids) { for (const KeyValue<IndexKey, Octant::NavigationCell> &E : g.navigation_cell_ids) {
NavigationServer3D::get_singleton()->free(E.value.region); NavigationServer3D::get_singleton()->free(E.value.region);
if (E.value.navmesh_debug_instance.is_valid()) { if (E.value.navigation_mesh_debug_instance.is_valid()) {
RS::get_singleton()->free(E.value.navmesh_debug_instance); RS::get_singleton()->free(E.value.navigation_mesh_debug_instance);
} }
} }
g.navmesh_ids.clear(); g.navigation_cell_ids.clear();
//erase multimeshes //erase multimeshes
@ -648,17 +648,17 @@ bool GridMap::_octant_update(const OctantKey &p_key) {
} }
} }
// add the item's navmesh at given xform to GridMap's Navigation ancestor // add the item's navigation_mesh at given xform to GridMap's Navigation ancestor
Ref<NavigationMesh> navmesh = mesh_library->get_item_navmesh(c.item); Ref<NavigationMesh> navigation_mesh = mesh_library->get_item_navigation_mesh(c.item);
if (navmesh.is_valid()) { if (navigation_mesh.is_valid()) {
Octant::NavMesh nm; Octant::NavigationCell nm;
nm.xform = xform * mesh_library->get_item_navmesh_transform(c.item); nm.xform = xform * mesh_library->get_item_navigation_mesh_transform(c.item);
if (bake_navigation) { if (bake_navigation) {
RID region = NavigationServer3D::get_singleton()->region_create(); RID region = NavigationServer3D::get_singleton()->region_create();
NavigationServer3D::get_singleton()->region_set_owner_id(region, get_instance_id()); NavigationServer3D::get_singleton()->region_set_owner_id(region, get_instance_id());
NavigationServer3D::get_singleton()->region_set_navigation_layers(region, navigation_layers); NavigationServer3D::get_singleton()->region_set_navigation_layers(region, navigation_layers);
NavigationServer3D::get_singleton()->region_set_navmesh(region, navmesh); NavigationServer3D::get_singleton()->region_set_navigation_mesh(region, navigation_mesh);
NavigationServer3D::get_singleton()->region_set_transform(region, get_global_transform() * nm.xform); NavigationServer3D::get_singleton()->region_set_transform(region, get_global_transform() * nm.xform);
if (is_inside_tree()) { if (is_inside_tree()) {
if (map_override.is_valid()) { if (map_override.is_valid()) {
@ -673,19 +673,19 @@ bool GridMap::_octant_update(const OctantKey &p_key) {
// add navigation debugmesh visual instances if debug is enabled // add navigation debugmesh visual instances if debug is enabled
SceneTree *st = SceneTree::get_singleton(); SceneTree *st = SceneTree::get_singleton();
if (st && st->is_debugging_navigation_hint()) { if (st && st->is_debugging_navigation_hint()) {
if (!nm.navmesh_debug_instance.is_valid()) { if (!nm.navigation_mesh_debug_instance.is_valid()) {
RID navmesh_debug_rid = navmesh->get_debug_mesh()->get_rid(); RID navigation_mesh_debug_rid = navigation_mesh->get_debug_mesh()->get_rid();
nm.navmesh_debug_instance = RS::get_singleton()->instance_create(); nm.navigation_mesh_debug_instance = RS::get_singleton()->instance_create();
RS::get_singleton()->instance_set_base(nm.navmesh_debug_instance, navmesh_debug_rid); RS::get_singleton()->instance_set_base(nm.navigation_mesh_debug_instance, navigation_mesh_debug_rid);
} }
if (is_inside_tree()) { if (is_inside_tree()) {
RS::get_singleton()->instance_set_scenario(nm.navmesh_debug_instance, get_world_3d()->get_scenario()); RS::get_singleton()->instance_set_scenario(nm.navigation_mesh_debug_instance, get_world_3d()->get_scenario());
RS::get_singleton()->instance_set_transform(nm.navmesh_debug_instance, get_global_transform() * nm.xform); RS::get_singleton()->instance_set_transform(nm.navigation_mesh_debug_instance, get_global_transform() * nm.xform);
} }
} }
#endif // DEBUG_ENABLED #endif // DEBUG_ENABLED
} }
g.navmesh_ids[E] = nm; g.navigation_cell_ids[E] = nm;
} }
} }
@ -775,14 +775,14 @@ void GridMap::_octant_enter_world(const OctantKey &p_key) {
} }
if (bake_navigation && mesh_library.is_valid()) { if (bake_navigation && mesh_library.is_valid()) {
for (KeyValue<IndexKey, Octant::NavMesh> &F : g.navmesh_ids) { for (KeyValue<IndexKey, Octant::NavigationCell> &F : g.navigation_cell_ids) {
if (cell_map.has(F.key) && F.value.region.is_valid() == false) { if (cell_map.has(F.key) && F.value.region.is_valid() == false) {
Ref<NavigationMesh> nm = mesh_library->get_item_navmesh(cell_map[F.key].item); Ref<NavigationMesh> navigation_mesh = mesh_library->get_item_navigation_mesh(cell_map[F.key].item);
if (nm.is_valid()) { if (navigation_mesh.is_valid()) {
RID region = NavigationServer3D::get_singleton()->region_create(); RID region = NavigationServer3D::get_singleton()->region_create();
NavigationServer3D::get_singleton()->region_set_owner_id(region, get_instance_id()); NavigationServer3D::get_singleton()->region_set_owner_id(region, get_instance_id());
NavigationServer3D::get_singleton()->region_set_navigation_layers(region, navigation_layers); NavigationServer3D::get_singleton()->region_set_navigation_layers(region, navigation_layers);
NavigationServer3D::get_singleton()->region_set_navmesh(region, nm); NavigationServer3D::get_singleton()->region_set_navigation_mesh(region, navigation_mesh);
NavigationServer3D::get_singleton()->region_set_transform(region, get_global_transform() * F.value.xform); NavigationServer3D::get_singleton()->region_set_transform(region, get_global_transform() * F.value.xform);
if (map_override.is_valid()) { if (map_override.is_valid()) {
NavigationServer3D::get_singleton()->region_set_map(region, map_override); NavigationServer3D::get_singleton()->region_set_map(region, map_override);
@ -824,14 +824,14 @@ void GridMap::_octant_exit_world(const OctantKey &p_key) {
RS::get_singleton()->instance_set_scenario(g.multimesh_instances[i].instance, RID()); RS::get_singleton()->instance_set_scenario(g.multimesh_instances[i].instance, RID());
} }
for (KeyValue<IndexKey, Octant::NavMesh> &F : g.navmesh_ids) { for (KeyValue<IndexKey, Octant::NavigationCell> &F : g.navigation_cell_ids) {
if (F.value.region.is_valid()) { if (F.value.region.is_valid()) {
NavigationServer3D::get_singleton()->free(F.value.region); NavigationServer3D::get_singleton()->free(F.value.region);
F.value.region = RID(); F.value.region = RID();
} }
if (F.value.navmesh_debug_instance.is_valid()) { if (F.value.navigation_mesh_debug_instance.is_valid()) {
RS::get_singleton()->free(F.value.navmesh_debug_instance); RS::get_singleton()->free(F.value.navigation_mesh_debug_instance);
F.value.navmesh_debug_instance = RID(); F.value.navigation_mesh_debug_instance = RID();
} }
} }
@ -862,15 +862,15 @@ void GridMap::_octant_clean_up(const OctantKey &p_key) {
PhysicsServer3D::get_singleton()->free(g.static_body); PhysicsServer3D::get_singleton()->free(g.static_body);
// Erase navigation // Erase navigation
for (const KeyValue<IndexKey, Octant::NavMesh> &E : g.navmesh_ids) { for (const KeyValue<IndexKey, Octant::NavigationCell> &E : g.navigation_cell_ids) {
if (E.value.region.is_valid()) { if (E.value.region.is_valid()) {
NavigationServer3D::get_singleton()->free(E.value.region); NavigationServer3D::get_singleton()->free(E.value.region);
} }
if (E.value.navmesh_debug_instance.is_valid()) { if (E.value.navigation_mesh_debug_instance.is_valid()) {
RS::get_singleton()->free(E.value.navmesh_debug_instance); RS::get_singleton()->free(E.value.navigation_mesh_debug_instance);
} }
} }
g.navmesh_ids.clear(); g.navigation_cell_ids.clear();
#ifdef DEBUG_ENABLED #ifdef DEBUG_ENABLED
if (bake_navigation) { if (bake_navigation) {
@ -1390,7 +1390,7 @@ void GridMap::_update_octant_navigation_debug_edge_connections_mesh(const Octant
Vector<Vector3> vertex_array; Vector<Vector3> vertex_array;
for (KeyValue<IndexKey, Octant::NavMesh> &F : g.navmesh_ids) { for (KeyValue<IndexKey, Octant::NavigationCell> &F : g.navigation_cell_ids) {
if (cell_map.has(F.key) && F.value.region.is_valid()) { if (cell_map.has(F.key) && F.value.region.is_valid()) {
int connections_count = NavigationServer3D::get_singleton()->region_get_connections_count(F.value.region); int connections_count = NavigationServer3D::get_singleton()->region_get_connections_count(F.value.region);
if (connections_count == 0) { if (connections_count == 0) {

6
modules/gridmap/grid_map.h
View File

@ -95,10 +95,10 @@ class GridMap : public Node3D {
* A GridMap can have multiple Octants. * A GridMap can have multiple Octants.
*/ */
struct Octant { struct Octant {
struct NavMesh { struct NavigationCell {
RID region; RID region;
Transform3D xform; Transform3D xform;
RID navmesh_debug_instance; RID navigation_mesh_debug_instance;
}; };
struct MultimeshInstance { struct MultimeshInstance {
@ -124,7 +124,7 @@ class GridMap : public Node3D {
bool dirty = false; bool dirty = false;
RID static_body; RID static_body;
HashMap<IndexKey, NavMesh> navmesh_ids; HashMap<IndexKey, NavigationCell> navigation_cell_ids;
}; };
union OctantKey { union OctantKey {

14
modules/navigation/godot_navigation_server.cpp
View File

@ -421,20 +421,20 @@ uint32_t GodotNavigationServer::region_get_navigation_layers(RID p_region) const
return region->get_navigation_layers(); return region->get_navigation_layers();
} }
COMMAND_2(region_set_navmesh, RID, p_region, Ref<NavigationMesh>, p_nav_mesh) { COMMAND_2(region_set_navigation_mesh, RID, p_region, Ref<NavigationMesh>, p_navigation_mesh) {
NavRegion *region = region_owner.get_or_null(p_region); NavRegion *region = region_owner.get_or_null(p_region);
ERR_FAIL_COND(region == nullptr); ERR_FAIL_COND(region == nullptr);
region->set_mesh(p_nav_mesh); region->set_mesh(p_navigation_mesh);
} }
void GodotNavigationServer::region_bake_navmesh(Ref<NavigationMesh> r_mesh, Node *p_node) const { void GodotNavigationServer::region_bake_navigation_mesh(Ref<NavigationMesh> p_navigation_mesh, Node *p_root_node) const {
ERR_FAIL_COND(r_mesh.is_null()); ERR_FAIL_COND(p_navigation_mesh.is_null());
ERR_FAIL_COND(p_node == nullptr); ERR_FAIL_COND(p_root_node == nullptr);
#ifndef _3D_DISABLED #ifndef _3D_DISABLED
NavigationMeshGenerator::get_singleton()->clear(r_mesh); NavigationMeshGenerator::get_singleton()->clear(p_navigation_mesh);
NavigationMeshGenerator::get_singleton()->bake(r_mesh, p_node); NavigationMeshGenerator::get_singleton()->bake(p_navigation_mesh, p_root_node);
#endif #endif
} }

4
modules/navigation/godot_navigation_server.h
View File

@ -135,8 +135,8 @@ public:
COMMAND_2(region_set_navigation_layers, RID, p_region, uint32_t, p_navigation_layers); COMMAND_2(region_set_navigation_layers, RID, p_region, uint32_t, p_navigation_layers);
virtual uint32_t region_get_navigation_layers(RID p_region) const override; virtual uint32_t region_get_navigation_layers(RID p_region) const override;
COMMAND_2(region_set_transform, RID, p_region, Transform3D, p_transform); COMMAND_2(region_set_transform, RID, p_region, Transform3D, p_transform);
COMMAND_2(region_set_navmesh, RID, p_region, Ref<NavigationMesh>, p_nav_mesh); COMMAND_2(region_set_navigation_mesh, RID, p_region, Ref<NavigationMesh>, p_navigation_mesh);
virtual void region_bake_navmesh(Ref<NavigationMesh> r_mesh, Node *p_node) const override; virtual void region_bake_navigation_mesh(Ref<NavigationMesh> p_navigation_mesh, Node *p_root_node) const override;
virtual int region_get_connections_count(RID p_region) const override; virtual int region_get_connections_count(RID p_region) const override;
virtual Vector3 region_get_connection_pathway_start(RID p_region, int p_connection_id) const override; virtual Vector3 region_get_connection_pathway_start(RID p_region, int p_connection_id) const override;
virtual Vector3 region_get_connection_pathway_end(RID p_region, int p_connection_id) const override; virtual Vector3 region_get_connection_pathway_end(RID p_region, int p_connection_id) const override;

100
modules/navigation/navigation_mesh_generator.cpp
View File

@ -470,14 +470,14 @@ void NavigationMeshGenerator::_parse_geometry(const Transform3D &p_navmesh_trans
} }
} }
void NavigationMeshGenerator::_convert_detail_mesh_to_native_navigation_mesh(const rcPolyMeshDetail *p_detail_mesh, Ref<NavigationMesh> p_nav_mesh) { void NavigationMeshGenerator::_convert_detail_mesh_to_native_navigation_mesh(const rcPolyMeshDetail *p_detail_mesh, Ref<NavigationMesh> p_navigation_mesh) {
Vector<Vector3> nav_vertices; Vector<Vector3> nav_vertices;
for (int i = 0; i < p_detail_mesh->nverts; i++) { for (int i = 0; i < p_detail_mesh->nverts; i++) {
const float *v = &p_detail_mesh->verts[i * 3]; const float *v = &p_detail_mesh->verts[i * 3];
nav_vertices.push_back(Vector3(v[0], v[1], v[2])); nav_vertices.push_back(Vector3(v[0], v[1], v[2]));
} }
p_nav_mesh->set_vertices(nav_vertices); p_navigation_mesh->set_vertices(nav_vertices);
for (int i = 0; i < p_detail_mesh->nmeshes; i++) { for (int i = 0; i < p_detail_mesh->nmeshes; i++) {
const unsigned int *m = &p_detail_mesh->meshes[i * 4]; const unsigned int *m = &p_detail_mesh->meshes[i * 4];
@ -492,13 +492,13 @@ void NavigationMeshGenerator::_convert_detail_mesh_to_native_navigation_mesh(con
nav_indices.write[0] = ((int)(bverts + tris[j * 4 + 0])); nav_indices.write[0] = ((int)(bverts + tris[j * 4 + 0]));
nav_indices.write[1] = ((int)(bverts + tris[j * 4 + 2])); nav_indices.write[1] = ((int)(bverts + tris[j * 4 + 2]));
nav_indices.write[2] = ((int)(bverts + tris[j * 4 + 1])); nav_indices.write[2] = ((int)(bverts + tris[j * 4 + 1]));
p_nav_mesh->add_polygon(nav_indices); p_navigation_mesh->add_polygon(nav_indices);
} }
} }
} }
void NavigationMeshGenerator::_build_recast_navigation_mesh( void NavigationMeshGenerator::_build_recast_navigation_mesh(
Ref<NavigationMesh> p_nav_mesh, Ref<NavigationMesh> p_navigation_mesh,
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
EditorProgress *ep, EditorProgress *ep,
#endif #endif
@ -528,42 +528,42 @@ void NavigationMeshGenerator::_build_recast_navigation_mesh(
rcConfig cfg; rcConfig cfg;
memset(&cfg, 0, sizeof(cfg)); memset(&cfg, 0, sizeof(cfg));
cfg.cs = p_nav_mesh->get_cell_size(); cfg.cs = p_navigation_mesh->get_cell_size();
cfg.ch = p_nav_mesh->get_cell_height(); cfg.ch = p_navigation_mesh->get_cell_height();
cfg.walkableSlopeAngle = p_nav_mesh->get_agent_max_slope(); cfg.walkableSlopeAngle = p_navigation_mesh->get_agent_max_slope();
cfg.walkableHeight = (int)Math::ceil(p_nav_mesh->get_agent_height() / cfg.ch); cfg.walkableHeight = (int)Math::ceil(p_navigation_mesh->get_agent_height() / cfg.ch);
cfg.walkableClimb = (int)Math::floor(p_nav_mesh->get_agent_max_climb() / cfg.ch); cfg.walkableClimb = (int)Math::floor(p_navigation_mesh->get_agent_max_climb() / cfg.ch);
cfg.walkableRadius = (int)Math::ceil(p_nav_mesh->get_agent_radius() / cfg.cs); cfg.walkableRadius = (int)Math::ceil(p_navigation_mesh->get_agent_radius() / cfg.cs);
cfg.maxEdgeLen = (int)(p_nav_mesh->get_edge_max_length() / p_nav_mesh->get_cell_size()); cfg.maxEdgeLen = (int)(p_navigation_mesh->get_edge_max_length() / p_navigation_mesh->get_cell_size());
cfg.maxSimplificationError = p_nav_mesh->get_edge_max_error(); cfg.maxSimplificationError = p_navigation_mesh->get_edge_max_error();
cfg.minRegionArea = (int)(p_nav_mesh->get_region_min_size() * p_nav_mesh->get_region_min_size()); cfg.minRegionArea = (int)(p_navigation_mesh->get_region_min_size() * p_navigation_mesh->get_region_min_size());
cfg.mergeRegionArea = (int)(p_nav_mesh->get_region_merge_size() * p_nav_mesh->get_region_merge_size()); cfg.mergeRegionArea = (int)(p_navigation_mesh->get_region_merge_size() * p_navigation_mesh->get_region_merge_size());
cfg.maxVertsPerPoly = (int)p_nav_mesh->get_verts_per_poly(); cfg.maxVertsPerPoly = (int)p_navigation_mesh->get_vertices_per_polyon();
cfg.detailSampleDist = MAX(p_nav_mesh->get_cell_size() * p_nav_mesh->get_detail_sample_distance(), 0.1f); cfg.detailSampleDist = MAX(p_navigation_mesh->get_cell_size() * p_navigation_mesh->get_detail_sample_distance(), 0.1f);
cfg.detailSampleMaxError = p_nav_mesh->get_cell_height() * p_nav_mesh->get_detail_sample_max_error(); cfg.detailSampleMaxError = p_navigation_mesh->get_cell_height() * p_navigation_mesh->get_detail_sample_max_error();
if (!Math::is_equal_approx((float)cfg.walkableHeight * cfg.ch, p_nav_mesh->get_agent_height())) { if (!Math::is_equal_approx((float)cfg.walkableHeight * cfg.ch, p_navigation_mesh->get_agent_height())) {
WARN_PRINT("Property agent_height is ceiled to cell_height voxel units and loses precision."); WARN_PRINT("Property agent_height is ceiled to cell_height voxel units and loses precision.");
} }
if (!Math::is_equal_approx((float)cfg.walkableClimb * cfg.ch, p_nav_mesh->get_agent_max_climb())) { if (!Math::is_equal_approx((float)cfg.walkableClimb * cfg.ch, p_navigation_mesh->get_agent_max_climb())) {
WARN_PRINT("Property agent_max_climb is floored to cell_height voxel units and loses precision."); WARN_PRINT("Property agent_max_climb is floored to cell_height voxel units and loses precision.");
} }
if (!Math::is_equal_approx((float)cfg.walkableRadius * cfg.cs, p_nav_mesh->get_agent_radius())) { if (!Math::is_equal_approx((float)cfg.walkableRadius * cfg.cs, p_navigation_mesh->get_agent_radius())) {
WARN_PRINT("Property agent_radius is ceiled to cell_size voxel units and loses precision."); WARN_PRINT("Property agent_radius is ceiled to cell_size voxel units and loses precision.");
} }
if (!Math::is_equal_approx((float)cfg.maxEdgeLen * cfg.cs, p_nav_mesh->get_edge_max_length())) { if (!Math::is_equal_approx((float)cfg.maxEdgeLen * cfg.cs, p_navigation_mesh->get_edge_max_length())) {
WARN_PRINT("Property edge_max_length is rounded to cell_size voxel units and loses precision."); WARN_PRINT("Property edge_max_length is rounded to cell_size voxel units and loses precision.");
} }
if (!Math::is_equal_approx((float)cfg.minRegionArea, p_nav_mesh->get_region_min_size() * p_nav_mesh->get_region_min_size())) { if (!Math::is_equal_approx((float)cfg.minRegionArea, p_navigation_mesh->get_region_min_size() * p_navigation_mesh->get_region_min_size())) {
WARN_PRINT("Property region_min_size is converted to int and loses precision."); WARN_PRINT("Property region_min_size is converted to int and loses precision.");
} }
if (!Math::is_equal_approx((float)cfg.mergeRegionArea, p_nav_mesh->get_region_merge_size() * p_nav_mesh->get_region_merge_size())) { if (!Math::is_equal_approx((float)cfg.mergeRegionArea, p_navigation_mesh->get_region_merge_size() * p_navigation_mesh->get_region_merge_size())) {
WARN_PRINT("Property region_merge_size is converted to int and loses precision."); WARN_PRINT("Property region_merge_size is converted to int and loses precision.");
} }
if (!Math::is_equal_approx((float)cfg.maxVertsPerPoly, p_nav_mesh->get_verts_per_poly())) { if (!Math::is_equal_approx((float)cfg.maxVertsPerPoly, p_navigation_mesh->get_vertices_per_polyon())) {
WARN_PRINT("Property verts_per_poly is converted to int and loses precision."); WARN_PRINT("Property vertices_per_polyon is converted to int and loses precision.");
} }
if (p_nav_mesh->get_cell_size() * p_nav_mesh->get_detail_sample_distance() < 0.1f) { if (p_navigation_mesh->get_cell_size() * p_navigation_mesh->get_detail_sample_distance() < 0.1f) {
WARN_PRINT("Property detail_sample_distance is clamped to 0.1 world units as the resulting value from multiplying with cell_size is too low."); WARN_PRINT("Property detail_sample_distance is clamped to 0.1 world units as the resulting value from multiplying with cell_size is too low.");
} }
@ -574,9 +574,9 @@ void NavigationMeshGenerator::_build_recast_navigation_mesh(
cfg.bmax[1] = bmax[1]; cfg.bmax[1] = bmax[1];
cfg.bmax[2] = bmax[2]; cfg.bmax[2] = bmax[2];
AABB baking_aabb = p_nav_mesh->get_filter_baking_aabb(); AABB baking_aabb = p_navigation_mesh->get_filter_baking_aabb();
if (baking_aabb.has_volume()) { if (baking_aabb.has_volume()) {
Vector3 baking_aabb_offset = p_nav_mesh->get_filter_baking_aabb_offset(); Vector3 baking_aabb_offset = p_navigation_mesh->get_filter_baking_aabb_offset();
cfg.bmin[0] = baking_aabb.position[0] + baking_aabb_offset.x; cfg.bmin[0] = baking_aabb.position[0] + baking_aabb_offset.x;
cfg.bmin[1] = baking_aabb.position[1] + baking_aabb_offset.y; cfg.bmin[1] = baking_aabb.position[1] + baking_aabb_offset.y;
cfg.bmin[2] = baking_aabb.position[2] + baking_aabb_offset.z; cfg.bmin[2] = baking_aabb.position[2] + baking_aabb_offset.z;
@ -627,13 +627,13 @@ void NavigationMeshGenerator::_build_recast_navigation_mesh(
ERR_FAIL_COND(!rcRasterizeTriangles(&ctx, verts, nverts, tris, tri_areas.ptr(), ntris, *hf, cfg.walkableClimb)); ERR_FAIL_COND(!rcRasterizeTriangles(&ctx, verts, nverts, tris, tri_areas.ptr(), ntris, *hf, cfg.walkableClimb));
} }
if (p_nav_mesh->get_filter_low_hanging_obstacles()) { if (p_navigation_mesh->get_filter_low_hanging_obstacles()) {
rcFilterLowHangingWalkableObstacles(&ctx, cfg.walkableClimb, *hf); rcFilterLowHangingWalkableObstacles(&ctx, cfg.walkableClimb, *hf);
} }
if (p_nav_mesh->get_filter_ledge_spans()) { if (p_navigation_mesh->get_filter_ledge_spans()) {
rcFilterLedgeSpans(&ctx, cfg.walkableHeight, cfg.walkableClimb, *hf); rcFilterLedgeSpans(&ctx, cfg.walkableHeight, cfg.walkableClimb, *hf);
} }
if (p_nav_mesh->get_filter_walkable_low_height_spans()) { if (p_navigation_mesh->get_filter_walkable_low_height_spans()) {
rcFilterWalkableLowHeightSpans(&ctx, cfg.walkableHeight, *hf); rcFilterWalkableLowHeightSpans(&ctx, cfg.walkableHeight, *hf);
} }
@ -665,10 +665,10 @@ void NavigationMeshGenerator::_build_recast_navigation_mesh(
} }
#endif #endif
if (p_nav_mesh->get_sample_partition_type() == NavigationMesh::SAMPLE_PARTITION_WATERSHED) { if (p_navigation_mesh->get_sample_partition_type() == NavigationMesh::SAMPLE_PARTITION_WATERSHED) {
ERR_FAIL_COND(!rcBuildDistanceField(&ctx, *chf)); ERR_FAIL_COND(!rcBuildDistanceField(&ctx, *chf));
ERR_FAIL_COND(!rcBuildRegions(&ctx, *chf, 0, cfg.minRegionArea, cfg.mergeRegionArea)); ERR_FAIL_COND(!rcBuildRegions(&ctx, *chf, 0, cfg.minRegionArea, cfg.mergeRegionArea));
} else if (p_nav_mesh->get_sample_partition_type() == NavigationMesh::SAMPLE_PARTITION_MONOTONE) { } else if (p_navigation_mesh->get_sample_partition_type() == NavigationMesh::SAMPLE_PARTITION_MONOTONE) {
ERR_FAIL_COND(!rcBuildRegionsMonotone(&ctx, *chf, 0, cfg.minRegionArea, cfg.mergeRegionArea)); ERR_FAIL_COND(!rcBuildRegionsMonotone(&ctx, *chf, 0, cfg.minRegionArea, cfg.mergeRegionArea));
} else { } else {
ERR_FAIL_COND(!rcBuildLayerRegions(&ctx, *chf, 0, cfg.minRegionArea)); ERR_FAIL_COND(!rcBuildLayerRegions(&ctx, *chf, 0, cfg.minRegionArea));
@ -710,7 +710,7 @@ void NavigationMeshGenerator::_build_recast_navigation_mesh(
} }
#endif #endif
_convert_detail_mesh_to_native_navigation_mesh(detail_mesh, p_nav_mesh); _convert_detail_mesh_to_native_navigation_mesh(detail_mesh, p_navigation_mesh);
rcFreePolyMesh(poly_mesh); rcFreePolyMesh(poly_mesh);
poly_mesh = nullptr; poly_mesh = nullptr;
@ -729,8 +729,8 @@ NavigationMeshGenerator::NavigationMeshGenerator() {
NavigationMeshGenerator::~NavigationMeshGenerator() { NavigationMeshGenerator::~NavigationMeshGenerator() {
} }
void NavigationMeshGenerator::bake(Ref<NavigationMesh> p_nav_mesh, Node *p_node) { void NavigationMeshGenerator::bake(Ref<NavigationMesh> p_navigation_mesh, Node *p_root_node) {
ERR_FAIL_COND_MSG(!p_nav_mesh.is_valid(), "Invalid navigation mesh."); ERR_FAIL_COND_MSG(!p_navigation_mesh.is_valid(), "Invalid navigation mesh.");
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
EditorProgress *ep(nullptr); EditorProgress *ep(nullptr);
@ -755,17 +755,17 @@ void NavigationMeshGenerator::bake(Ref<NavigationMesh> p_nav_mesh, Node *p_node)
List<Node *> parse_nodes; List<Node *> parse_nodes;
if (p_nav_mesh->get_source_geometry_mode() == NavigationMesh::SOURCE_GEOMETRY_NAVMESH_CHILDREN) { if (p_navigation_mesh->get_source_geometry_mode() == NavigationMesh::SOURCE_GEOMETRY_ROOT_NODE_CHILDREN) {
parse_nodes.push_back(p_node); parse_nodes.push_back(p_root_node);
} else { } else {
p_node->get_tree()->get_nodes_in_group(p_nav_mesh->get_source_group_name(), &parse_nodes); p_root_node->get_tree()->get_nodes_in_group(p_navigation_mesh->get_source_group_name(), &parse_nodes);
} }
Transform3D navmesh_xform = Object::cast_to<Node3D>(p_node)->get_global_transform().affine_inverse(); Transform3D navmesh_xform = Object::cast_to<Node3D>(p_root_node)->get_global_transform().affine_inverse();
for (Node *E : parse_nodes) { for (Node *E : parse_nodes) {
NavigationMesh::ParsedGeometryType geometry_type = p_nav_mesh->get_parsed_geometry_type(); NavigationMesh::ParsedGeometryType geometry_type = p_navigation_mesh->get_parsed_geometry_type();
uint32_t collision_mask = p_nav_mesh->get_collision_mask(); uint32_t collision_mask = p_navigation_mesh->get_collision_mask();
bool recurse_children = p_nav_mesh->get_source_geometry_mode() != NavigationMesh::SOURCE_GEOMETRY_GROUPS_EXPLICIT; bool recurse_children = p_navigation_mesh->get_source_geometry_mode() != NavigationMesh::SOURCE_GEOMETRY_GROUPS_EXPLICIT;
_parse_geometry(navmesh_xform, E, vertices, indices, geometry_type, collision_mask, recurse_children); _parse_geometry(navmesh_xform, E, vertices, indices, geometry_type, collision_mask, recurse_children);
} }
@ -777,7 +777,7 @@ void NavigationMeshGenerator::bake(Ref<NavigationMesh> p_nav_mesh, Node *p_node)
rcPolyMeshDetail *detail_mesh = nullptr; rcPolyMeshDetail *detail_mesh = nullptr;
_build_recast_navigation_mesh( _build_recast_navigation_mesh(
p_nav_mesh, p_navigation_mesh,
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
ep, ep,
#endif #endif
@ -816,16 +816,16 @@ void NavigationMeshGenerator::bake(Ref<NavigationMesh> p_nav_mesh, Node *p_node)
#endif #endif
} }
void NavigationMeshGenerator::clear(Ref<NavigationMesh> p_nav_mesh) { void NavigationMeshGenerator::clear(Ref<NavigationMesh> p_navigation_mesh) {
if (p_nav_mesh.is_valid()) { if (p_navigation_mesh.is_valid()) {
p_nav_mesh->clear_polygons(); p_navigation_mesh->clear_polygons();
p_nav_mesh->set_vertices(Vector<Vector3>()); p_navigation_mesh->set_vertices(Vector<Vector3>());
} }
} }
void NavigationMeshGenerator::_bind_methods() { void NavigationMeshGenerator::_bind_methods() {
ClassDB::bind_method(D_METHOD("bake", "nav_mesh", "root_node"), &NavigationMeshGenerator::bake); ClassDB::bind_method(D_METHOD("bake", "navigation_mesh", "root_node"), &NavigationMeshGenerator::bake);
ClassDB::bind_method(D_METHOD("clear", "nav_mesh"), &NavigationMeshGenerator::clear); ClassDB::bind_method(D_METHOD("clear", "navigation_mesh"), &NavigationMeshGenerator::clear);
} }
#endif #endif

8
modules/navigation/navigation_mesh_generator.h
View File

@ -55,9 +55,9 @@ protected:
static void _add_faces(const PackedVector3Array &p_faces, const Transform3D &p_xform, Vector<float> &p_vertices, Vector<int> &p_indices); static void _add_faces(const PackedVector3Array &p_faces, const Transform3D &p_xform, Vector<float> &p_vertices, Vector<int> &p_indices);
static void _parse_geometry(const Transform3D &p_navmesh_transform, Node *p_node, Vector<float> &p_vertices, Vector<int> &p_indices, NavigationMesh::ParsedGeometryType p_generate_from, uint32_t p_collision_mask, bool p_recurse_children); static void _parse_geometry(const Transform3D &p_navmesh_transform, Node *p_node, Vector<float> &p_vertices, Vector<int> &p_indices, NavigationMesh::ParsedGeometryType p_generate_from, uint32_t p_collision_mask, bool p_recurse_children);
static void _convert_detail_mesh_to_native_navigation_mesh(const rcPolyMeshDetail *p_detail_mesh, Ref<NavigationMesh> p_nav_mesh); static void _convert_detail_mesh_to_native_navigation_mesh(const rcPolyMeshDetail *p_detail_mesh, Ref<NavigationMesh> p_navigation_mesh);
static void _build_recast_navigation_mesh( static void _build_recast_navigation_mesh(
Ref<NavigationMesh> p_nav_mesh, Ref<NavigationMesh> p_navigation_mesh,
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
EditorProgress *ep, EditorProgress *ep,
#endif #endif
@ -75,8 +75,8 @@ public:
NavigationMeshGenerator(); NavigationMeshGenerator();
~NavigationMeshGenerator(); ~NavigationMeshGenerator();
void bake(Ref<NavigationMesh> p_nav_mesh, Node *p_node); void bake(Ref<NavigationMesh> p_navigation_mesh, Node *p_root_node);
void clear(Ref<NavigationMesh> p_nav_mesh); void clear(Ref<NavigationMesh> p_navigation_mesh);
}; };
#endif #endif

24
scene/2d/navigation_agent_2d.cpp
View File

@ -79,8 +79,8 @@ void NavigationAgent2D::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_next_location"), &NavigationAgent2D::get_next_location); ClassDB::bind_method(D_METHOD("get_next_location"), &NavigationAgent2D::get_next_location);
ClassDB::bind_method(D_METHOD("distance_to_target"), &NavigationAgent2D::distance_to_target); ClassDB::bind_method(D_METHOD("distance_to_target"), &NavigationAgent2D::distance_to_target);
ClassDB::bind_method(D_METHOD("set_velocity", "velocity"), &NavigationAgent2D::set_velocity); ClassDB::bind_method(D_METHOD("set_velocity", "velocity"), &NavigationAgent2D::set_velocity);
ClassDB::bind_method(D_METHOD("get_nav_path"), &NavigationAgent2D::get_nav_path); ClassDB::bind_method(D_METHOD("get_current_navigation_path"), &NavigationAgent2D::get_current_navigation_path);
ClassDB::bind_method(D_METHOD("get_nav_path_index"), &NavigationAgent2D::get_nav_path_index); ClassDB::bind_method(D_METHOD("get_current_navigation_path_index"), &NavigationAgent2D::get_current_navigation_path_index);
ClassDB::bind_method(D_METHOD("is_target_reached"), &NavigationAgent2D::is_target_reached); ClassDB::bind_method(D_METHOD("is_target_reached"), &NavigationAgent2D::is_target_reached);
ClassDB::bind_method(D_METHOD("is_target_reachable"), &NavigationAgent2D::is_target_reachable); ClassDB::bind_method(D_METHOD("is_target_reachable"), &NavigationAgent2D::is_target_reachable);
ClassDB::bind_method(D_METHOD("is_navigation_finished"), &NavigationAgent2D::is_navigation_finished); ClassDB::bind_method(D_METHOD("is_navigation_finished"), &NavigationAgent2D::is_navigation_finished);
@ -329,11 +329,11 @@ Vector2 NavigationAgent2D::get_next_location() {
ERR_FAIL_COND_V_MSG(agent_parent == nullptr, Vector2(), "The agent has no parent."); ERR_FAIL_COND_V_MSG(agent_parent == nullptr, Vector2(), "The agent has no parent.");
return agent_parent->get_global_position(); return agent_parent->get_global_position();
} else { } else {
return navigation_path[nav_path_index]; return navigation_path[navigation_path_index];
} }
} }
const Vector<Vector2> &NavigationAgent2D::get_nav_path() const { const Vector<Vector2> &NavigationAgent2D::get_current_navigation_path() const {
return navigation_result->get_path(); return navigation_result->get_path();
} }
@ -418,12 +418,12 @@ void NavigationAgent2D::update_navigation() {
reload_path = true; reload_path = true;
} else { } else {
// Check if too far from the navigation path // Check if too far from the navigation path
if (nav_path_index > 0) { if (navigation_path_index > 0) {
const Vector<Vector2> &navigation_path = navigation_result->get_path(); const Vector<Vector2> &navigation_path = navigation_result->get_path();
Vector2 segment[2]; Vector2 segment[2];
segment[0] = navigation_path[nav_path_index - 1]; segment[0] = navigation_path[navigation_path_index - 1];
segment[1] = navigation_path[nav_path_index]; segment[1] = navigation_path[navigation_path_index];
Vector2 p = Geometry2D::get_closest_point_to_segment(origin, segment); Vector2 p = Geometry2D::get_closest_point_to_segment(origin, segment);
if (origin.distance_to(p) >= path_max_distance) { if (origin.distance_to(p) >= path_max_distance) {
// To faraway, reload path // To faraway, reload path
@ -445,7 +445,7 @@ void NavigationAgent2D::update_navigation() {
NavigationServer2D::get_singleton()->query_path(navigation_query, navigation_result); NavigationServer2D::get_singleton()->query_path(navigation_query, navigation_result);
navigation_finished = false; navigation_finished = false;
nav_path_index = 0; navigation_path_index = 0;
emit_signal(SNAME("path_changed")); emit_signal(SNAME("path_changed"));
} }
@ -457,11 +457,11 @@ void NavigationAgent2D::update_navigation() {
if (navigation_finished == false) { if (navigation_finished == false) {
// Advances to the next far away location. // Advances to the next far away location.
const Vector<Vector2> &navigation_path = navigation_result->get_path(); const Vector<Vector2> &navigation_path = navigation_result->get_path();
while (origin.distance_to(navigation_path[nav_path_index]) < path_desired_distance) { while (origin.distance_to(navigation_path[navigation_path_index]) < path_desired_distance) {
nav_path_index += 1; navigation_path_index += 1;
if (nav_path_index == navigation_path.size()) { if (navigation_path_index == navigation_path.size()) {
_check_distance_to_target(); _check_distance_to_target();
nav_path_index -= 1; navigation_path_index -= 1;
navigation_finished = true; navigation_finished = true;
emit_signal(SNAME("navigation_finished")); emit_signal(SNAME("navigation_finished"));
break; break;

8
scene/2d/navigation_agent_2d.h
View File

@ -62,7 +62,7 @@ class NavigationAgent2D : public Node {
Vector2 target_location; Vector2 target_location;
Ref<NavigationPathQueryParameters2D> navigation_query; Ref<NavigationPathQueryParameters2D> navigation_query;
Ref<NavigationPathQueryResult2D> navigation_result; Ref<NavigationPathQueryResult2D> navigation_result;
int nav_path_index = 0; int navigation_path_index = 0;
bool velocity_submitted = false; bool velocity_submitted = false;
Vector2 prev_safe_velocity; Vector2 prev_safe_velocity;
/// The submitted target velocity /// The submitted target velocity
@ -141,10 +141,10 @@ public:
Vector2 get_next_location(); Vector2 get_next_location();
const Vector<Vector2> &get_nav_path() const; const Vector<Vector2> &get_current_navigation_path() const;
int get_nav_path_index() const { int get_current_navigation_path_index() const {
return nav_path_index; return navigation_path_index;
} }
real_t distance_to_target() const; real_t distance_to_target() const;

46
scene/2d/navigation_region_2d.cpp
View File

@ -137,11 +137,11 @@ RID NavigationRegion2D::get_region_rid() const {
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
Rect2 NavigationRegion2D::_edit_get_rect() const { Rect2 NavigationRegion2D::_edit_get_rect() const {
return navpoly.is_valid() ? navpoly->_edit_get_rect() : Rect2(); return navigation_polygon.is_valid() ? navigation_polygon->_edit_get_rect() : Rect2();
} }
bool NavigationRegion2D::_edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const { bool NavigationRegion2D::_edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const {
return navpoly.is_valid() ? navpoly->_edit_is_selected_on_click(p_point, p_tolerance) : false; return navigation_polygon.is_valid() ? navigation_polygon->_edit_is_selected_on_click(p_point, p_tolerance) : false;
} }
#endif #endif
@ -167,8 +167,8 @@ void NavigationRegion2D::_notification(int p_what) {
case NOTIFICATION_DRAW: { case NOTIFICATION_DRAW: {
#ifdef DEBUG_ENABLED #ifdef DEBUG_ENABLED
if (is_inside_tree() && (Engine::get_singleton()->is_editor_hint() || NavigationServer3D::get_singleton()->get_debug_enabled()) && navpoly.is_valid()) { if (is_inside_tree() && (Engine::get_singleton()->is_editor_hint() || NavigationServer3D::get_singleton()->get_debug_enabled()) && navigation_polygon.is_valid()) {
Vector<Vector2> verts = navpoly->get_vertices(); Vector<Vector2> verts = navigation_polygon->get_vertices();
if (verts.size() < 3) { if (verts.size() < 3) {
return; return;
} }
@ -183,9 +183,9 @@ void NavigationRegion2D::_notification(int p_what) {
RandomPCG rand; RandomPCG rand;
for (int i = 0; i < navpoly->get_polygon_count(); i++) { for (int i = 0; i < navigation_polygon->get_polygon_count(); i++) {
// An array of vertices for this polygon. // An array of vertices for this polygon.
Vector<int> polygon = navpoly->get_polygon(i); Vector<int> polygon = navigation_polygon->get_polygon(i);
Vector<Vector2> vertices; Vector<Vector2> vertices;
vertices.resize(polygon.size()); vertices.resize(polygon.size());
for (int j = 0; j < polygon.size(); j++) { for (int j = 0; j < polygon.size(); j++) {
@ -226,36 +226,36 @@ void NavigationRegion2D::_notification(int p_what) {
} }
} }
void NavigationRegion2D::set_navigation_polygon(const Ref<NavigationPolygon> &p_navpoly) { void NavigationRegion2D::set_navigation_polygon(const Ref<NavigationPolygon> &p_navigation_polygon) {
if (p_navpoly == navpoly) { if (p_navigation_polygon == navigation_polygon) {
return; return;
} }
if (navpoly.is_valid()) { if (navigation_polygon.is_valid()) {
navpoly->disconnect(CoreStringNames::get_singleton()->changed, callable_mp(this, &NavigationRegion2D::_navpoly_changed)); navigation_polygon->disconnect(CoreStringNames::get_singleton()->changed, callable_mp(this, &NavigationRegion2D::_navigation_polygon_changed));
} }
navpoly = p_navpoly; navigation_polygon = p_navigation_polygon;
NavigationServer2D::get_singleton()->region_set_navpoly(region, p_navpoly); NavigationServer2D::get_singleton()->region_set_navigation_polygon(region, p_navigation_polygon);
if (navpoly.is_valid()) { if (navigation_polygon.is_valid()) {
navpoly->connect(CoreStringNames::get_singleton()->changed, callable_mp(this, &NavigationRegion2D::_navpoly_changed)); navigation_polygon->connect(CoreStringNames::get_singleton()->changed, callable_mp(this, &NavigationRegion2D::_navigation_polygon_changed));
} }
_navpoly_changed(); _navigation_polygon_changed();
update_configuration_warnings(); update_configuration_warnings();
} }
Ref<NavigationPolygon> NavigationRegion2D::get_navigation_polygon() const { Ref<NavigationPolygon> NavigationRegion2D::get_navigation_polygon() const {
return navpoly; return navigation_polygon;
} }
void NavigationRegion2D::_navpoly_changed() { void NavigationRegion2D::_navigation_polygon_changed() {
if (is_inside_tree() && (Engine::get_singleton()->is_editor_hint() || get_tree()->is_debugging_navigation_hint())) { if (is_inside_tree() && (Engine::get_singleton()->is_editor_hint() || get_tree()->is_debugging_navigation_hint())) {
queue_redraw(); queue_redraw();
} }
if (navpoly.is_valid()) { if (navigation_polygon.is_valid()) {
NavigationServer2D::get_singleton()->region_set_navpoly(region, navpoly); NavigationServer2D::get_singleton()->region_set_navigation_polygon(region, navigation_polygon);
} }
} }
@ -271,7 +271,7 @@ PackedStringArray NavigationRegion2D::get_configuration_warnings() const {
PackedStringArray warnings = Node2D::get_configuration_warnings(); PackedStringArray warnings = Node2D::get_configuration_warnings();
if (is_visible_in_tree() && is_inside_tree()) { if (is_visible_in_tree() && is_inside_tree()) {
if (!navpoly.is_valid()) { if (!navigation_polygon.is_valid()) {
warnings.push_back(RTR("A NavigationMesh resource must be set or created for this node to work. Please set a property or draw a polygon.")); warnings.push_back(RTR("A NavigationMesh resource must be set or created for this node to work. Please set a property or draw a polygon."));
} }
} }
@ -280,7 +280,7 @@ PackedStringArray NavigationRegion2D::get_configuration_warnings() const {
} }
void NavigationRegion2D::_bind_methods() { void NavigationRegion2D::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_navigation_polygon", "navpoly"), &NavigationRegion2D::set_navigation_polygon); ClassDB::bind_method(D_METHOD("set_navigation_polygon", "navigation_polygon"), &NavigationRegion2D::set_navigation_polygon);
ClassDB::bind_method(D_METHOD("get_navigation_polygon"), &NavigationRegion2D::get_navigation_polygon); ClassDB::bind_method(D_METHOD("get_navigation_polygon"), &NavigationRegion2D::get_navigation_polygon);
ClassDB::bind_method(D_METHOD("set_enabled", "enabled"), &NavigationRegion2D::set_enabled); ClassDB::bind_method(D_METHOD("set_enabled", "enabled"), &NavigationRegion2D::set_enabled);
@ -300,9 +300,9 @@ void NavigationRegion2D::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_travel_cost", "travel_cost"), &NavigationRegion2D::set_travel_cost); ClassDB::bind_method(D_METHOD("set_travel_cost", "travel_cost"), &NavigationRegion2D::set_travel_cost);
ClassDB::bind_method(D_METHOD("get_travel_cost"), &NavigationRegion2D::get_travel_cost); ClassDB::bind_method(D_METHOD("get_travel_cost"), &NavigationRegion2D::get_travel_cost);
ClassDB::bind_method(D_METHOD("_navpoly_changed"), &NavigationRegion2D::_navpoly_changed); ClassDB::bind_method(D_METHOD("_navigation_polygon_changed"), &NavigationRegion2D::_navigation_polygon_changed);
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "navpoly", PROPERTY_HINT_RESOURCE_TYPE, "NavigationPolygon"), "set_navigation_polygon", "get_navigation_polygon"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "navigation_polygon", PROPERTY_HINT_RESOURCE_TYPE, "NavigationPolygon"), "set_navigation_polygon", "get_navigation_polygon");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "enabled"), "set_enabled", "is_enabled"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "enabled"), "set_enabled", "is_enabled");
ADD_PROPERTY(PropertyInfo(Variant::INT, "navigation_layers", PROPERTY_HINT_LAYERS_2D_NAVIGATION), "set_navigation_layers", "get_navigation_layers"); ADD_PROPERTY(PropertyInfo(Variant::INT, "navigation_layers", PROPERTY_HINT_LAYERS_2D_NAVIGATION), "set_navigation_layers", "get_navigation_layers");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "enter_cost"), "set_enter_cost", "get_enter_cost"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "enter_cost"), "set_enter_cost", "get_enter_cost");

6
scene/2d/navigation_region_2d.h
View File

@ -41,9 +41,9 @@ class NavigationRegion2D : public Node2D {
uint32_t navigation_layers = 1; uint32_t navigation_layers = 1;
real_t enter_cost = 0.0; real_t enter_cost = 0.0;
real_t travel_cost = 1.0; real_t travel_cost = 1.0;
Ref<NavigationPolygon> navpoly; Ref<NavigationPolygon> navigation_polygon;
void _navpoly_changed(); void _navigation_polygon_changed();
void _map_changed(RID p_RID); void _map_changed(RID p_RID);
protected: protected:
@ -73,7 +73,7 @@ public:
void set_travel_cost(real_t p_travel_cost); void set_travel_cost(real_t p_travel_cost);
real_t get_travel_cost() const; real_t get_travel_cost() const;
void set_navigation_polygon(const Ref<NavigationPolygon> &p_navpoly); void set_navigation_polygon(const Ref<NavigationPolygon> &p_navigation_polygon);
Ref<NavigationPolygon> get_navigation_polygon() const; Ref<NavigationPolygon> get_navigation_polygon() const;
PackedStringArray get_configuration_warnings() const override; PackedStringArray get_configuration_warnings() const override;

8
scene/2d/tile_map.cpp
View File

@ -1728,10 +1728,10 @@ void TileMap::_navigation_update_dirty_quadrants(SelfList<TileMapQuadrant>::List
q.navigation_regions[E_cell].resize(tile_set->get_navigation_layers_count()); q.navigation_regions[E_cell].resize(tile_set->get_navigation_layers_count());
for (int layer_index = 0; layer_index < tile_set->get_navigation_layers_count(); layer_index++) { for (int layer_index = 0; layer_index < tile_set->get_navigation_layers_count(); layer_index++) {
Ref<NavigationPolygon> navpoly; Ref<NavigationPolygon> navigation_polygon;
navpoly = tile_data->get_navigation_polygon(layer_index); navigation_polygon = tile_data->get_navigation_polygon(layer_index);
if (navpoly.is_valid()) { if (navigation_polygon.is_valid()) {
Transform2D tile_transform; Transform2D tile_transform;
tile_transform.set_origin(map_to_local(E_cell)); tile_transform.set_origin(map_to_local(E_cell));
@ -1739,7 +1739,7 @@ void TileMap::_navigation_update_dirty_quadrants(SelfList<TileMapQuadrant>::List
NavigationServer2D::get_singleton()->region_set_owner_id(region, get_instance_id()); NavigationServer2D::get_singleton()->region_set_owner_id(region, get_instance_id());
NavigationServer2D::get_singleton()->region_set_map(region, get_world_2d()->get_navigation_map()); NavigationServer2D::get_singleton()->region_set_map(region, get_world_2d()->get_navigation_map());
NavigationServer2D::get_singleton()->region_set_transform(region, tilemap_xform * tile_transform); NavigationServer2D::get_singleton()->region_set_transform(region, tilemap_xform * tile_transform);
NavigationServer2D::get_singleton()->region_set_navpoly(region, navpoly); NavigationServer2D::get_singleton()->region_set_navigation_polygon(region, navigation_polygon);
q.navigation_regions[E_cell].write[layer_index] = region; q.navigation_regions[E_cell].write[layer_index] = region;
} }
} }

24
scene/3d/navigation_agent_3d.cpp
View File

@ -83,8 +83,8 @@ void NavigationAgent3D::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_next_location"), &NavigationAgent3D::get_next_location); ClassDB::bind_method(D_METHOD("get_next_location"), &NavigationAgent3D::get_next_location);
ClassDB::bind_method(D_METHOD("distance_to_target"), &NavigationAgent3D::distance_to_target); ClassDB::bind_method(D_METHOD("distance_to_target"), &NavigationAgent3D::distance_to_target);
ClassDB::bind_method(D_METHOD("set_velocity", "velocity"), &NavigationAgent3D::set_velocity); ClassDB::bind_method(D_METHOD("set_velocity", "velocity"), &NavigationAgent3D::set_velocity);
ClassDB::bind_method(D_METHOD("get_nav_path"), &NavigationAgent3D::get_nav_path); ClassDB::bind_method(D_METHOD("get_current_navigation_path"), &NavigationAgent3D::get_current_navigation_path);
ClassDB::bind_method(D_METHOD("get_nav_path_index"), &NavigationAgent3D::get_nav_path_index); ClassDB::bind_method(D_METHOD("get_current_navigation_path_index"), &NavigationAgent3D::get_current_navigation_path_index);
ClassDB::bind_method(D_METHOD("is_target_reached"), &NavigationAgent3D::is_target_reached); ClassDB::bind_method(D_METHOD("is_target_reached"), &NavigationAgent3D::is_target_reached);
ClassDB::bind_method(D_METHOD("is_target_reachable"), &NavigationAgent3D::is_target_reachable); ClassDB::bind_method(D_METHOD("is_target_reachable"), &NavigationAgent3D::is_target_reachable);
ClassDB::bind_method(D_METHOD("is_navigation_finished"), &NavigationAgent3D::is_navigation_finished); ClassDB::bind_method(D_METHOD("is_navigation_finished"), &NavigationAgent3D::is_navigation_finished);
@ -345,11 +345,11 @@ Vector3 NavigationAgent3D::get_next_location() {
ERR_FAIL_COND_V_MSG(agent_parent == nullptr, Vector3(), "The agent has no parent."); ERR_FAIL_COND_V_MSG(agent_parent == nullptr, Vector3(), "The agent has no parent.");
return agent_parent->get_global_transform().origin; return agent_parent->get_global_transform().origin;
} else { } else {
return navigation_path[nav_path_index] - Vector3(0, navigation_height_offset, 0); return navigation_path[navigation_path_index] - Vector3(0, navigation_height_offset, 0);
} }
} }
const Vector<Vector3> &NavigationAgent3D::get_nav_path() const { const Vector<Vector3> &NavigationAgent3D::get_current_navigation_path() const {
return navigation_result->get_path(); return navigation_result->get_path();
} }
@ -433,12 +433,12 @@ void NavigationAgent3D::update_navigation() {
reload_path = true; reload_path = true;
} else { } else {
// Check if too far from the navigation path // Check if too far from the navigation path
if (nav_path_index > 0) { if (navigation_path_index > 0) {
const Vector<Vector3> &navigation_path = navigation_result->get_path(); const Vector<Vector3> &navigation_path = navigation_result->get_path();
Vector3 segment[2]; Vector3 segment[2];
segment[0] = navigation_path[nav_path_index - 1]; segment[0] = navigation_path[navigation_path_index - 1];
segment[1] = navigation_path[nav_path_index]; segment[1] = navigation_path[navigation_path_index];
segment[0].y -= navigation_height_offset; segment[0].y -= navigation_height_offset;
segment[1].y -= navigation_height_offset; segment[1].y -= navigation_height_offset;
Vector3 p = Geometry3D::get_closest_point_to_segment(origin, segment); Vector3 p = Geometry3D::get_closest_point_to_segment(origin, segment);
@ -462,7 +462,7 @@ void NavigationAgent3D::update_navigation() {
NavigationServer3D::get_singleton()->query_path(navigation_query, navigation_result); NavigationServer3D::get_singleton()->query_path(navigation_query, navigation_result);
navigation_finished = false; navigation_finished = false;
nav_path_index = 0; navigation_path_index = 0;
emit_signal(SNAME("path_changed")); emit_signal(SNAME("path_changed"));
} }
@ -474,11 +474,11 @@ void NavigationAgent3D::update_navigation() {
if (navigation_finished == false) { if (navigation_finished == false) {
// Advances to the next far away location. // Advances to the next far away location.
const Vector<Vector3> &navigation_path = navigation_result->get_path(); const Vector<Vector3> &navigation_path = navigation_result->get_path();
while (origin.distance_to(navigation_path[nav_path_index] - Vector3(0, navigation_height_offset, 0)) < path_desired_distance) { while (origin.distance_to(navigation_path[navigation_path_index] - Vector3(0, navigation_height_offset, 0)) < path_desired_distance) {
nav_path_index += 1; navigation_path_index += 1;
if (nav_path_index == navigation_path.size()) { if (navigation_path_index == navigation_path.size()) {
_check_distance_to_target(); _check_distance_to_target();
nav_path_index -= 1; navigation_path_index -= 1;
navigation_finished = true; navigation_finished = true;
emit_signal(SNAME("navigation_finished")); emit_signal(SNAME("navigation_finished"));
break; break;

8
scene/3d/navigation_agent_3d.h
View File

@ -64,7 +64,7 @@ class NavigationAgent3D : public Node {
Vector3 target_location; Vector3 target_location;
Ref<NavigationPathQueryParameters3D> navigation_query; Ref<NavigationPathQueryParameters3D> navigation_query;
Ref<NavigationPathQueryResult3D> navigation_result; Ref<NavigationPathQueryResult3D> navigation_result;
int nav_path_index = 0; int navigation_path_index = 0;
bool velocity_submitted = false; bool velocity_submitted = false;
Vector3 prev_safe_velocity; Vector3 prev_safe_velocity;
/// The submitted target velocity /// The submitted target velocity
@ -153,10 +153,10 @@ public:
Vector3 get_next_location(); Vector3 get_next_location();
const Vector<Vector3> &get_nav_path() const; const Vector<Vector3> &get_current_navigation_path() const;
int get_nav_path_index() const { int get_current_navigation_path_index() const {
return nav_path_index; return navigation_path_index;
} }
real_t distance_to_target() const; real_t distance_to_target() const;

44
scene/3d/navigation_region_3d.cpp
View File

@ -192,26 +192,26 @@ void NavigationRegion3D::_notification(int p_what) {
} }
} }
void NavigationRegion3D::set_navigation_mesh(const Ref<NavigationMesh> &p_navmesh) { void NavigationRegion3D::set_navigation_mesh(const Ref<NavigationMesh> &p_navigation_mesh) {
if (p_navmesh == navmesh) { if (p_navigation_mesh == navigation_mesh) {
return; return;
} }
if (navmesh.is_valid()) { if (navigation_mesh.is_valid()) {
navmesh->disconnect("changed", callable_mp(this, &NavigationRegion3D::_navigation_changed)); navigation_mesh->disconnect("changed", callable_mp(this, &NavigationRegion3D::_navigation_changed));
} }
navmesh = p_navmesh; navigation_mesh = p_navigation_mesh;
if (navmesh.is_valid()) { if (navigation_mesh.is_valid()) {
navmesh->connect("changed", callable_mp(this, &NavigationRegion3D::_navigation_changed)); navigation_mesh->connect("changed", callable_mp(this, &NavigationRegion3D::_navigation_changed));
} }
NavigationServer3D::get_singleton()->region_set_navmesh(region, p_navmesh); NavigationServer3D::get_singleton()->region_set_navigation_mesh(region, p_navigation_mesh);
#ifdef DEBUG_ENABLED #ifdef DEBUG_ENABLED
if (is_inside_tree() && NavigationServer3D::get_singleton()->get_debug_enabled()) { if (is_inside_tree() && NavigationServer3D::get_singleton()->get_debug_enabled()) {
if (navmesh.is_valid()) { if (navigation_mesh.is_valid()) {
_update_debug_mesh(); _update_debug_mesh();
_update_debug_edge_connections_mesh(); _update_debug_edge_connections_mesh();
} else { } else {
@ -232,7 +232,7 @@ void NavigationRegion3D::set_navigation_mesh(const Ref<NavigationMesh> &p_navmes
} }
Ref<NavigationMesh> NavigationRegion3D::get_navigation_mesh() const { Ref<NavigationMesh> NavigationRegion3D::get_navigation_mesh() const {
return navmesh; return navigation_mesh;
} }
struct BakeThreadsArgs { struct BakeThreadsArgs {
@ -245,7 +245,7 @@ void _bake_navigation_mesh(void *p_user_data) {
if (args->nav_region->get_navigation_mesh().is_valid()) { if (args->nav_region->get_navigation_mesh().is_valid()) {
Ref<NavigationMesh> nav_mesh = args->nav_region->get_navigation_mesh()->duplicate(); Ref<NavigationMesh> nav_mesh = args->nav_region->get_navigation_mesh()->duplicate();
NavigationServer3D::get_singleton()->region_bake_navmesh(nav_mesh, args->nav_region); NavigationServer3D::get_singleton()->region_bake_navigation_mesh(nav_mesh, args->nav_region);
args->nav_region->call_deferred(SNAME("_bake_finished"), nav_mesh); args->nav_region->call_deferred(SNAME("_bake_finished"), nav_mesh);
memdelete(args); memdelete(args);
} else { } else {
@ -278,7 +278,7 @@ PackedStringArray NavigationRegion3D::get_configuration_warnings() const {
PackedStringArray warnings = Node::get_configuration_warnings(); PackedStringArray warnings = Node::get_configuration_warnings();
if (is_visible_in_tree() && is_inside_tree()) { if (is_visible_in_tree() && is_inside_tree()) {
if (!navmesh.is_valid()) { if (!navigation_mesh.is_valid()) {
warnings.push_back(RTR("A NavigationMesh resource must be set or created for this node to work.")); warnings.push_back(RTR("A NavigationMesh resource must be set or created for this node to work."));
} }
} }
@ -287,7 +287,7 @@ PackedStringArray NavigationRegion3D::get_configuration_warnings() const {
} }
void NavigationRegion3D::_bind_methods() { void NavigationRegion3D::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_navigation_mesh", "navmesh"), &NavigationRegion3D::set_navigation_mesh); ClassDB::bind_method(D_METHOD("set_navigation_mesh", "navigation_mesh"), &NavigationRegion3D::set_navigation_mesh);
ClassDB::bind_method(D_METHOD("get_navigation_mesh"), &NavigationRegion3D::get_navigation_mesh); ClassDB::bind_method(D_METHOD("get_navigation_mesh"), &NavigationRegion3D::get_navigation_mesh);
ClassDB::bind_method(D_METHOD("set_enabled", "enabled"), &NavigationRegion3D::set_enabled); ClassDB::bind_method(D_METHOD("set_enabled", "enabled"), &NavigationRegion3D::set_enabled);
@ -308,9 +308,9 @@ void NavigationRegion3D::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_travel_cost"), &NavigationRegion3D::get_travel_cost); ClassDB::bind_method(D_METHOD("get_travel_cost"), &NavigationRegion3D::get_travel_cost);
ClassDB::bind_method(D_METHOD("bake_navigation_mesh", "on_thread"), &NavigationRegion3D::bake_navigation_mesh, DEFVAL(true)); ClassDB::bind_method(D_METHOD("bake_navigation_mesh", "on_thread"), &NavigationRegion3D::bake_navigation_mesh, DEFVAL(true));
ClassDB::bind_method(D_METHOD("_bake_finished", "nav_mesh"), &NavigationRegion3D::_bake_finished); ClassDB::bind_method(D_METHOD("_bake_finished", "navigation_mesh"), &NavigationRegion3D::_bake_finished);
ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "navmesh", PROPERTY_HINT_RESOURCE_TYPE, "NavigationMesh"), "set_navigation_mesh", "get_navigation_mesh"); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "navigation_mesh", PROPERTY_HINT_RESOURCE_TYPE, "NavigationMesh"), "set_navigation_mesh", "get_navigation_mesh");
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "enabled"), "set_enabled", "is_enabled"); ADD_PROPERTY(PropertyInfo(Variant::BOOL, "enabled"), "set_enabled", "is_enabled");
ADD_PROPERTY(PropertyInfo(Variant::INT, "navigation_layers", PROPERTY_HINT_LAYERS_3D_NAVIGATION), "set_navigation_layers", "get_navigation_layers"); ADD_PROPERTY(PropertyInfo(Variant::INT, "navigation_layers", PROPERTY_HINT_LAYERS_3D_NAVIGATION), "set_navigation_layers", "get_navigation_layers");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "enter_cost"), "set_enter_cost", "get_enter_cost"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "enter_cost"), "set_enter_cost", "get_enter_cost");
@ -353,8 +353,8 @@ NavigationRegion3D::NavigationRegion3D() {
} }
NavigationRegion3D::~NavigationRegion3D() { NavigationRegion3D::~NavigationRegion3D() {
if (navmesh.is_valid()) { if (navigation_mesh.is_valid()) {
navmesh->disconnect("changed", callable_mp(this, &NavigationRegion3D::_navigation_changed)); navigation_mesh->disconnect("changed", callable_mp(this, &NavigationRegion3D::_navigation_changed));
} }
NavigationServer3D::get_singleton()->free(region); NavigationServer3D::get_singleton()->free(region);
@ -392,7 +392,7 @@ void NavigationRegion3D::_update_debug_mesh() {
return; return;
} }
if (!navmesh.is_valid()) { if (!navigation_mesh.is_valid()) {
if (debug_instance.is_valid()) { if (debug_instance.is_valid()) {
RS::get_singleton()->instance_set_visible(debug_instance, false); RS::get_singleton()->instance_set_visible(debug_instance, false);
} }
@ -412,12 +412,12 @@ void NavigationRegion3D::_update_debug_mesh() {
bool enabled_geometry_face_random_color = NavigationServer3D::get_singleton()->get_debug_navigation_enable_geometry_face_random_color(); bool enabled_geometry_face_random_color = NavigationServer3D::get_singleton()->get_debug_navigation_enable_geometry_face_random_color();
bool enabled_edge_lines = NavigationServer3D::get_singleton()->get_debug_navigation_enable_edge_lines(); bool enabled_edge_lines = NavigationServer3D::get_singleton()->get_debug_navigation_enable_edge_lines();
Vector<Vector3> vertices = navmesh->get_vertices(); Vector<Vector3> vertices = navigation_mesh->get_vertices();
if (vertices.size() == 0) { if (vertices.size() == 0) {
return; return;
} }
int polygon_count = navmesh->get_polygon_count(); int polygon_count = navigation_mesh->get_polygon_count();
if (polygon_count == 0) { if (polygon_count == 0) {
return; return;
} }
@ -450,7 +450,7 @@ void NavigationRegion3D::_update_debug_mesh() {
polygon_color.a = debug_navigation_geometry_face_color.a; polygon_color.a = debug_navigation_geometry_face_color.a;
} }
Vector<int> polygon = navmesh->get_polygon(i); Vector<int> polygon = navigation_mesh->get_polygon(i);
face_vertex_array.push_back(vertices[polygon[0]]); face_vertex_array.push_back(vertices[polygon[0]]);
face_vertex_array.push_back(vertices[polygon[1]]); face_vertex_array.push_back(vertices[polygon[1]]);
@ -528,7 +528,7 @@ void NavigationRegion3D::_update_debug_edge_connections_mesh() {
return; return;
} }
if (!navmesh.is_valid()) { if (!navigation_mesh.is_valid()) {
if (debug_edge_connections_instance.is_valid()) { if (debug_edge_connections_instance.is_valid()) {
RS::get_singleton()->instance_set_visible(debug_edge_connections_instance, false); RS::get_singleton()->instance_set_visible(debug_edge_connections_instance, false);
} }

6
scene/3d/navigation_region_3d.h
View File

@ -42,7 +42,7 @@ class NavigationRegion3D : public Node3D {
uint32_t navigation_layers = 1; uint32_t navigation_layers = 1;
real_t enter_cost = 0.0; real_t enter_cost = 0.0;
real_t travel_cost = 1.0; real_t travel_cost = 1.0;
Ref<NavigationMesh> navmesh; Ref<NavigationMesh> navigation_mesh;
Thread bake_thread; Thread bake_thread;
@ -82,13 +82,13 @@ public:
void set_travel_cost(real_t p_travel_cost); void set_travel_cost(real_t p_travel_cost);
real_t get_travel_cost() const; real_t get_travel_cost() const;
void set_navigation_mesh(const Ref<NavigationMesh> &p_navmesh); void set_navigation_mesh(const Ref<NavigationMesh> &p_navigation_mesh);
Ref<NavigationMesh> get_navigation_mesh() const; Ref<NavigationMesh> get_navigation_mesh() const;
/// Bakes the navigation mesh; once done, automatically /// Bakes the navigation mesh; once done, automatically
/// sets the new navigation mesh and emits a signal /// sets the new navigation mesh and emits a signal
void bake_navigation_mesh(bool p_on_thread); void bake_navigation_mesh(bool p_on_thread);
void _bake_finished(Ref<NavigationMesh> p_nav_mesh); void _bake_finished(Ref<NavigationMesh> p_navigation_mesh);
PackedStringArray get_configuration_warnings() const override; PackedStringArray get_configuration_warnings() const override;

44
scene/resources/mesh_library.cpp
View File

@ -57,10 +57,10 @@ bool MeshLibrary::_set(const StringName &p_name, const Variant &p_value) {
_set_item_shapes(idx, p_value); _set_item_shapes(idx, p_value);
} else if (what == "preview") { } else if (what == "preview") {
set_item_preview(idx, p_value); set_item_preview(idx, p_value);
} else if (what == "navmesh") { } else if (what == "navigation_mesh") {
set_item_navmesh(idx, p_value); set_item_navigation_mesh(idx, p_value);
} else if (what == "navmesh_transform") { } else if (what == "navigation_mesh_transform") {
set_item_navmesh_transform(idx, p_value); set_item_navigation_mesh_transform(idx, p_value);
} else { } else {
return false; return false;
} }
@ -85,10 +85,10 @@ bool MeshLibrary::_get(const StringName &p_name, Variant &r_ret) const {
r_ret = get_item_mesh_transform(idx); r_ret = get_item_mesh_transform(idx);
} else if (what == "shapes") { } else if (what == "shapes") {
r_ret = _get_item_shapes(idx); r_ret = _get_item_shapes(idx);
} else if (what == "navmesh") { } else if (what == "navigation_mesh") {
r_ret = get_item_navmesh(idx); r_ret = get_item_navigation_mesh(idx);
} else if (what == "navmesh_transform") { } else if (what == "navigation_mesh_transform") {
r_ret = get_item_navmesh_transform(idx); r_ret = get_item_navigation_mesh_transform(idx);
} else if (what == "preview") { } else if (what == "preview") {
r_ret = get_item_preview(idx); r_ret = get_item_preview(idx);
} else { } else {
@ -105,8 +105,8 @@ void MeshLibrary::_get_property_list(List<PropertyInfo> *p_list) const {
p_list->push_back(PropertyInfo(Variant::OBJECT, prop_name + PNAME("mesh"), PROPERTY_HINT_RESOURCE_TYPE, "Mesh")); p_list->push_back(PropertyInfo(Variant::OBJECT, prop_name + PNAME("mesh"), PROPERTY_HINT_RESOURCE_TYPE, "Mesh"));
p_list->push_back(PropertyInfo(Variant::TRANSFORM3D, prop_name + PNAME("mesh_transform"), PROPERTY_HINT_NONE, "suffix:m")); p_list->push_back(PropertyInfo(Variant::TRANSFORM3D, prop_name + PNAME("mesh_transform"), PROPERTY_HINT_NONE, "suffix:m"));
p_list->push_back(PropertyInfo(Variant::ARRAY, prop_name + PNAME("shapes"))); p_list->push_back(PropertyInfo(Variant::ARRAY, prop_name + PNAME("shapes")));
p_list->push_back(PropertyInfo(Variant::OBJECT, prop_name + PNAME("navmesh"), PROPERTY_HINT_RESOURCE_TYPE, "NavigationMesh")); p_list->push_back(PropertyInfo(Variant::OBJECT, prop_name + PNAME("navigation_mesh"), PROPERTY_HINT_RESOURCE_TYPE, "NavigationMesh"));
p_list->push_back(PropertyInfo(Variant::TRANSFORM3D, prop_name + PNAME("navmesh_transform"), PROPERTY_HINT_NONE, "suffix:m")); p_list->push_back(PropertyInfo(Variant::TRANSFORM3D, prop_name + PNAME("navigation_mesh_transform"), PROPERTY_HINT_NONE, "suffix:m"));
p_list->push_back(PropertyInfo(Variant::OBJECT, prop_name + PNAME("preview"), PROPERTY_HINT_RESOURCE_TYPE, "Texture2D", PROPERTY_USAGE_DEFAULT)); p_list->push_back(PropertyInfo(Variant::OBJECT, prop_name + PNAME("preview"), PROPERTY_HINT_RESOURCE_TYPE, "Texture2D", PROPERTY_USAGE_DEFAULT));
} }
} }
@ -150,18 +150,18 @@ void MeshLibrary::set_item_shapes(int p_item, const Vector<ShapeData> &p_shapes)
notify_property_list_changed(); notify_property_list_changed();
} }
void MeshLibrary::set_item_navmesh(int p_item, const Ref<NavigationMesh> &p_navmesh) { void MeshLibrary::set_item_navigation_mesh(int p_item, const Ref<NavigationMesh> &p_navigation_mesh) {
ERR_FAIL_COND_MSG(!item_map.has(p_item), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'."); ERR_FAIL_COND_MSG(!item_map.has(p_item), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'.");
item_map[p_item].navmesh = p_navmesh; item_map[p_item].navigation_mesh = p_navigation_mesh;
notify_property_list_changed(); notify_property_list_changed();
notify_change_to_owners(); notify_change_to_owners();
emit_changed(); emit_changed();
notify_property_list_changed(); notify_property_list_changed();
} }
void MeshLibrary::set_item_navmesh_transform(int p_item, const Transform3D &p_transform) { void MeshLibrary::set_item_navigation_mesh_transform(int p_item, const Transform3D &p_transform) {
ERR_FAIL_COND_MSG(!item_map.has(p_item), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'."); ERR_FAIL_COND_MSG(!item_map.has(p_item), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'.");
item_map[p_item].navmesh_transform = p_transform; item_map[p_item].navigation_mesh_transform = p_transform;
notify_change_to_owners(); notify_change_to_owners();
emit_changed(); emit_changed();
notify_property_list_changed(); notify_property_list_changed();
@ -194,14 +194,14 @@ Vector<MeshLibrary::ShapeData> MeshLibrary::get_item_shapes(int p_item) const {
return item_map[p_item].shapes; return item_map[p_item].shapes;
} }
Ref<NavigationMesh> MeshLibrary::get_item_navmesh(int p_item) const { Ref<NavigationMesh> MeshLibrary::get_item_navigation_mesh(int p_item) const {
ERR_FAIL_COND_V_MSG(!item_map.has(p_item), Ref<NavigationMesh>(), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'."); ERR_FAIL_COND_V_MSG(!item_map.has(p_item), Ref<NavigationMesh>(), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'.");
return item_map[p_item].navmesh; return item_map[p_item].navigation_mesh;
} }
Transform3D MeshLibrary::get_item_navmesh_transform(int p_item) const { Transform3D MeshLibrary::get_item_navigation_mesh_transform(int p_item) const {
ERR_FAIL_COND_V_MSG(!item_map.has(p_item), Transform3D(), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'."); ERR_FAIL_COND_V_MSG(!item_map.has(p_item), Transform3D(), "Requested for nonexistent MeshLibrary item '" + itos(p_item) + "'.");
return item_map[p_item].navmesh_transform; return item_map[p_item].navigation_mesh_transform;
} }
Ref<Texture2D> MeshLibrary::get_item_preview(int p_item) const { Ref<Texture2D> MeshLibrary::get_item_preview(int p_item) const {
@ -314,15 +314,15 @@ void MeshLibrary::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_item_name", "id", "name"), &MeshLibrary::set_item_name); ClassDB::bind_method(D_METHOD("set_item_name", "id", "name"), &MeshLibrary::set_item_name);
ClassDB::bind_method(D_METHOD("set_item_mesh", "id", "mesh"), &MeshLibrary::set_item_mesh); ClassDB::bind_method(D_METHOD("set_item_mesh", "id", "mesh"), &MeshLibrary::set_item_mesh);
ClassDB::bind_method(D_METHOD("set_item_mesh_transform", "id", "mesh_transform"), &MeshLibrary::set_item_mesh_transform); ClassDB::bind_method(D_METHOD("set_item_mesh_transform", "id", "mesh_transform"), &MeshLibrary::set_item_mesh_transform);
ClassDB::bind_method(D_METHOD("set_item_navmesh", "id", "navmesh"), &MeshLibrary::set_item_navmesh); ClassDB::bind_method(D_METHOD("set_item_navigation_mesh", "id", "navigation_mesh"), &MeshLibrary::set_item_navigation_mesh);
ClassDB::bind_method(D_METHOD("set_item_navmesh_transform", "id", "navmesh"), &MeshLibrary::set_item_navmesh_transform); ClassDB::bind_method(D_METHOD("set_item_navigation_mesh_transform", "id", "navigation_mesh"), &MeshLibrary::set_item_navigation_mesh_transform);
ClassDB::bind_method(D_METHOD("set_item_shapes", "id", "shapes"), &MeshLibrary::_set_item_shapes); ClassDB::bind_method(D_METHOD("set_item_shapes", "id", "shapes"), &MeshLibrary::_set_item_shapes);
ClassDB::bind_method(D_METHOD("set_item_preview", "id", "texture"), &MeshLibrary::set_item_preview); ClassDB::bind_method(D_METHOD("set_item_preview", "id", "texture"), &MeshLibrary::set_item_preview);
ClassDB::bind_method(D_METHOD("get_item_name", "id"), &MeshLibrary::get_item_name); ClassDB::bind_method(D_METHOD("get_item_name", "id"), &MeshLibrary::get_item_name);
ClassDB::bind_method(D_METHOD("get_item_mesh", "id"), &MeshLibrary::get_item_mesh); ClassDB::bind_method(D_METHOD("get_item_mesh", "id"), &MeshLibrary::get_item_mesh);
ClassDB::bind_method(D_METHOD("get_item_mesh_transform", "id"), &MeshLibrary::get_item_mesh_transform); ClassDB::bind_method(D_METHOD("get_item_mesh_transform", "id"), &MeshLibrary::get_item_mesh_transform);
ClassDB::bind_method(D_METHOD("get_item_navmesh", "id"), &MeshLibrary::get_item_navmesh); ClassDB::bind_method(D_METHOD("get_item_navigation_mesh", "id"), &MeshLibrary::get_item_navigation_mesh);
ClassDB::bind_method(D_METHOD("get_item_navmesh_transform", "id"), &MeshLibrary::get_item_navmesh_transform); ClassDB::bind_method(D_METHOD("get_item_navigation_mesh_transform", "id"), &MeshLibrary::get_item_navigation_mesh_transform);
ClassDB::bind_method(D_METHOD("get_item_shapes", "id"), &MeshLibrary::_get_item_shapes); ClassDB::bind_method(D_METHOD("get_item_shapes", "id"), &MeshLibrary::_get_item_shapes);
ClassDB::bind_method(D_METHOD("get_item_preview", "id"), &MeshLibrary::get_item_preview); ClassDB::bind_method(D_METHOD("get_item_preview", "id"), &MeshLibrary::get_item_preview);
ClassDB::bind_method(D_METHOD("remove_item", "id"), &MeshLibrary::remove_item); ClassDB::bind_method(D_METHOD("remove_item", "id"), &MeshLibrary::remove_item);

14
scene/resources/mesh_library.h
View File

@ -49,11 +49,11 @@ public:
struct Item { struct Item {
String name; String name;
Ref<Mesh> mesh; Ref<Mesh> mesh;
Transform3D mesh_transform;
Vector<ShapeData> shapes; Vector<ShapeData> shapes;
Ref<Texture2D> preview; Ref<Texture2D> preview;
Transform3D navmesh_transform; Ref<NavigationMesh> navigation_mesh;
Transform3D mesh_transform; Transform3D navigation_mesh_transform;
Ref<NavigationMesh> navmesh;
}; };
RBMap<int, Item> item_map; RBMap<int, Item> item_map;
@ -74,15 +74,15 @@ public:
void set_item_name(int p_item, const String &p_name); void set_item_name(int p_item, const String &p_name);
void set_item_mesh(int p_item, const Ref<Mesh> &p_mesh); void set_item_mesh(int p_item, const Ref<Mesh> &p_mesh);
void set_item_mesh_transform(int p_item, const Transform3D &p_transform); void set_item_mesh_transform(int p_item, const Transform3D &p_transform);
void set_item_navmesh(int p_item, const Ref<NavigationMesh> &p_navmesh); void set_item_navigation_mesh(int p_item, const Ref<NavigationMesh> &p_navigation_mesh);
void set_item_navmesh_transform(int p_item, const Transform3D &p_transform); void set_item_navigation_mesh_transform(int p_item, const Transform3D &p_transform);
void set_item_shapes(int p_item, const Vector<ShapeData> &p_shapes); void set_item_shapes(int p_item, const Vector<ShapeData> &p_shapes);
void set_item_preview(int p_item, const Ref<Texture2D> &p_preview); void set_item_preview(int p_item, const Ref<Texture2D> &p_preview);
String get_item_name(int p_item) const; String get_item_name(int p_item) const;
Ref<Mesh> get_item_mesh(int p_item) const; Ref<Mesh> get_item_mesh(int p_item) const;
Transform3D get_item_mesh_transform(int p_item) const; Transform3D get_item_mesh_transform(int p_item) const;
Ref<NavigationMesh> get_item_navmesh(int p_item) const; Ref<NavigationMesh> get_item_navigation_mesh(int p_item) const;
Transform3D get_item_navmesh_transform(int p_item) const; Transform3D get_item_navigation_mesh_transform(int p_item) const;
Vector<ShapeData> get_item_shapes(int p_item) const; Vector<ShapeData> get_item_shapes(int p_item) const;
Ref<Texture2D> get_item_preview(int p_item) const; Ref<Texture2D> get_item_preview(int p_item) const;

22
scene/resources/navigation_mesh.cpp
View File

@ -225,13 +225,13 @@ float NavigationMesh::get_edge_max_error() const {
return edge_max_error; return edge_max_error;
} }
void NavigationMesh::set_verts_per_poly(float p_value) { void NavigationMesh::set_vertices_per_polyon(float p_value) {
ERR_FAIL_COND(p_value < 3); ERR_FAIL_COND(p_value < 3);
verts_per_poly = p_value; vertices_per_polyon = p_value;
} }
float NavigationMesh::get_verts_per_poly() const { float NavigationMesh::get_vertices_per_polyon() const {
return verts_per_poly; return vertices_per_polyon;
} }
void NavigationMesh::set_detail_sample_distance(float p_value) { void NavigationMesh::set_detail_sample_distance(float p_value) {
@ -483,8 +483,8 @@ void NavigationMesh::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_edge_max_error", "edge_max_error"), &NavigationMesh::set_edge_max_error); ClassDB::bind_method(D_METHOD("set_edge_max_error", "edge_max_error"), &NavigationMesh::set_edge_max_error);
ClassDB::bind_method(D_METHOD("get_edge_max_error"), &NavigationMesh::get_edge_max_error); ClassDB::bind_method(D_METHOD("get_edge_max_error"), &NavigationMesh::get_edge_max_error);
ClassDB::bind_method(D_METHOD("set_verts_per_poly", "verts_per_poly"), &NavigationMesh::set_verts_per_poly); ClassDB::bind_method(D_METHOD("set_vertices_per_polyon", "vertices_per_polyon"), &NavigationMesh::set_vertices_per_polyon);
ClassDB::bind_method(D_METHOD("get_verts_per_poly"), &NavigationMesh::get_verts_per_poly); ClassDB::bind_method(D_METHOD("get_vertices_per_polyon"), &NavigationMesh::get_vertices_per_polyon);
ClassDB::bind_method(D_METHOD("set_detail_sample_distance", "detail_sample_dist"), &NavigationMesh::set_detail_sample_distance); ClassDB::bind_method(D_METHOD("set_detail_sample_distance", "detail_sample_dist"), &NavigationMesh::set_detail_sample_distance);
ClassDB::bind_method(D_METHOD("get_detail_sample_distance"), &NavigationMesh::get_detail_sample_distance); ClassDB::bind_method(D_METHOD("get_detail_sample_distance"), &NavigationMesh::get_detail_sample_distance);
@ -527,9 +527,9 @@ void NavigationMesh::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::INT, "geometry_parsed_geometry_type", PROPERTY_HINT_ENUM, "Mesh Instances,Static Colliders,Both"), "set_parsed_geometry_type", "get_parsed_geometry_type"); ADD_PROPERTY(PropertyInfo(Variant::INT, "geometry_parsed_geometry_type", PROPERTY_HINT_ENUM, "Mesh Instances,Static Colliders,Both"), "set_parsed_geometry_type", "get_parsed_geometry_type");
ADD_PROPERTY(PropertyInfo(Variant::INT, "geometry_collision_mask", PROPERTY_HINT_LAYERS_3D_PHYSICS), "set_collision_mask", "get_collision_mask"); ADD_PROPERTY(PropertyInfo(Variant::INT, "geometry_collision_mask", PROPERTY_HINT_LAYERS_3D_PHYSICS), "set_collision_mask", "get_collision_mask");
ADD_PROPERTY_DEFAULT("geometry_collision_mask", 0xFFFFFFFF); ADD_PROPERTY_DEFAULT("geometry_collision_mask", 0xFFFFFFFF);
ADD_PROPERTY(PropertyInfo(Variant::INT, "geometry_source_geometry_mode", PROPERTY_HINT_ENUM, "NavMesh Children,Group With Children,Group Explicit"), "set_source_geometry_mode", "get_source_geometry_mode"); ADD_PROPERTY(PropertyInfo(Variant::INT, "geometry_source_geometry_mode", PROPERTY_HINT_ENUM, "Root Node Children,Group With Children,Group Explicit"), "set_source_geometry_mode", "get_source_geometry_mode");
ADD_PROPERTY(PropertyInfo(Variant::STRING, "geometry_source_group_name"), "set_source_group_name", "get_source_group_name"); ADD_PROPERTY(PropertyInfo(Variant::STRING, "geometry_source_group_name"), "set_source_group_name", "get_source_group_name");
ADD_PROPERTY_DEFAULT("geometry_source_group_name", StringName("navmesh")); ADD_PROPERTY_DEFAULT("geometry_source_group_name", StringName("navigation_mesh_source_group"));
ADD_GROUP("Cells", "cell_"); ADD_GROUP("Cells", "cell_");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "cell_size", PROPERTY_HINT_RANGE, "0.01,500.0,0.01,or_greater,suffix:m"), "set_cell_size", "get_cell_size"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "cell_size", PROPERTY_HINT_RANGE, "0.01,500.0,0.01,or_greater,suffix:m"), "set_cell_size", "get_cell_size");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "cell_height", PROPERTY_HINT_RANGE, "0.01,500.0,0.01,or_greater,suffix:m"), "set_cell_height", "get_cell_height"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "cell_height", PROPERTY_HINT_RANGE, "0.01,500.0,0.01,or_greater,suffix:m"), "set_cell_height", "get_cell_height");
@ -545,7 +545,7 @@ void NavigationMesh::_bind_methods() {
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "edge_max_length", PROPERTY_HINT_RANGE, "0.0,50.0,0.01,or_greater,suffix:m"), "set_edge_max_length", "get_edge_max_length"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "edge_max_length", PROPERTY_HINT_RANGE, "0.0,50.0,0.01,or_greater,suffix:m"), "set_edge_max_length", "get_edge_max_length");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "edge_max_error", PROPERTY_HINT_RANGE, "0.1,3.0,0.01,or_greater,suffix:m"), "set_edge_max_error", "get_edge_max_error"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "edge_max_error", PROPERTY_HINT_RANGE, "0.1,3.0,0.01,or_greater,suffix:m"), "set_edge_max_error", "get_edge_max_error");
ADD_GROUP("Polygons", "polygon_"); ADD_GROUP("Polygons", "polygon_");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "polygon_verts_per_poly", PROPERTY_HINT_RANGE, "3.0,12.0,1.0,or_greater"), "set_verts_per_poly", "get_verts_per_poly"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "polygon_vertices_per_polyon", PROPERTY_HINT_RANGE, "3.0,12.0,1.0,or_greater"), "set_vertices_per_polyon", "get_vertices_per_polyon");
ADD_GROUP("Details", "detail_"); ADD_GROUP("Details", "detail_");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "detail_sample_distance", PROPERTY_HINT_RANGE, "0.1,16.0,0.01,or_greater,suffix:m"), "set_detail_sample_distance", "get_detail_sample_distance"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "detail_sample_distance", PROPERTY_HINT_RANGE, "0.1,16.0,0.01,or_greater,suffix:m"), "set_detail_sample_distance", "get_detail_sample_distance");
ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "detail_sample_max_error", PROPERTY_HINT_RANGE, "0.0,16.0,0.01,or_greater,suffix:m"), "set_detail_sample_max_error", "get_detail_sample_max_error"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "detail_sample_max_error", PROPERTY_HINT_RANGE, "0.0,16.0,0.01,or_greater,suffix:m"), "set_detail_sample_max_error", "get_detail_sample_max_error");
@ -566,7 +566,7 @@ void NavigationMesh::_bind_methods() {
BIND_ENUM_CONSTANT(PARSED_GEOMETRY_BOTH); BIND_ENUM_CONSTANT(PARSED_GEOMETRY_BOTH);
BIND_ENUM_CONSTANT(PARSED_GEOMETRY_MAX); BIND_ENUM_CONSTANT(PARSED_GEOMETRY_MAX);
BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_NAVMESH_CHILDREN); BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_ROOT_NODE_CHILDREN);
BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN); BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN);
BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_GROUPS_EXPLICIT); BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_GROUPS_EXPLICIT);
BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_MAX); BIND_ENUM_CONSTANT(SOURCE_GEOMETRY_MAX);
@ -581,7 +581,7 @@ void NavigationMesh::_validate_property(PropertyInfo &p_property) const {
} }
if (p_property.name == "geometry_source_group_name") { if (p_property.name == "geometry_source_group_name") {
if (source_geometry_mode == SOURCE_GEOMETRY_NAVMESH_CHILDREN) { if (source_geometry_mode == SOURCE_GEOMETRY_ROOT_NODE_CHILDREN) {
p_property.usage = PROPERTY_USAGE_NONE; p_property.usage = PROPERTY_USAGE_NONE;
return; return;
} }

12
scene/resources/navigation_mesh.h
View File

@ -84,7 +84,7 @@ public:
}; };
enum SourceGeometryMode { enum SourceGeometryMode {
SOURCE_GEOMETRY_NAVMESH_CHILDREN = 0, SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0,
SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN, SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN,
SOURCE_GEOMETRY_GROUPS_EXPLICIT, SOURCE_GEOMETRY_GROUPS_EXPLICIT,
SOURCE_GEOMETRY_MAX SOURCE_GEOMETRY_MAX
@ -101,7 +101,7 @@ protected:
float region_merge_size = 20.0f; float region_merge_size = 20.0f;
float edge_max_length = 12.0f; float edge_max_length = 12.0f;
float edge_max_error = 1.3f; float edge_max_error = 1.3f;
float verts_per_poly = 6.0f; float vertices_per_polyon = 6.0f;
float detail_sample_distance = 6.0f; float detail_sample_distance = 6.0f;
float detail_sample_max_error = 1.0f; float detail_sample_max_error = 1.0f;
@ -109,8 +109,8 @@ protected:
ParsedGeometryType parsed_geometry_type = PARSED_GEOMETRY_MESH_INSTANCES; ParsedGeometryType parsed_geometry_type = PARSED_GEOMETRY_MESH_INSTANCES;
uint32_t collision_mask = 0xFFFFFFFF; uint32_t collision_mask = 0xFFFFFFFF;
SourceGeometryMode source_geometry_mode = SOURCE_GEOMETRY_NAVMESH_CHILDREN; SourceGeometryMode source_geometry_mode = SOURCE_GEOMETRY_ROOT_NODE_CHILDREN;
StringName source_group_name = "navmesh"; StringName source_group_name = "navigation_mesh_source_group";
bool filter_low_hanging_obstacles = false; bool filter_low_hanging_obstacles = false;
bool filter_ledge_spans = false; bool filter_ledge_spans = false;
@ -168,8 +168,8 @@ public:
void set_edge_max_error(float p_value); void set_edge_max_error(float p_value);
float get_edge_max_error() const; float get_edge_max_error() const;
void set_verts_per_poly(float p_value); void set_vertices_per_polyon(float p_value);
float get_verts_per_poly() const; float get_vertices_per_polyon() const;
void set_detail_sample_distance(float p_value); void set_detail_sample_distance(float p_value);
float get_detail_sample_distance() const; float get_detail_sample_distance() const;

36
scene/resources/navigation_polygon.cpp
View File

@ -81,8 +81,8 @@ bool NavigationPolygon::_edit_is_selected_on_click(const Point2 &p_point, double
void NavigationPolygon::set_vertices(const Vector<Vector2> &p_vertices) { void NavigationPolygon::set_vertices(const Vector<Vector2> &p_vertices) {
{ {
MutexLock lock(navmesh_generation); MutexLock lock(navigation_mesh_generation);
navmesh.unref(); navigation_mesh.unref();
} }
vertices = p_vertices; vertices = p_vertices;
rect_cache_dirty = true; rect_cache_dirty = true;
@ -94,8 +94,8 @@ Vector<Vector2> NavigationPolygon::get_vertices() const {
void NavigationPolygon::_set_polygons(const TypedArray<Vector<int32_t>> &p_array) { void NavigationPolygon::_set_polygons(const TypedArray<Vector<int32_t>> &p_array) {
{ {
MutexLock lock(navmesh_generation); MutexLock lock(navigation_mesh_generation);
navmesh.unref(); navigation_mesh.unref();
} }
polygons.resize(p_array.size()); polygons.resize(p_array.size());
for (int i = 0; i < p_array.size(); i++) { for (int i = 0; i < p_array.size(); i++) {
@ -136,8 +136,8 @@ void NavigationPolygon::add_polygon(const Vector<int> &p_polygon) {
polygon.indices = p_polygon; polygon.indices = p_polygon;
polygons.push_back(polygon); polygons.push_back(polygon);
{ {
MutexLock lock(navmesh_generation); MutexLock lock(navigation_mesh_generation);
navmesh.unref(); navigation_mesh.unref();
} }
} }
@ -158,16 +158,16 @@ Vector<int> NavigationPolygon::get_polygon(int p_idx) {
void NavigationPolygon::clear_polygons() { void NavigationPolygon::clear_polygons() {
polygons.clear(); polygons.clear();
{ {
MutexLock lock(navmesh_generation); MutexLock lock(navigation_mesh_generation);
navmesh.unref(); navigation_mesh.unref();
} }
} }
Ref<NavigationMesh> NavigationPolygon::get_mesh() { Ref<NavigationMesh> NavigationPolygon::get_navigation_mesh() {
MutexLock lock(navmesh_generation); MutexLock lock(navigation_mesh_generation);
if (navmesh.is_null()) { if (navigation_mesh.is_null()) {
navmesh.instantiate(); navigation_mesh.instantiate();
Vector<Vector3> verts; Vector<Vector3> verts;
{ {
verts.resize(get_vertices().size()); verts.resize(get_vertices().size());
@ -179,14 +179,14 @@ Ref<NavigationMesh> NavigationPolygon::get_mesh() {
w[i] = Vector3(r[i].x, 0.0, r[i].y); w[i] = Vector3(r[i].x, 0.0, r[i].y);
} }
} }
navmesh->set_vertices(verts); navigation_mesh->set_vertices(verts);
for (int i(0); i < get_polygon_count(); i++) { for (int i(0); i < get_polygon_count(); i++) {
navmesh->add_polygon(get_polygon(i)); navigation_mesh->add_polygon(get_polygon(i));
} }
} }
return navmesh; return navigation_mesh;
} }
void NavigationPolygon::add_outline(const Vector<Vector2> &p_outline) { void NavigationPolygon::add_outline(const Vector<Vector2> &p_outline) {
@ -222,8 +222,8 @@ void NavigationPolygon::clear_outlines() {
void NavigationPolygon::make_polygons_from_outlines() { void NavigationPolygon::make_polygons_from_outlines() {
{ {
MutexLock lock(navmesh_generation); MutexLock lock(navigation_mesh_generation);
navmesh.unref(); navigation_mesh.unref();
} }
List<TPPLPoly> in_poly, out_poly; List<TPPLPoly> in_poly, out_poly;
@ -331,7 +331,7 @@ void NavigationPolygon::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_polygon_count"), &NavigationPolygon::get_polygon_count); ClassDB::bind_method(D_METHOD("get_polygon_count"), &NavigationPolygon::get_polygon_count);
ClassDB::bind_method(D_METHOD("get_polygon", "idx"), &NavigationPolygon::get_polygon); ClassDB::bind_method(D_METHOD("get_polygon", "idx"), &NavigationPolygon::get_polygon);
ClassDB::bind_method(D_METHOD("clear_polygons"), &NavigationPolygon::clear_polygons); ClassDB::bind_method(D_METHOD("clear_polygons"), &NavigationPolygon::clear_polygons);
ClassDB::bind_method(D_METHOD("get_mesh"), &NavigationPolygon::get_mesh); ClassDB::bind_method(D_METHOD("get_navigation_mesh"), &NavigationPolygon::get_navigation_mesh);
ClassDB::bind_method(D_METHOD("add_outline", "outline"), &NavigationPolygon::add_outline); ClassDB::bind_method(D_METHOD("add_outline", "outline"), &NavigationPolygon::add_outline);
ClassDB::bind_method(D_METHOD("add_outline_at_index", "outline", "index"), &NavigationPolygon::add_outline_at_index); ClassDB::bind_method(D_METHOD("add_outline_at_index", "outline", "index"), &NavigationPolygon::add_outline_at_index);

6
scene/resources/navigation_polygon.h
View File

@ -47,9 +47,9 @@ class NavigationPolygon : public Resource {
mutable Rect2 item_rect; mutable Rect2 item_rect;
mutable bool rect_cache_dirty = true; mutable bool rect_cache_dirty = true;
Mutex navmesh_generation; Mutex navigation_mesh_generation;
// Navigation mesh // Navigation mesh
Ref<NavigationMesh> navmesh; Ref<NavigationMesh> navigation_mesh;
protected: protected:
static void _bind_methods(); static void _bind_methods();
@ -85,7 +85,7 @@ public:
Vector<int> get_polygon(int p_idx); Vector<int> get_polygon(int p_idx);
void clear_polygons(); void clear_polygons();
Ref<NavigationMesh> get_mesh(); Ref<NavigationMesh> get_navigation_mesh();
NavigationPolygon() {} NavigationPolygon() {}
~NavigationPolygon() {} ~NavigationPolygon() {}

8
servers/navigation_server_2d.cpp
View File

@ -154,7 +154,7 @@ static ObjectID id_to_id(const ObjectID &id) {
static Ref<NavigationMesh> poly_to_mesh(Ref<NavigationPolygon> d) { static Ref<NavigationMesh> poly_to_mesh(Ref<NavigationPolygon> d) {
if (d.is_valid()) { if (d.is_valid()) {
return d->get_mesh(); return d->get_navigation_mesh();
} else { } else {
return Ref<NavigationMesh>(); return Ref<NavigationMesh>();
} }
@ -258,7 +258,7 @@ void NavigationServer2D::_bind_methods() {
ClassDB::bind_method(D_METHOD("region_set_navigation_layers", "region", "navigation_layers"), &NavigationServer2D::region_set_navigation_layers); ClassDB::bind_method(D_METHOD("region_set_navigation_layers", "region", "navigation_layers"), &NavigationServer2D::region_set_navigation_layers);
ClassDB::bind_method(D_METHOD("region_get_navigation_layers", "region"), &NavigationServer2D::region_get_navigation_layers); ClassDB::bind_method(D_METHOD("region_get_navigation_layers", "region"), &NavigationServer2D::region_get_navigation_layers);
ClassDB::bind_method(D_METHOD("region_set_transform", "region", "transform"), &NavigationServer2D::region_set_transform); ClassDB::bind_method(D_METHOD("region_set_transform", "region", "transform"), &NavigationServer2D::region_set_transform);
ClassDB::bind_method(D_METHOD("region_set_navpoly", "region", "nav_poly"), &NavigationServer2D::region_set_navpoly); ClassDB::bind_method(D_METHOD("region_set_navigation_polygon", "region", "navigation_polygon"), &NavigationServer2D::region_set_navigation_polygon);
ClassDB::bind_method(D_METHOD("region_get_connections_count", "region"), &NavigationServer2D::region_get_connections_count); ClassDB::bind_method(D_METHOD("region_get_connections_count", "region"), &NavigationServer2D::region_get_connections_count);
ClassDB::bind_method(D_METHOD("region_get_connection_pathway_start", "region", "connection"), &NavigationServer2D::region_get_connection_pathway_start); ClassDB::bind_method(D_METHOD("region_get_connection_pathway_start", "region", "connection"), &NavigationServer2D::region_get_connection_pathway_start);
ClassDB::bind_method(D_METHOD("region_get_connection_pathway_end", "region", "connection"), &NavigationServer2D::region_get_connection_pathway_end); ClassDB::bind_method(D_METHOD("region_get_connection_pathway_end", "region", "connection"), &NavigationServer2D::region_get_connection_pathway_end);
@ -361,8 +361,8 @@ void FORWARD_2_C(region_set_navigation_layers, RID, p_region, uint32_t, p_naviga
uint32_t FORWARD_1_C(region_get_navigation_layers, RID, p_region, rid_to_rid); uint32_t FORWARD_1_C(region_get_navigation_layers, RID, p_region, rid_to_rid);
void FORWARD_2_C(region_set_transform, RID, p_region, Transform2D, p_transform, rid_to_rid, trf2_to_trf3); void FORWARD_2_C(region_set_transform, RID, p_region, Transform2D, p_transform, rid_to_rid, trf2_to_trf3);
void NavigationServer2D::region_set_navpoly(RID p_region, Ref<NavigationPolygon> p_nav_mesh) const { void NavigationServer2D::region_set_navigation_polygon(RID p_region, Ref<NavigationPolygon> p_navigation_polygon) const {
NavigationServer3D::get_singleton()->region_set_navmesh(p_region, poly_to_mesh(p_nav_mesh)); NavigationServer3D::get_singleton()->region_set_navigation_mesh(p_region, poly_to_mesh(p_navigation_polygon));
} }
int FORWARD_1_C(region_get_connections_count, RID, p_region, rid_to_rid); int FORWARD_1_C(region_get_connections_count, RID, p_region, rid_to_rid);

2
servers/navigation_server_2d.h
View File

@ -126,7 +126,7 @@ public:
virtual void region_set_transform(RID p_region, Transform2D p_transform) const; virtual void region_set_transform(RID p_region, Transform2D p_transform) const;
/// Set the navigation poly of this region. /// Set the navigation poly of this region.
virtual void region_set_navpoly(RID p_region, Ref<NavigationPolygon> p_nav_mesh) const; virtual void region_set_navigation_polygon(RID p_region, Ref<NavigationPolygon> p_navigation_polygon) const;
/// Get a list of a region's connection to other regions. /// Get a list of a region's connection to other regions.
virtual int region_get_connections_count(RID p_region) const; virtual int region_get_connections_count(RID p_region) const;

6
servers/navigation_server_3d.cpp
View File

@ -77,8 +77,8 @@ void NavigationServer3D::_bind_methods() {
ClassDB::bind_method(D_METHOD("region_set_navigation_layers", "region", "navigation_layers"), &NavigationServer3D::region_set_navigation_layers); ClassDB::bind_method(D_METHOD("region_set_navigation_layers", "region", "navigation_layers"), &NavigationServer3D::region_set_navigation_layers);
ClassDB::bind_method(D_METHOD("region_get_navigation_layers", "region"), &NavigationServer3D::region_get_navigation_layers); ClassDB::bind_method(D_METHOD("region_get_navigation_layers", "region"), &NavigationServer3D::region_get_navigation_layers);
ClassDB::bind_method(D_METHOD("region_set_transform", "region", "transform"), &NavigationServer3D::region_set_transform); ClassDB::bind_method(D_METHOD("region_set_transform", "region", "transform"), &NavigationServer3D::region_set_transform);
ClassDB::bind_method(D_METHOD("region_set_navmesh", "region", "nav_mesh"), &NavigationServer3D::region_set_navmesh); ClassDB::bind_method(D_METHOD("region_set_navigation_mesh", "region", "navigation_mesh"), &NavigationServer3D::region_set_navigation_mesh);
ClassDB::bind_method(D_METHOD("region_bake_navmesh", "mesh", "node"), &NavigationServer3D::region_bake_navmesh); ClassDB::bind_method(D_METHOD("region_bake_navigation_mesh", "navigation_mesh", "root_node"), &NavigationServer3D::region_bake_navigation_mesh);
ClassDB::bind_method(D_METHOD("region_get_connections_count", "region"), &NavigationServer3D::region_get_connections_count); ClassDB::bind_method(D_METHOD("region_get_connections_count", "region"), &NavigationServer3D::region_get_connections_count);
ClassDB::bind_method(D_METHOD("region_get_connection_pathway_start", "region", "connection"), &NavigationServer3D::region_get_connection_pathway_start); ClassDB::bind_method(D_METHOD("region_get_connection_pathway_start", "region", "connection"), &NavigationServer3D::region_get_connection_pathway_start);
ClassDB::bind_method(D_METHOD("region_get_connection_pathway_end", "region", "connection"), &NavigationServer3D::region_get_connection_pathway_end); ClassDB::bind_method(D_METHOD("region_get_connection_pathway_end", "region", "connection"), &NavigationServer3D::region_get_connection_pathway_end);
@ -155,7 +155,7 @@ NavigationServer3D::NavigationServer3D() {
debug_navigation_enable_link_connections_xray = GLOBAL_DEF("debug/shapes/navigation/enable_link_connections_xray", true); debug_navigation_enable_link_connections_xray = GLOBAL_DEF("debug/shapes/navigation/enable_link_connections_xray", true);
if (Engine::get_singleton()->is_editor_hint()) { if (Engine::get_singleton()->is_editor_hint()) {
// enable NavigationServer3D when in Editor or else navmesh edge connections are invisible // enable NavigationServer3D when in Editor or else navigation mesh edge connections are invisible
// on runtime tests SceneTree has "Visible Navigation" set and main iteration takes care of this // on runtime tests SceneTree has "Visible Navigation" set and main iteration takes care of this
set_debug_enabled(true); set_debug_enabled(true);
} }

4
servers/navigation_server_3d.h
View File

@ -138,10 +138,10 @@ public:
virtual void region_set_transform(RID p_region, Transform3D p_transform) const = 0; virtual void region_set_transform(RID p_region, Transform3D p_transform) const = 0;
/// Set the navigation mesh of this region. /// Set the navigation mesh of this region.
virtual void region_set_navmesh(RID p_region, Ref<NavigationMesh> p_nav_mesh) const = 0; virtual void region_set_navigation_mesh(RID p_region, Ref<NavigationMesh> p_navigation_mesh) const = 0;
/// Bake the navigation mesh. /// Bake the navigation mesh.
virtual void region_bake_navmesh(Ref<NavigationMesh> r_mesh, Node *p_node) const = 0; virtual void region_bake_navigation_mesh(Ref<NavigationMesh> p_navigation_mesh, Node *p_root_node) const = 0;
/// Get a list of a region's connection to other regions. /// Get a list of a region's connection to other regions.
virtual int region_get_connections_count(RID p_region) const = 0; virtual int region_get_connections_count(RID p_region) const = 0;