2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2021-06-17 02:52:30 +02:00
|
|
|
/* visible_on_screen_notifier_3d.cpp */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* 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
|
|
|
/*************************************************************************/
|
2022-01-03 21:27:34 +01:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 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
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
#include "visible_on_screen_notifier_3d.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
#include "scene/scene_string_names.h"
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenNotifier3D::_visibility_enter() {
|
2021-06-16 20:43:02 +02:00
|
|
|
if (!is_inside_tree() || Engine::get_singleton()->is_editor_hint()) {
|
|
|
|
return;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2017-08-06 00:48:29 +02:00
|
|
|
|
2021-06-16 20:43:02 +02:00
|
|
|
on_screen = true;
|
|
|
|
emit_signal(SceneStringNames::get_singleton()->screen_entered);
|
|
|
|
_screen_enter();
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenNotifier3D::_visibility_exit() {
|
2021-06-16 20:43:02 +02:00
|
|
|
if (!is_inside_tree() || Engine::get_singleton()->is_editor_hint()) {
|
|
|
|
return;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2021-06-16 20:43:02 +02:00
|
|
|
|
|
|
|
on_screen = false;
|
|
|
|
emit_signal(SceneStringNames::get_singleton()->screen_exited);
|
|
|
|
_screen_exit();
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenNotifier3D::set_aabb(const AABB &p_aabb) {
|
2020-05-14 16:41:43 +02:00
|
|
|
if (aabb == p_aabb) {
|
2014-02-10 02:10:30 +01:00
|
|
|
return;
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
aabb = p_aabb;
|
|
|
|
|
2021-06-16 20:43:02 +02:00
|
|
|
RS::get_singleton()->visibility_notifier_set_aabb(get_base(), aabb);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-06-23 16:49:50 +02:00
|
|
|
update_gizmos();
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
AABB VisibleOnScreenNotifier3D::get_aabb() const {
|
2014-02-10 02:10:30 +01:00
|
|
|
return aabb;
|
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
bool VisibleOnScreenNotifier3D::is_on_screen() const {
|
2021-06-16 20:43:02 +02:00
|
|
|
return on_screen;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenNotifier3D::_notification(int p_what) {
|
2022-02-15 18:06:48 +01:00
|
|
|
switch (p_what) {
|
|
|
|
case NOTIFICATION_ENTER_TREE:
|
|
|
|
case NOTIFICATION_EXIT_TREE: {
|
|
|
|
on_screen = false;
|
|
|
|
} break;
|
2021-06-16 20:43:02 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenNotifier3D::_bind_methods() {
|
|
|
|
ClassDB::bind_method(D_METHOD("set_aabb", "rect"), &VisibleOnScreenNotifier3D::set_aabb);
|
|
|
|
ClassDB::bind_method(D_METHOD("is_on_screen"), &VisibleOnScreenNotifier3D::is_on_screen);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-12-03 01:09:19 +01:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::AABB, "aabb", PROPERTY_HINT_NONE, "suffix:m"), "set_aabb", "get_aabb");
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-01-12 04:51:08 +01:00
|
|
|
ADD_SIGNAL(MethodInfo("screen_entered"));
|
|
|
|
ADD_SIGNAL(MethodInfo("screen_exited"));
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
VisibleOnScreenNotifier3D::VisibleOnScreenNotifier3D() {
|
2021-06-16 20:43:02 +02:00
|
|
|
RID notifier = RS::get_singleton()->visibility_notifier_create();
|
|
|
|
RS::get_singleton()->visibility_notifier_set_aabb(notifier, aabb);
|
2021-06-17 02:52:30 +02:00
|
|
|
RS::get_singleton()->visibility_notifier_set_callbacks(notifier, callable_mp(this, &VisibleOnScreenNotifier3D::_visibility_enter), callable_mp(this, &VisibleOnScreenNotifier3D::_visibility_exit));
|
2021-06-16 20:43:02 +02:00
|
|
|
set_base(notifier);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2022-09-29 11:53:28 +02:00
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
VisibleOnScreenNotifier3D::~VisibleOnScreenNotifier3D() {
|
2022-09-29 11:53:28 +02:00
|
|
|
RID base_old = get_base();
|
2021-06-17 02:52:30 +02:00
|
|
|
set_base(RID());
|
2022-12-12 18:42:37 +01:00
|
|
|
ERR_FAIL_NULL(RenderingServer::get_singleton());
|
2022-09-29 11:53:28 +02:00
|
|
|
RS::get_singleton()->free(base_old);
|
2021-06-17 02:52:30 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
//////////////////////////////////////
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenEnabler3D::_screen_enter() {
|
2021-06-16 20:43:02 +02:00
|
|
|
_update_enable_mode(true);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenEnabler3D::_screen_exit() {
|
2021-06-16 20:43:02 +02:00
|
|
|
_update_enable_mode(false);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenEnabler3D::set_enable_mode(EnableMode p_mode) {
|
2021-06-16 20:43:02 +02:00
|
|
|
enable_mode = p_mode;
|
|
|
|
if (is_inside_tree()) {
|
|
|
|
_update_enable_mode(is_on_screen());
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2021-06-16 20:43:02 +02:00
|
|
|
}
|
2021-06-17 02:52:30 +02:00
|
|
|
VisibleOnScreenEnabler3D::EnableMode VisibleOnScreenEnabler3D::get_enable_mode() {
|
2021-06-16 20:43:02 +02:00
|
|
|
return enable_mode;
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenEnabler3D::set_enable_node_path(NodePath p_path) {
|
2021-06-16 20:43:02 +02:00
|
|
|
if (enable_node_path == p_path) {
|
|
|
|
return;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2021-06-16 20:43:02 +02:00
|
|
|
enable_node_path = p_path;
|
|
|
|
if (is_inside_tree()) {
|
|
|
|
node_id = ObjectID();
|
|
|
|
Node *node = get_node(enable_node_path);
|
|
|
|
if (node) {
|
|
|
|
node_id = node->get_instance_id();
|
|
|
|
_update_enable_mode(is_on_screen());
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
2021-06-16 20:43:02 +02:00
|
|
|
}
|
2021-06-17 02:52:30 +02:00
|
|
|
NodePath VisibleOnScreenEnabler3D::get_enable_node_path() {
|
2021-06-16 20:43:02 +02:00
|
|
|
return enable_node_path;
|
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenEnabler3D::_update_enable_mode(bool p_enable) {
|
2021-06-16 20:43:02 +02:00
|
|
|
Node *node = static_cast<Node *>(ObjectDB::get_instance(node_id));
|
|
|
|
if (node) {
|
|
|
|
if (p_enable) {
|
|
|
|
switch (enable_mode) {
|
|
|
|
case ENABLE_MODE_INHERIT: {
|
|
|
|
node->set_process_mode(PROCESS_MODE_INHERIT);
|
|
|
|
} break;
|
|
|
|
case ENABLE_MODE_ALWAYS: {
|
|
|
|
node->set_process_mode(PROCESS_MODE_ALWAYS);
|
|
|
|
} break;
|
|
|
|
case ENABLE_MODE_WHEN_PAUSED: {
|
|
|
|
node->set_process_mode(PROCESS_MODE_WHEN_PAUSED);
|
|
|
|
} break;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
node->set_process_mode(PROCESS_MODE_DISABLED);
|
2020-05-14 16:41:43 +02:00
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
}
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenEnabler3D::_notification(int p_what) {
|
2022-02-15 18:06:48 +01:00
|
|
|
switch (p_what) {
|
|
|
|
case NOTIFICATION_ENTER_TREE: {
|
|
|
|
if (Engine::get_singleton()->is_editor_hint()) {
|
|
|
|
return;
|
|
|
|
}
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-02-15 18:06:48 +01:00
|
|
|
node_id = ObjectID();
|
|
|
|
Node *node = get_node(enable_node_path);
|
|
|
|
if (node) {
|
|
|
|
node_id = node->get_instance_id();
|
|
|
|
node->set_process_mode(PROCESS_MODE_DISABLED);
|
|
|
|
}
|
|
|
|
} break;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-02-15 18:06:48 +01:00
|
|
|
case NOTIFICATION_EXIT_TREE: {
|
|
|
|
node_id = ObjectID();
|
|
|
|
} break;
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
void VisibleOnScreenEnabler3D::_bind_methods() {
|
|
|
|
ClassDB::bind_method(D_METHOD("set_enable_mode", "mode"), &VisibleOnScreenEnabler3D::set_enable_mode);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_enable_mode"), &VisibleOnScreenEnabler3D::get_enable_mode);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
ClassDB::bind_method(D_METHOD("set_enable_node_path", "path"), &VisibleOnScreenEnabler3D::set_enable_node_path);
|
|
|
|
ClassDB::bind_method(D_METHOD("get_enable_node_path"), &VisibleOnScreenEnabler3D::get_enable_node_path);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-06-16 20:43:02 +02:00
|
|
|
ADD_GROUP("Enabling", "enable_");
|
2022-10-28 14:51:26 +02:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::INT, "enable_mode", PROPERTY_HINT_ENUM, "Inherit,Always,When Paused"), "set_enable_mode", "get_enable_mode");
|
2021-06-16 20:43:02 +02:00
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::NODE_PATH, "enable_node_path"), "set_enable_node_path", "get_enable_node_path");
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-06-16 20:43:02 +02:00
|
|
|
BIND_ENUM_CONSTANT(ENABLE_MODE_INHERIT);
|
|
|
|
BIND_ENUM_CONSTANT(ENABLE_MODE_ALWAYS);
|
|
|
|
BIND_ENUM_CONSTANT(ENABLE_MODE_WHEN_PAUSED);
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|
|
|
|
|
2021-06-17 02:52:30 +02:00
|
|
|
VisibleOnScreenEnabler3D::VisibleOnScreenEnabler3D() {
|
2014-02-10 02:10:30 +01:00
|
|
|
}
|