2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* scenario_fx.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
2017-08-27 14:16:55 +02:00
/* https://godotengine.org */
2014-02-10 02:10:30 +01:00
/*************************************************************************/
2019-01-01 12:53:14 +01:00
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
2014-02-10 02:10:30 +01:00
/* */
/* 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. */
/*************************************************************************/
2018-01-05 00:50:27 +01:00
2014-02-10 02:10:30 +01:00
# include "scenario_fx.h"
2017-06-24 13:58:27 +02:00
# include "scene/main/viewport.h"
2014-02-10 02:10:30 +01:00
void WorldEnvironment : : _notification ( int p_what ) {
2017-06-24 13:58:27 +02:00
if ( p_what = = Spatial : : NOTIFICATION_ENTER_WORLD | | p_what = = Spatial : : NOTIFICATION_ENTER_TREE ) {
2014-02-10 02:10:30 +01:00
2014-09-22 05:50:48 +02:00
if ( environment . is_valid ( ) ) {
2017-06-24 13:58:27 +02:00
if ( get_viewport ( ) - > find_world ( ) - > get_environment ( ) . is_valid ( ) ) {
2014-09-22 05:50:48 +02:00
WARN_PRINT ( " World already has an environment (Another WorldEnvironment?), overriding. " ) ;
}
2017-06-24 13:58:27 +02:00
get_viewport ( ) - > find_world ( ) - > set_environment ( environment ) ;
add_to_group ( " _world_environment_ " + itos ( get_viewport ( ) - > find_world ( ) - > get_scenario ( ) . get_id ( ) ) ) ;
2014-09-22 05:50:48 +02:00
}
2017-06-24 13:58:27 +02:00
} else if ( p_what = = Spatial : : NOTIFICATION_EXIT_WORLD | | p_what = = Spatial : : NOTIFICATION_EXIT_TREE ) {
2014-02-10 02:10:30 +01:00
2017-06-24 13:58:27 +02:00
if ( environment . is_valid ( ) & & get_viewport ( ) - > find_world ( ) - > get_environment ( ) = = environment ) {
get_viewport ( ) - > find_world ( ) - > set_environment ( Ref < Environment > ( ) ) ;
remove_from_group ( " _world_environment_ " + itos ( get_viewport ( ) - > find_world ( ) - > get_scenario ( ) . get_id ( ) ) ) ;
2016-05-17 23:27:15 +02:00
}
2014-02-10 02:10:30 +01:00
}
}
2017-03-05 16:44:50 +01:00
void WorldEnvironment : : set_environment ( const Ref < Environment > & p_environment ) {
2014-02-10 02:10:30 +01:00
2017-06-24 13:58:27 +02:00
if ( is_inside_tree ( ) & & environment . is_valid ( ) & & get_viewport ( ) - > find_world ( ) - > get_environment ( ) = = environment ) {
get_viewport ( ) - > find_world ( ) - > set_environment ( Ref < Environment > ( ) ) ;
remove_from_group ( " _world_environment_ " + itos ( get_viewport ( ) - > find_world ( ) - > get_scenario ( ) . get_id ( ) ) ) ;
2014-09-22 05:50:48 +02:00
//clean up
}
2017-03-05 16:44:50 +01:00
environment = p_environment ;
2017-06-24 13:58:27 +02:00
if ( is_inside_tree ( ) & & environment . is_valid ( ) ) {
if ( get_viewport ( ) - > find_world ( ) - > get_environment ( ) . is_valid ( ) ) {
2014-09-22 05:50:48 +02:00
WARN_PRINT ( " World already has an environment (Another WorldEnvironment?), overriding. " ) ;
}
2017-06-24 13:58:27 +02:00
get_viewport ( ) - > find_world ( ) - > set_environment ( environment ) ;
add_to_group ( " _world_environment_ " + itos ( get_viewport ( ) - > find_world ( ) - > get_scenario ( ) . get_id ( ) ) ) ;
2014-02-10 02:10:30 +01:00
}
2016-05-17 23:27:15 +02:00
update_configuration_warning ( ) ;
2014-02-10 02:10:30 +01:00
}
Ref < Environment > WorldEnvironment : : get_environment ( ) const {
return environment ;
}
2016-05-17 23:27:15 +02:00
String WorldEnvironment : : get_configuration_warning ( ) const {
2018-03-16 11:15:15 +01:00
if ( ! environment . is_valid ( ) ) {
return TTR ( " WorldEnvironment needs an Environment resource. " ) ;
}
if ( /*!is_visible_in_tree() ||*/ ! is_inside_tree ( ) )
2016-05-17 23:27:15 +02:00
return String ( ) ;
2017-03-05 16:44:50 +01:00
List < Node * > nodes ;
2017-06-24 13:58:27 +02:00
get_tree ( ) - > get_nodes_in_group ( " _world_environment_ " + itos ( get_viewport ( ) - > find_world ( ) - > get_scenario ( ) . get_id ( ) ) , & nodes ) ;
2016-05-17 23:27:15 +02:00
2017-03-05 16:44:50 +01:00
if ( nodes . size ( ) > 1 ) {
2016-05-17 23:27:15 +02:00
return TTR ( " Only one WorldEnvironment is allowed per scene (or set of instanced scenes) . " ) ;
}
2018-05-17 23:02:16 +02:00
// Commenting this warning for now, I think it makes no sense. If anyone can figure out what its supposed to do, feedback welcome. Else it should be deprecated.
//if (environment.is_valid() && get_viewport() && !get_viewport()->get_camera() && environment->get_background() != Environment::BG_CANVAS) {
// return TTR("This WorldEnvironment is ignored. Either add a Camera (for 3D scenes) or set this environment's Background Mode to Canvas (for 2D scenes).");
//}
2018-03-16 11:15:15 +01:00
2016-05-17 23:27:15 +02:00
return String ( ) ;
}
2014-02-10 02:10:30 +01:00
void WorldEnvironment : : _bind_methods ( ) {
2017-08-09 13:19:41 +02:00
ClassDB : : bind_method ( D_METHOD ( " set_environment " , " env " ) , & WorldEnvironment : : set_environment ) ;
ClassDB : : bind_method ( D_METHOD ( " get_environment " ) , & WorldEnvironment : : get_environment ) ;
2017-03-05 16:44:50 +01:00
ADD_PROPERTY ( PropertyInfo ( Variant : : OBJECT , " environment " , PROPERTY_HINT_RESOURCE_TYPE , " Environment " ) , " set_environment " , " get_environment " ) ;
2014-02-10 02:10:30 +01:00
}
WorldEnvironment : : WorldEnvironment ( ) {
}