godot/scene/3d/occluder.cpp

/*************************************************************************/
/*  occluder.cpp                                                         */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                      https://godotengine.org                          */
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur.                 */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md).   */
/*                                                                       */
/* 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.                */
/*************************************************************************/

#include "occluder.h"

#include "core/engine.h"

void Occluder::resource_changed(RES res) {
	update_gizmo();

	if (_shape.is_valid()) {
		_shape->update_shape_to_visual_server();
	}
}

void Occluder::set_shape(const Ref<OccluderShape> &p_shape) {
	if (p_shape == _shape) {
		return;
	}
	if (!_shape.is_null()) {
		_shape->unregister_owner(this);
	}
	_shape = p_shape;
	if (_shape.is_valid()) {
		_shape->register_owner(this);

		// Especially in the editor, the shape can be added AFTER the occluder
		// is added to the world. This means the shape scenario will not be set.
		// To remedy this we make sure the scenario etc is refreshed as soon as
		// a shape is set on the occluder.
		if (is_inside_world() && get_world().is_valid()) {
			_shape->notification_enter_world(get_world()->get_scenario());
			_shape->update_shape_to_visual_server();
			if (is_inside_tree()) {
				_shape->update_active_to_visual_server(is_visible_in_tree());
				_shape->update_transform_to_visual_server(get_global_transform());
			}
		}
	}

	update_gizmo();
	update_configuration_warning();
}
Ref<OccluderShape> Occluder::get_shape() const {
	return _shape;
}

String Occluder::get_configuration_warning() const {
	String warning = Spatial::get_configuration_warning();

	if (!_shape.is_valid()) {
		if (!warning.empty()) {
			warning += "\n\n";
		}
		warning += TTR("No shape is set.");
	}

	Transform tr = get_global_transform();
	Vector3 scale = tr.basis.get_scale();

	if ((!Math::is_equal_approx(scale.x, scale.y, 0.01f)) ||
			(!Math::is_equal_approx(scale.x, scale.z, 0.01f))) {
		if (!warning.empty()) {
			warning += "\n\n";
		}
		warning += TTR("Only uniform scales are supported.");
	}

	return warning;
}

void Occluder::_notification(int p_what) {
	switch (p_what) {
		case NOTIFICATION_ENTER_WORLD: {
			ERR_FAIL_COND(get_world().is_null());
			if (_shape.is_valid()) {
				_shape->notification_enter_world(get_world()->get_scenario());
				_shape->update_active_to_visual_server(is_visible_in_tree());
				_shape->update_shape_to_visual_server();
				_shape->update_transform_to_visual_server(get_global_transform());
			}
		} break;
		case NOTIFICATION_EXIT_WORLD: {
			if (_shape.is_valid()) {
				_shape->notification_exit_world();
			}
		} break;
		case NOTIFICATION_VISIBILITY_CHANGED: {
			if (_shape.is_valid() && is_inside_tree()) {
				_shape->update_active_to_visual_server(is_visible_in_tree());
			}
		} break;
		case NOTIFICATION_TRANSFORM_CHANGED: {
			if (_shape.is_valid()) {
				_shape->update_transform_to_visual_server(get_global_transform());

#ifdef TOOLS_ENABLED
				if (Engine::get_singleton()->is_editor_hint()) {
					update_configuration_warning();
				}
#endif
			}
		} break;
	}
}

void Occluder::_bind_methods() {
	ClassDB::bind_method(D_METHOD("resource_changed", "resource"), &Occluder::resource_changed);
	ClassDB::bind_method(D_METHOD("set_shape", "shape"), &Occluder::set_shape);
	ClassDB::bind_method(D_METHOD("get_shape"), &Occluder::get_shape);

	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "shape", PROPERTY_HINT_RESOURCE_TYPE, "OccluderShape"), "set_shape", "get_shape");
}

Occluder::Occluder() {
	set_notify_transform(true);
}

Occluder::~Occluder() {
	if (!_shape.is_null()) {
		_shape->unregister_owner(this);
	}
}