2023-01-05 13:25:55 +01:00
/**************************************************************************/
/* navigation_region_3d.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
2020-01-10 12:22:34 +01:00
2020-03-26 22:49:16 +01:00
# include "navigation_region_3d.h"
2020-03-30 18:22:57 +02:00
2020-03-26 22:49:16 +01:00
# include "mesh_instance_3d.h"
2020-03-27 19:21:27 +01:00
# include "servers/navigation_server_3d.h"
2020-01-10 12:22:34 +01:00
2020-03-26 22:49:16 +01:00
void NavigationRegion3D : : set_enabled ( bool p_enabled ) {
2020-05-14 16:41:43 +02:00
if ( enabled = = p_enabled ) {
2020-01-10 12:22:34 +01:00
return ;
2020-05-14 16:41:43 +02:00
}
2022-08-21 04:21:01 +02:00
2020-01-10 12:22:34 +01:00
enabled = p_enabled ;
2020-05-14 16:41:43 +02:00
if ( ! is_inside_tree ( ) ) {
2020-01-10 12:22:34 +01:00
return ;
2020-05-14 16:41:43 +02:00
}
2020-01-10 12:22:34 +01:00
if ( ! enabled ) {
2020-03-27 19:21:27 +01:00
NavigationServer3D : : get_singleton ( ) - > region_set_map ( region , RID ( ) ) ;
2020-01-10 12:22:34 +01:00
} else {
2021-03-08 09:47:18 +01:00
NavigationServer3D : : get_singleton ( ) - > region_set_map ( region , get_world_3d ( ) - > get_navigation_map ( ) ) ;
2020-01-10 12:22:34 +01:00
}
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
if ( debug_instance . is_valid ( ) ) {
if ( ! is_enabled ( ) ) {
if ( debug_mesh . is_valid ( ) ) {
if ( debug_mesh - > get_surface_count ( ) > 0 ) {
2022-12-21 23:21:43 +01:00
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 0 , NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_geometry_face_disabled_material ( ) - > get_rid ( ) ) ;
2022-07-01 18:58:03 +02:00
}
if ( debug_mesh - > get_surface_count ( ) > 1 ) {
2022-12-21 23:21:43 +01:00
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 1 , NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_geometry_edge_disabled_material ( ) - > get_rid ( ) ) ;
2022-07-01 18:58:03 +02:00
}
}
2020-01-10 12:22:34 +01:00
} else {
2022-07-01 18:58:03 +02:00
if ( debug_mesh . is_valid ( ) ) {
if ( debug_mesh - > get_surface_count ( ) > 0 ) {
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 0 , RID ( ) ) ;
}
if ( debug_mesh - > get_surface_count ( ) > 1 ) {
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 1 , RID ( ) ) ;
}
}
2020-01-10 12:22:34 +01:00
}
}
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED
2020-01-10 12:22:34 +01:00
2021-06-23 16:49:50 +02:00
update_gizmos ( ) ;
2020-01-10 12:22:34 +01:00
}
2020-03-26 22:49:16 +01:00
bool NavigationRegion3D : : is_enabled ( ) const {
2020-01-10 12:22:34 +01:00
return enabled ;
}
2023-04-01 01:49:43 +02:00
void NavigationRegion3D : : set_use_edge_connections ( bool p_enabled ) {
if ( use_edge_connections = = p_enabled ) {
return ;
}
use_edge_connections = p_enabled ;
NavigationServer3D : : get_singleton ( ) - > region_set_use_edge_connections ( region , use_edge_connections ) ;
}
bool NavigationRegion3D : : get_use_edge_connections ( ) const {
return use_edge_connections ;
}
2022-06-14 23:34:43 +02:00
void NavigationRegion3D : : set_navigation_layers ( uint32_t p_navigation_layers ) {
2022-08-21 04:21:01 +02:00
if ( navigation_layers = = p_navigation_layers ) {
return ;
}
navigation_layers = p_navigation_layers ;
NavigationServer3D : : get_singleton ( ) - > region_set_navigation_layers ( region , navigation_layers ) ;
2021-03-08 20:56:33 +01:00
}
2022-06-14 23:34:43 +02:00
uint32_t NavigationRegion3D : : get_navigation_layers ( ) const {
2022-08-21 04:21:01 +02:00
return navigation_layers ;
2021-03-08 20:56:33 +01:00
}
2022-06-19 13:23:13 +02:00
void NavigationRegion3D : : set_navigation_layer_value ( int p_layer_number , bool p_value ) {
ERR_FAIL_COND_MSG ( p_layer_number < 1 , " Navigation layer number must be between 1 and 32 inclusive. " ) ;
ERR_FAIL_COND_MSG ( p_layer_number > 32 , " Navigation layer number must be between 1 and 32 inclusive. " ) ;
2022-08-21 04:21:01 +02:00
2022-06-19 13:23:13 +02:00
uint32_t _navigation_layers = get_navigation_layers ( ) ;
2022-08-21 04:21:01 +02:00
2022-06-19 13:23:13 +02:00
if ( p_value ) {
_navigation_layers | = 1 < < ( p_layer_number - 1 ) ;
} else {
_navigation_layers & = ~ ( 1 < < ( p_layer_number - 1 ) ) ;
}
2022-08-21 04:21:01 +02:00
2022-06-19 13:23:13 +02:00
set_navigation_layers ( _navigation_layers ) ;
}
bool NavigationRegion3D : : get_navigation_layer_value ( int p_layer_number ) const {
ERR_FAIL_COND_V_MSG ( p_layer_number < 1 , false , " Navigation layer number must be between 1 and 32 inclusive. " ) ;
ERR_FAIL_COND_V_MSG ( p_layer_number > 32 , false , " Navigation layer number must be between 1 and 32 inclusive. " ) ;
2022-08-21 04:21:01 +02:00
2022-06-19 13:23:13 +02:00
return get_navigation_layers ( ) & ( 1 < < ( p_layer_number - 1 ) ) ;
}
2022-06-06 05:24:11 +02:00
void NavigationRegion3D : : set_enter_cost ( real_t p_enter_cost ) {
ERR_FAIL_COND_MSG ( p_enter_cost < 0.0 , " The enter_cost must be positive. " ) ;
2022-08-21 04:21:01 +02:00
if ( Math : : is_equal_approx ( enter_cost , p_enter_cost ) ) {
return ;
}
enter_cost = p_enter_cost ;
NavigationServer3D : : get_singleton ( ) - > region_set_enter_cost ( region , enter_cost ) ;
2022-06-06 05:24:11 +02:00
}
real_t NavigationRegion3D : : get_enter_cost ( ) const {
return enter_cost ;
}
void NavigationRegion3D : : set_travel_cost ( real_t p_travel_cost ) {
ERR_FAIL_COND_MSG ( p_travel_cost < 0.0 , " The travel_cost must be positive. " ) ;
2022-08-21 04:21:01 +02:00
if ( Math : : is_equal_approx ( travel_cost , p_travel_cost ) ) {
return ;
}
travel_cost = p_travel_cost ;
2022-08-07 19:40:33 +02:00
NavigationServer3D : : get_singleton ( ) - > region_set_travel_cost ( region , travel_cost ) ;
2022-06-06 05:24:11 +02:00
}
real_t NavigationRegion3D : : get_travel_cost ( ) const {
return travel_cost ;
}
2022-04-30 13:27:30 +02:00
RID NavigationRegion3D : : get_region_rid ( ) const {
return region ;
}
2020-03-26 22:49:16 +01:00
void NavigationRegion3D : : _notification ( int p_what ) {
2020-01-10 12:22:34 +01:00
switch ( p_what ) {
case NOTIFICATION_ENTER_TREE : {
2021-03-08 09:47:18 +01:00
if ( enabled ) {
NavigationServer3D : : get_singleton ( ) - > region_set_map ( region , get_world_3d ( ) - > get_navigation_map ( ) ) ;
2020-01-10 12:22:34 +01:00
}
2023-04-05 02:15:25 +02:00
current_global_transform = get_global_transform ( ) ;
NavigationServer3D : : get_singleton ( ) - > region_set_transform ( region , current_global_transform ) ;
2020-01-10 12:22:34 +01:00
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
2023-01-10 07:14:16 +01:00
if ( NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_enabled ( ) ) {
2022-07-01 18:58:03 +02:00
_update_debug_mesh ( ) ;
2020-01-10 12:22:34 +01:00
}
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED
2020-01-10 12:22:34 +01:00
} break ;
2022-02-15 18:06:48 +01:00
2020-01-10 12:22:34 +01:00
case NOTIFICATION_TRANSFORM_CHANGED : {
2023-04-05 02:15:25 +02:00
set_physics_process_internal ( true ) ;
2022-07-01 18:58:03 +02:00
2023-04-05 02:15:25 +02:00
} break ;
case NOTIFICATION_INTERNAL_PHYSICS_PROCESS : {
set_physics_process_internal ( false ) ;
if ( is_inside_tree ( ) ) {
Transform3D new_global_transform = get_global_transform ( ) ;
if ( current_global_transform ! = new_global_transform ) {
current_global_transform = new_global_transform ;
NavigationServer3D : : get_singleton ( ) - > region_set_transform ( region , current_global_transform ) ;
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
2023-04-05 02:15:25 +02:00
if ( debug_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_transform ( debug_instance , current_global_transform ) ;
}
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED
2023-04-05 02:15:25 +02:00
}
}
2020-01-10 12:22:34 +01:00
} break ;
2022-02-15 18:06:48 +01:00
2020-01-10 12:22:34 +01:00
case NOTIFICATION_EXIT_TREE : {
2021-03-08 09:47:18 +01:00
NavigationServer3D : : get_singleton ( ) - > region_set_map ( region , RID ( ) ) ;
2020-01-10 12:22:34 +01:00
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
if ( debug_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_instance , false ) ;
}
if ( debug_edge_connections_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , false ) ;
2020-01-10 12:22:34 +01:00
}
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED
2020-01-10 12:22:34 +01:00
} break ;
}
}
2022-12-11 18:02:35 +01:00
void NavigationRegion3D : : set_navigation_mesh ( const Ref < NavigationMesh > & p_navigation_mesh ) {
if ( p_navigation_mesh = = navigation_mesh ) {
2020-01-10 12:22:34 +01:00
return ;
2020-05-14 16:41:43 +02:00
}
2020-01-10 12:22:34 +01:00
2022-12-11 18:02:35 +01:00
if ( navigation_mesh . is_valid ( ) ) {
navigation_mesh - > disconnect ( " changed " , callable_mp ( this , & NavigationRegion3D : : _navigation_changed ) ) ;
2020-01-10 12:22:34 +01:00
}
2022-12-11 18:02:35 +01:00
navigation_mesh = p_navigation_mesh ;
2020-01-10 12:22:34 +01:00
2022-12-11 18:02:35 +01:00
if ( navigation_mesh . is_valid ( ) ) {
navigation_mesh - > connect ( " changed " , callable_mp ( this , & NavigationRegion3D : : _navigation_changed ) ) ;
2020-01-10 12:22:34 +01:00
}
2022-12-11 18:02:35 +01:00
NavigationServer3D : : get_singleton ( ) - > region_set_navigation_mesh ( region , p_navigation_mesh ) ;
2020-01-10 12:22:34 +01:00
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
2023-01-10 07:14:16 +01:00
if ( is_inside_tree ( ) & & NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_enabled ( ) ) {
2022-12-11 18:02:35 +01:00
if ( navigation_mesh . is_valid ( ) ) {
2022-07-01 18:58:03 +02:00
_update_debug_mesh ( ) ;
_update_debug_edge_connections_mesh ( ) ;
2022-06-02 10:55:19 +02:00
} else {
2022-07-01 18:58:03 +02:00
if ( debug_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_instance , false ) ;
}
if ( debug_edge_connections_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , false ) ;
}
2022-06-02 10:55:19 +02:00
}
2020-01-10 12:22:34 +01:00
}
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED
2020-01-10 12:22:34 +01:00
2021-07-17 23:22:52 +02:00
emit_signal ( SNAME ( " navigation_mesh_changed " ) ) ;
2020-01-10 12:22:34 +01:00
2021-06-23 16:49:50 +02:00
update_gizmos ( ) ;
2020-10-29 11:01:28 +01:00
update_configuration_warnings ( ) ;
2020-01-10 12:22:34 +01:00
}
2020-03-26 22:49:16 +01:00
Ref < NavigationMesh > NavigationRegion3D : : get_navigation_mesh ( ) const {
2022-12-11 18:02:35 +01:00
return navigation_mesh ;
2020-01-10 12:22:34 +01:00
}
struct BakeThreadsArgs {
2021-02-07 22:29:31 +01:00
NavigationRegion3D * nav_region = nullptr ;
2020-01-10 12:22:34 +01:00
} ;
void _bake_navigation_mesh ( void * p_user_data ) {
BakeThreadsArgs * args = static_cast < BakeThreadsArgs * > ( p_user_data ) ;
2020-03-08 17:33:34 +01:00
if ( args - > nav_region - > get_navigation_mesh ( ) . is_valid ( ) ) {
Ref < NavigationMesh > nav_mesh = args - > nav_region - > get_navigation_mesh ( ) - > duplicate ( ) ;
2020-01-10 12:22:34 +01:00
2022-12-11 18:02:35 +01:00
NavigationServer3D : : get_singleton ( ) - > region_bake_navigation_mesh ( nav_mesh , args - > nav_region ) ;
2021-07-17 23:22:52 +02:00
args - > nav_region - > call_deferred ( SNAME ( " _bake_finished " ) , nav_mesh ) ;
2020-01-10 12:22:34 +01:00
memdelete ( args ) ;
} else {
ERR_PRINT ( " Can't bake the navigation mesh if the `NavigationMesh` resource doesn't exist " ) ;
2021-07-17 23:22:52 +02:00
args - > nav_region - > call_deferred ( SNAME ( " _bake_finished " ) , Ref < NavigationMesh > ( ) ) ;
2020-01-10 12:22:34 +01:00
memdelete ( args ) ;
}
}
2022-05-04 23:00:18 +02:00
void NavigationRegion3D : : bake_navigation_mesh ( bool p_on_thread ) {
2021-09-03 04:30:04 +02:00
ERR_FAIL_COND_MSG ( bake_thread . is_started ( ) , " Unable to start another bake request. The navigation mesh bake thread is already baking a navigation mesh. " ) ;
2020-01-10 12:22:34 +01:00
BakeThreadsArgs * args = memnew ( BakeThreadsArgs ) ;
2020-03-08 17:33:34 +01:00
args - > nav_region = this ;
2020-01-10 12:22:34 +01:00
2022-10-03 10:57:36 +02:00
if ( p_on_thread ) {
2022-05-04 23:00:18 +02:00
bake_thread . start ( _bake_navigation_mesh , args ) ;
} else {
_bake_navigation_mesh ( args ) ;
}
2020-01-10 12:22:34 +01:00
}
2020-03-26 22:49:16 +01:00
void NavigationRegion3D : : _bake_finished ( Ref < NavigationMesh > p_nav_mesh ) {
2020-01-10 12:22:34 +01:00
set_navigation_mesh ( p_nav_mesh ) ;
2023-04-27 18:34:30 +02:00
if ( bake_thread . is_started ( ) ) {
bake_thread . wait_to_finish ( ) ;
}
2021-07-17 23:22:52 +02:00
emit_signal ( SNAME ( " bake_finished " ) ) ;
2020-01-10 12:22:34 +01:00
}
2022-09-19 17:43:15 +02:00
PackedStringArray NavigationRegion3D : : get_configuration_warnings ( ) const {
PackedStringArray warnings = Node : : get_configuration_warnings ( ) ;
2020-05-14 22:59:27 +02:00
2020-10-29 11:01:28 +01:00
if ( is_visible_in_tree ( ) & & is_inside_tree ( ) ) {
2022-12-11 18:02:35 +01:00
if ( ! navigation_mesh . is_valid ( ) ) {
2022-03-28 15:24:14 +02:00
warnings . push_back ( RTR ( " A NavigationMesh resource must be set or created for this node to work. " ) ) ;
2020-05-14 22:59:27 +02:00
}
2020-01-10 12:22:34 +01:00
}
2020-10-02 09:41:55 +02:00
2020-10-29 11:01:28 +01:00
return warnings ;
2020-01-10 12:22:34 +01:00
}
2020-03-26 22:49:16 +01:00
void NavigationRegion3D : : _bind_methods ( ) {
2022-12-11 18:02:35 +01:00
ClassDB : : bind_method ( D_METHOD ( " set_navigation_mesh " , " navigation_mesh " ) , & NavigationRegion3D : : set_navigation_mesh ) ;
2020-03-26 22:49:16 +01:00
ClassDB : : bind_method ( D_METHOD ( " get_navigation_mesh " ) , & NavigationRegion3D : : get_navigation_mesh ) ;
2020-01-10 12:22:34 +01:00
2020-03-26 22:49:16 +01:00
ClassDB : : bind_method ( D_METHOD ( " set_enabled " , " enabled " ) , & NavigationRegion3D : : set_enabled ) ;
ClassDB : : bind_method ( D_METHOD ( " is_enabled " ) , & NavigationRegion3D : : is_enabled ) ;
2020-01-10 12:22:34 +01:00
2023-04-01 01:49:43 +02:00
ClassDB : : bind_method ( D_METHOD ( " set_use_edge_connections " , " enabled " ) , & NavigationRegion3D : : set_use_edge_connections ) ;
ClassDB : : bind_method ( D_METHOD ( " get_use_edge_connections " ) , & NavigationRegion3D : : get_use_edge_connections ) ;
2022-06-14 23:34:43 +02:00
ClassDB : : bind_method ( D_METHOD ( " set_navigation_layers " , " navigation_layers " ) , & NavigationRegion3D : : set_navigation_layers ) ;
ClassDB : : bind_method ( D_METHOD ( " get_navigation_layers " ) , & NavigationRegion3D : : get_navigation_layers ) ;
2021-03-08 20:56:33 +01:00
2022-06-19 13:23:13 +02:00
ClassDB : : bind_method ( D_METHOD ( " set_navigation_layer_value " , " layer_number " , " value " ) , & NavigationRegion3D : : set_navigation_layer_value ) ;
ClassDB : : bind_method ( D_METHOD ( " get_navigation_layer_value " , " layer_number " ) , & NavigationRegion3D : : get_navigation_layer_value ) ;
2022-04-30 13:27:30 +02:00
ClassDB : : bind_method ( D_METHOD ( " get_region_rid " ) , & NavigationRegion3D : : get_region_rid ) ;
2022-06-06 05:24:11 +02:00
ClassDB : : bind_method ( D_METHOD ( " set_enter_cost " , " enter_cost " ) , & NavigationRegion3D : : set_enter_cost ) ;
ClassDB : : bind_method ( D_METHOD ( " get_enter_cost " ) , & NavigationRegion3D : : get_enter_cost ) ;
ClassDB : : bind_method ( D_METHOD ( " set_travel_cost " , " travel_cost " ) , & NavigationRegion3D : : set_travel_cost ) ;
ClassDB : : bind_method ( D_METHOD ( " get_travel_cost " ) , & NavigationRegion3D : : get_travel_cost ) ;
2022-05-04 23:00:18 +02:00
ClassDB : : bind_method ( D_METHOD ( " bake_navigation_mesh " , " on_thread " ) , & NavigationRegion3D : : bake_navigation_mesh , DEFVAL ( true ) ) ;
2022-12-11 18:02:35 +01:00
ClassDB : : bind_method ( D_METHOD ( " _bake_finished " , " navigation_mesh " ) , & NavigationRegion3D : : _bake_finished ) ;
2020-01-10 12:22:34 +01:00
2022-12-11 18:02:35 +01:00
ADD_PROPERTY ( PropertyInfo ( Variant : : OBJECT , " navigation_mesh " , PROPERTY_HINT_RESOURCE_TYPE , " NavigationMesh " ) , " set_navigation_mesh " , " get_navigation_mesh " ) ;
2020-01-10 12:22:34 +01:00
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " enabled " ) , " set_enabled " , " is_enabled " ) ;
2023-04-01 01:49:43 +02:00
ADD_PROPERTY ( PropertyInfo ( Variant : : BOOL , " use_edge_connections " ) , " set_use_edge_connections " , " get_use_edge_connections " ) ;
2022-06-14 23:34:43 +02:00
ADD_PROPERTY ( PropertyInfo ( Variant : : INT , " navigation_layers " , PROPERTY_HINT_LAYERS_3D_NAVIGATION ) , " set_navigation_layers " , " get_navigation_layers " ) ;
2022-06-06 05:24:11 +02:00
ADD_PROPERTY ( PropertyInfo ( Variant : : FLOAT , " enter_cost " ) , " set_enter_cost " , " get_enter_cost " ) ;
ADD_PROPERTY ( PropertyInfo ( Variant : : FLOAT , " travel_cost " ) , " set_travel_cost " , " get_travel_cost " ) ;
2020-01-10 12:22:34 +01:00
ADD_SIGNAL ( MethodInfo ( " navigation_mesh_changed " ) ) ;
ADD_SIGNAL ( MethodInfo ( " bake_finished " ) ) ;
}
2022-12-18 05:07:10 +01:00
# ifndef DISABLE_DEPRECATED
// Compatibility with earlier 4.0 betas.
bool NavigationRegion3D : : _set ( const StringName & p_name , const Variant & p_value ) {
if ( p_name = = " navmesh " ) {
set_navigation_mesh ( p_value ) ;
return true ;
}
return false ;
}
bool NavigationRegion3D : : _get ( const StringName & p_name , Variant & r_ret ) const {
if ( p_name = = " navmesh " ) {
r_ret = get_navigation_mesh ( ) ;
return true ;
}
return false ;
}
# endif // DISABLE_DEPRECATED
2021-02-10 21:18:45 +01:00
void NavigationRegion3D : : _navigation_changed ( ) {
2021-06-23 16:49:50 +02:00
update_gizmos ( ) ;
2020-10-29 11:01:28 +01:00
update_configuration_warnings ( ) ;
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
_update_debug_edge_connections_mesh ( ) ;
# endif // DEBUG_ENABLED
}
# ifdef DEBUG_ENABLED
void NavigationRegion3D : : _navigation_map_changed ( RID p_map ) {
if ( is_inside_tree ( ) & & p_map = = get_world_3d ( ) - > get_navigation_map ( ) ) {
_update_debug_edge_connections_mesh ( ) ;
}
2020-01-10 12:22:34 +01:00
}
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED
2020-01-10 12:22:34 +01:00
2020-03-26 22:49:16 +01:00
NavigationRegion3D : : NavigationRegion3D ( ) {
2020-01-10 12:22:34 +01:00
set_notify_transform ( true ) ;
2022-10-01 07:49:39 +02:00
2020-03-27 19:21:27 +01:00
region = NavigationServer3D : : get_singleton ( ) - > region_create ( ) ;
2022-10-01 07:49:39 +02:00
NavigationServer3D : : get_singleton ( ) - > region_set_owner_id ( region , get_instance_id ( ) ) ;
2022-06-06 05:24:11 +02:00
NavigationServer3D : : get_singleton ( ) - > region_set_enter_cost ( region , get_enter_cost ( ) ) ;
NavigationServer3D : : get_singleton ( ) - > region_set_travel_cost ( region , get_travel_cost ( ) ) ;
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
2022-12-21 23:21:43 +01:00
NavigationServer3D : : get_singleton ( ) - > connect ( " map_changed " , callable_mp ( this , & NavigationRegion3D : : _navigation_map_changed ) ) ;
NavigationServer3D : : get_singleton ( ) - > connect ( " navigation_debug_changed " , callable_mp ( this , & NavigationRegion3D : : _update_debug_mesh ) ) ;
NavigationServer3D : : get_singleton ( ) - > connect ( " navigation_debug_changed " , callable_mp ( this , & NavigationRegion3D : : _update_debug_edge_connections_mesh ) ) ;
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED
2020-01-10 12:22:34 +01:00
}
2020-03-26 22:49:16 +01:00
NavigationRegion3D : : ~ NavigationRegion3D ( ) {
2023-04-12 23:58:30 +02:00
if ( bake_thread . is_started ( ) ) {
bake_thread . wait_to_finish ( ) ;
}
2022-12-11 18:02:35 +01:00
if ( navigation_mesh . is_valid ( ) ) {
navigation_mesh - > disconnect ( " changed " , callable_mp ( this , & NavigationRegion3D : : _navigation_changed ) ) ;
2020-05-14 16:41:43 +02:00
}
2022-12-12 18:42:37 +01:00
ERR_FAIL_NULL ( NavigationServer3D : : get_singleton ( ) ) ;
2020-03-27 19:21:27 +01:00
NavigationServer3D : : get_singleton ( ) - > free ( region ) ;
2022-07-01 18:58:03 +02:00
# ifdef DEBUG_ENABLED
2022-12-21 23:21:43 +01:00
NavigationServer3D : : get_singleton ( ) - > disconnect ( " map_changed " , callable_mp ( this , & NavigationRegion3D : : _navigation_map_changed ) ) ;
NavigationServer3D : : get_singleton ( ) - > disconnect ( " navigation_debug_changed " , callable_mp ( this , & NavigationRegion3D : : _update_debug_mesh ) ) ;
NavigationServer3D : : get_singleton ( ) - > disconnect ( " navigation_debug_changed " , callable_mp ( this , & NavigationRegion3D : : _update_debug_edge_connections_mesh ) ) ;
2022-12-12 18:42:37 +01:00
ERR_FAIL_NULL ( RenderingServer : : get_singleton ( ) ) ;
2022-07-01 18:58:03 +02:00
if ( debug_instance . is_valid ( ) ) {
RenderingServer : : get_singleton ( ) - > free ( debug_instance ) ;
}
if ( debug_mesh . is_valid ( ) ) {
RenderingServer : : get_singleton ( ) - > free ( debug_mesh - > get_rid ( ) ) ;
}
if ( debug_edge_connections_instance . is_valid ( ) ) {
RenderingServer : : get_singleton ( ) - > free ( debug_edge_connections_instance ) ;
}
if ( debug_edge_connections_mesh . is_valid ( ) ) {
RenderingServer : : get_singleton ( ) - > free ( debug_edge_connections_mesh - > get_rid ( ) ) ;
}
# endif // DEBUG_ENABLED
}
# ifdef DEBUG_ENABLED
void NavigationRegion3D : : _update_debug_mesh ( ) {
2022-08-09 11:12:03 +02:00
if ( Engine : : get_singleton ( ) - > is_editor_hint ( ) ) {
// don't update inside Editor as node 3d gizmo takes care of this
// as collisions and selections for Editor Viewport need to be updated
return ;
}
2023-01-10 07:14:16 +01:00
if ( ! NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_enabled ( ) ) {
2022-07-01 18:58:03 +02:00
if ( debug_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_instance , false ) ;
}
return ;
}
2022-12-11 18:02:35 +01:00
if ( ! navigation_mesh . is_valid ( ) ) {
2022-07-01 18:58:03 +02:00
if ( debug_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_instance , false ) ;
}
return ;
}
if ( ! debug_instance . is_valid ( ) ) {
debug_instance = RenderingServer : : get_singleton ( ) - > instance_create ( ) ;
}
if ( ! debug_mesh . is_valid ( ) ) {
debug_mesh = Ref < ArrayMesh > ( memnew ( ArrayMesh ) ) ;
}
debug_mesh - > clear_surfaces ( ) ;
2022-12-11 18:02:35 +01:00
Vector < Vector3 > vertices = navigation_mesh - > get_vertices ( ) ;
2022-07-01 18:58:03 +02:00
if ( vertices . size ( ) = = 0 ) {
return ;
}
2022-12-11 18:02:35 +01:00
int polygon_count = navigation_mesh - > get_polygon_count ( ) ;
2022-07-01 18:58:03 +02:00
if ( polygon_count = = 0 ) {
return ;
}
2023-04-13 18:33:03 +02:00
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 ( ) ;
int vertex_count = 0 ;
int line_count = 0 ;
for ( int i = 0 ; i < polygon_count ; i + + ) {
const Vector < int > & polygon = navigation_mesh - > get_polygon ( i ) ;
int polygon_size = polygon . size ( ) ;
if ( polygon_size < 3 ) {
continue ;
}
line_count + = polygon_size * 2 ;
vertex_count + = ( polygon_size - 2 ) * 3 ;
}
2022-07-01 18:58:03 +02:00
Vector < Vector3 > face_vertex_array ;
2023-04-13 18:33:03 +02:00
face_vertex_array . resize ( vertex_count ) ;
2022-07-01 18:58:03 +02:00
Vector < Color > face_color_array ;
if ( enabled_geometry_face_random_color ) {
2023-04-13 18:33:03 +02:00
face_color_array . resize ( vertex_count ) ;
2022-07-01 18:58:03 +02:00
}
Vector < Vector3 > line_vertex_array ;
if ( enabled_edge_lines ) {
2023-04-13 18:33:03 +02:00
line_vertex_array . resize ( line_count ) ;
2022-07-01 18:58:03 +02:00
}
Color debug_navigation_geometry_face_color = NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_geometry_face_color ( ) ;
2022-08-07 08:54:57 +02:00
RandomPCG rand ;
2022-07-01 18:58:03 +02:00
Color polygon_color = debug_navigation_geometry_face_color ;
2023-04-13 18:33:03 +02:00
int face_vertex_index = 0 ;
int line_vertex_index = 0 ;
Vector3 * face_vertex_array_ptrw = face_vertex_array . ptrw ( ) ;
Color * face_color_array_ptrw = face_color_array . ptrw ( ) ;
Vector3 * line_vertex_array_ptrw = line_vertex_array . ptrw ( ) ;
for ( int polygon_index = 0 ; polygon_index < polygon_count ; polygon_index + + ) {
const Vector < int > & polygon_indices = navigation_mesh - > get_polygon ( polygon_index ) ;
int polygon_indices_size = polygon_indices . size ( ) ;
if ( polygon_indices_size < 3 ) {
continue ;
}
2022-07-01 18:58:03 +02:00
if ( enabled_geometry_face_random_color ) {
2022-08-07 08:54:57 +02:00
// Generate the polygon color, slightly randomly modified from the settings one.
polygon_color . set_hsv ( debug_navigation_geometry_face_color . get_h ( ) + rand . random ( - 1.0 , 1.0 ) * 0.1 , debug_navigation_geometry_face_color . get_s ( ) , debug_navigation_geometry_face_color . get_v ( ) + rand . random ( - 1.0 , 1.0 ) * 0.2 ) ;
polygon_color . a = debug_navigation_geometry_face_color . a ;
2022-07-01 18:58:03 +02:00
}
2023-04-13 18:33:03 +02:00
for ( int polygon_indices_index = 0 ; polygon_indices_index < polygon_indices_size - 2 ; polygon_indices_index + + ) {
face_vertex_array_ptrw [ face_vertex_index ] = vertices [ polygon_indices [ 0 ] ] ;
face_vertex_array_ptrw [ face_vertex_index + 1 ] = vertices [ polygon_indices [ polygon_indices_index + 1 ] ] ;
face_vertex_array_ptrw [ face_vertex_index + 2 ] = vertices [ polygon_indices [ polygon_indices_index + 2 ] ] ;
if ( enabled_geometry_face_random_color ) {
face_color_array_ptrw [ face_vertex_index ] = polygon_color ;
face_color_array_ptrw [ face_vertex_index + 1 ] = polygon_color ;
face_color_array_ptrw [ face_vertex_index + 2 ] = polygon_color ;
}
face_vertex_index + = 3 ;
2022-07-01 18:58:03 +02:00
}
if ( enabled_edge_lines ) {
2023-04-13 18:33:03 +02:00
for ( int polygon_indices_index = 0 ; polygon_indices_index < polygon_indices_size ; polygon_indices_index + + ) {
line_vertex_array_ptrw [ line_vertex_index ] = vertices [ polygon_indices [ polygon_indices_index ] ] ;
line_vertex_index + = 1 ;
if ( polygon_indices_index + 1 = = polygon_indices_size ) {
line_vertex_array_ptrw [ line_vertex_index ] = vertices [ polygon_indices [ 0 ] ] ;
line_vertex_index + = 1 ;
} else {
line_vertex_array_ptrw [ line_vertex_index ] = vertices [ polygon_indices [ polygon_indices_index + 1 ] ] ;
line_vertex_index + = 1 ;
}
}
2022-07-01 18:58:03 +02:00
}
}
2023-04-13 18:33:03 +02:00
Ref < StandardMaterial3D > face_material = NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_geometry_face_material ( ) ;
2022-07-01 18:58:03 +02:00
Array face_mesh_array ;
face_mesh_array . resize ( Mesh : : ARRAY_MAX ) ;
face_mesh_array [ Mesh : : ARRAY_VERTEX ] = face_vertex_array ;
if ( enabled_geometry_face_random_color ) {
face_mesh_array [ Mesh : : ARRAY_COLOR ] = face_color_array ;
}
debug_mesh - > add_surface_from_arrays ( Mesh : : PRIMITIVE_TRIANGLES , face_mesh_array ) ;
debug_mesh - > surface_set_material ( 0 , face_material ) ;
if ( enabled_edge_lines ) {
2023-04-13 18:33:03 +02:00
Ref < StandardMaterial3D > line_material = NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_geometry_edge_material ( ) ;
2022-07-01 18:58:03 +02:00
Array line_mesh_array ;
line_mesh_array . resize ( Mesh : : ARRAY_MAX ) ;
line_mesh_array [ Mesh : : ARRAY_VERTEX ] = line_vertex_array ;
debug_mesh - > add_surface_from_arrays ( Mesh : : PRIMITIVE_LINES , line_mesh_array ) ;
debug_mesh - > surface_set_material ( 1 , line_material ) ;
}
RS : : get_singleton ( ) - > instance_set_base ( debug_instance , debug_mesh - > get_rid ( ) ) ;
if ( is_inside_tree ( ) ) {
RS : : get_singleton ( ) - > instance_set_scenario ( debug_instance , get_world_3d ( ) - > get_scenario ( ) ) ;
2023-04-05 02:15:25 +02:00
RS : : get_singleton ( ) - > instance_set_transform ( debug_instance , current_global_transform ) ;
2022-07-01 18:58:03 +02:00
RS : : get_singleton ( ) - > instance_set_visible ( debug_instance , is_visible_in_tree ( ) ) ;
}
if ( ! is_enabled ( ) ) {
if ( debug_mesh . is_valid ( ) ) {
if ( debug_mesh - > get_surface_count ( ) > 0 ) {
2022-12-21 23:21:43 +01:00
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 0 , NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_geometry_face_disabled_material ( ) - > get_rid ( ) ) ;
2022-07-01 18:58:03 +02:00
}
if ( debug_mesh - > get_surface_count ( ) > 1 ) {
2022-12-21 23:21:43 +01:00
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 1 , NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_geometry_edge_disabled_material ( ) - > get_rid ( ) ) ;
2022-07-01 18:58:03 +02:00
}
}
} else {
if ( debug_mesh . is_valid ( ) ) {
if ( debug_mesh - > get_surface_count ( ) > 0 ) {
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 0 , RID ( ) ) ;
}
if ( debug_mesh - > get_surface_count ( ) > 1 ) {
RS : : get_singleton ( ) - > instance_set_surface_override_material ( debug_instance , 1 , RID ( ) ) ;
}
}
}
}
# endif // DEBUG_ENABLED
# ifdef DEBUG_ENABLED
void NavigationRegion3D : : _update_debug_edge_connections_mesh ( ) {
2023-01-10 07:14:16 +01:00
if ( ! NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_enabled ( ) ) {
2022-07-01 18:58:03 +02:00
if ( debug_edge_connections_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , false ) ;
}
return ;
}
if ( ! is_inside_tree ( ) ) {
return ;
}
2023-04-01 01:49:43 +02:00
if ( ! use_edge_connections | | ! NavigationServer3D : : get_singleton ( ) - > map_get_use_edge_connections ( get_world_3d ( ) - > get_navigation_map ( ) ) ) {
if ( debug_edge_connections_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , false ) ;
}
return ;
}
2022-12-11 18:02:35 +01:00
if ( ! navigation_mesh . is_valid ( ) ) {
2022-07-01 18:58:03 +02:00
if ( debug_edge_connections_instance . is_valid ( ) ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , false ) ;
}
return ;
}
if ( ! debug_edge_connections_instance . is_valid ( ) ) {
debug_edge_connections_instance = RenderingServer : : get_singleton ( ) - > instance_create ( ) ;
}
if ( ! debug_edge_connections_mesh . is_valid ( ) ) {
debug_edge_connections_mesh = Ref < ArrayMesh > ( memnew ( ArrayMesh ) ) ;
}
debug_edge_connections_mesh - > clear_surfaces ( ) ;
float edge_connection_margin = NavigationServer3D : : get_singleton ( ) - > map_get_edge_connection_margin ( get_world_3d ( ) - > get_navigation_map ( ) ) ;
float half_edge_connection_margin = edge_connection_margin * 0.5 ;
int connections_count = NavigationServer3D : : get_singleton ( ) - > region_get_connections_count ( region ) ;
if ( connections_count = = 0 ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , false ) ;
return ;
}
Vector < Vector3 > vertex_array ;
2022-08-04 13:40:05 +02:00
vertex_array . resize ( connections_count * 6 ) ;
2022-07-01 18:58:03 +02:00
for ( int i = 0 ; i < connections_count ; i + + ) {
Vector3 connection_pathway_start = NavigationServer3D : : get_singleton ( ) - > region_get_connection_pathway_start ( region , i ) ;
Vector3 connection_pathway_end = NavigationServer3D : : get_singleton ( ) - > region_get_connection_pathway_end ( region , i ) ;
Vector3 direction_start_end = connection_pathway_start . direction_to ( connection_pathway_end ) ;
Vector3 direction_end_start = connection_pathway_end . direction_to ( connection_pathway_start ) ;
Vector3 start_right_dir = direction_start_end . cross ( Vector3 ( 0 , 1 , 0 ) ) ;
Vector3 start_left_dir = - start_right_dir ;
Vector3 end_right_dir = direction_end_start . cross ( Vector3 ( 0 , 1 , 0 ) ) ;
Vector3 end_left_dir = - end_right_dir ;
Vector3 left_start_pos = connection_pathway_start + ( start_left_dir * half_edge_connection_margin ) ;
Vector3 right_start_pos = connection_pathway_start + ( start_right_dir * half_edge_connection_margin ) ;
Vector3 left_end_pos = connection_pathway_end + ( end_right_dir * half_edge_connection_margin ) ;
Vector3 right_end_pos = connection_pathway_end + ( end_left_dir * half_edge_connection_margin ) ;
vertex_array . push_back ( right_end_pos ) ;
vertex_array . push_back ( left_start_pos ) ;
vertex_array . push_back ( right_start_pos ) ;
vertex_array . push_back ( left_end_pos ) ;
vertex_array . push_back ( right_end_pos ) ;
vertex_array . push_back ( right_start_pos ) ;
}
if ( vertex_array . size ( ) = = 0 ) {
return ;
}
2022-12-21 23:21:43 +01:00
Ref < StandardMaterial3D > edge_connections_material = NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_edge_connections_material ( ) ;
2022-07-01 18:58:03 +02:00
Array mesh_array ;
mesh_array . resize ( Mesh : : ARRAY_MAX ) ;
mesh_array [ Mesh : : ARRAY_VERTEX ] = vertex_array ;
debug_edge_connections_mesh - > add_surface_from_arrays ( Mesh : : PRIMITIVE_TRIANGLES , mesh_array ) ;
debug_edge_connections_mesh - > surface_set_material ( 0 , edge_connections_material ) ;
RS : : get_singleton ( ) - > instance_set_base ( debug_edge_connections_instance , debug_edge_connections_mesh - > get_rid ( ) ) ;
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , is_visible_in_tree ( ) ) ;
if ( is_inside_tree ( ) ) {
RS : : get_singleton ( ) - > instance_set_scenario ( debug_edge_connections_instance , get_world_3d ( ) - > get_scenario ( ) ) ;
}
bool enable_edge_connections = NavigationServer3D : : get_singleton ( ) - > get_debug_navigation_enable_edge_connections ( ) ;
if ( ! enable_edge_connections ) {
RS : : get_singleton ( ) - > instance_set_visible ( debug_edge_connections_instance , false ) ;
}
2020-01-10 12:22:34 +01:00
}
2022-07-01 18:58:03 +02:00
# endif // DEBUG_ENABLED