initial commit, 4.5 stable

modules/fbx/editor/editor_scene_importer_fbx2gltf.cpp

@@ -0,0 +1,153 @@
+/**************************************************************************/
+/*  editor_scene_importer_fbx2gltf.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.                 */
+/**************************************************************************/
+
+#include "editor_scene_importer_fbx2gltf.h"
+
+#include "core/config/project_settings.h"
+#include "editor/settings/editor_settings.h"
+#include "editor_scene_importer_ufbx.h"
+
+#include "modules/gltf/gltf_document.h"
+
+void EditorSceneFormatImporterFBX2GLTF::get_extensions(List<String> *r_extensions) const {
+	r_extensions->push_back("fbx");
+}
+
+Node *EditorSceneFormatImporterFBX2GLTF::import_scene(const String &p_path, uint32_t p_flags,
+		const HashMap<StringName, Variant> &p_options,
+		List<String> *r_missing_deps, Error *r_err) {
+	// FIXME: Hack to work around GH-86309.
+	if (p_options.has("fbx/importer") && int(p_options["fbx/importer"]) == EditorSceneFormatImporterUFBX::FBX_IMPORTER_UFBX) {
+		Ref<EditorSceneFormatImporterUFBX> fbx2gltf_importer;
+		fbx2gltf_importer.instantiate();
+		Node *scene = fbx2gltf_importer->import_scene(p_path, p_flags, p_options, r_missing_deps, r_err);
+		if (r_err && *r_err == OK) {
+			return scene;
+		} else {
+			return nullptr;
+		}
+	}
+
+	// Get global paths for source and sink.
+
+	// Don't use `c_escape()` as it can generate broken paths. These paths will be
+	// enclosed in double quotes by OS::execute(), so we only need to escape those.
+	// `c_escape_multiline()` seems to do this (escapes `\` and `"` only).
+	const String source_global = ProjectSettings::get_singleton()->globalize_path(p_path).c_escape_multiline();
+	const String sink = ProjectSettings::get_singleton()->get_imported_files_path().path_join(
+			vformat("%s-%s.glb", p_path.get_file().get_basename(), p_path.md5_text()));
+	const String sink_global = ProjectSettings::get_singleton()->globalize_path(sink).c_escape_multiline();
+
+	// Run fbx2gltf.
+
+	String fbx2gltf_path = EDITOR_GET("filesystem/import/fbx/fbx2gltf_path");
+
+	List<String> args;
+	args.push_back("--pbr-metallic-roughness");
+	args.push_back("--input");
+	args.push_back(source_global);
+	args.push_back("--output");
+	args.push_back(sink_global);
+	args.push_back("--binary");
+
+	String standard_out;
+	int ret;
+	OS::get_singleton()->execute(fbx2gltf_path, args, &standard_out, &ret, true);
+	print_verbose(fbx2gltf_path);
+	print_verbose(standard_out);
+
+	if (ret != 0) {
+		if (r_err) {
+			*r_err = ERR_SCRIPT_FAILED;
+		}
+		ERR_PRINT(vformat("FBX conversion to glTF failed with error: %d.", ret));
+		return nullptr;
+	}
+
+	// Import the generated glTF.
+
+	// Use GLTFDocument instead of glTF importer to keep image references.
+	Ref<GLTFDocument> gltf;
+	gltf.instantiate();
+	Ref<GLTFState> state;
+	state.instantiate();
+	if (p_options.has("fbx/naming_version")) {
+		int naming_version = p_options["fbx/naming_version"];
+		gltf->set_naming_version(naming_version);
+	}
+	if (p_options.has(SNAME("nodes/import_as_skeleton_bones")) ? (bool)p_options[SNAME("nodes/import_as_skeleton_bones")] : false) {
+		state->set_import_as_skeleton_bones(true);
+	}
+	print_verbose(vformat("glTF path: %s", sink));
+	Error err = gltf->append_from_file(sink, state, p_flags, p_path.get_base_dir());
+	if (err != OK) {
+		if (r_err) {
+			*r_err = FAILED;
+		}
+		return nullptr;
+	}
+
+#ifndef DISABLE_DEPRECATED
+	bool trimming = p_options.has("animation/trimming") ? (bool)p_options["animation/trimming"] : false;
+	return gltf->generate_scene(state, (float)p_options["animation/fps"], trimming, false);
+#else
+	return gltf->generate_scene(state, (float)p_options["animation/fps"], (bool)p_options["animation/trimming"], false);
+#endif
+}
+
+Variant EditorSceneFormatImporterFBX2GLTF::get_option_visibility(const String &p_path, const String &p_scene_import_type,
+		const String &p_option, const HashMap<StringName, Variant> &p_options) {
+	// Remove all the FBX options except for 'fbx/importer' if the importer is fbx2gltf.
+	// These options are available only for ufbx.
+	if (p_option.begins_with("fbx/") && p_option != "fbx/importer" && p_options.has("fbx/importer") && int(p_options["fbx/importer"]) == EditorSceneFormatImporterUFBX::FBX_IMPORTER_FBX2GLTF) {
+		return false;
+	}
+	return true;
+}
+
+#define ADD_OPTION_ENUM(PATH, ENUM_HINT, VALUE) \
+	r_options->push_back(ResourceImporter::ImportOption(PropertyInfo(Variant::INT, SNAME(PATH), PROPERTY_HINT_ENUM, ENUM_HINT), VALUE));
+
+void EditorSceneFormatImporterFBX2GLTF::get_import_options(const String &p_path,
+		List<ResourceImporter::ImportOption> *r_options) {
+	// This function must be empty to avoid both FBX2glTF and UFBX adding the same options to FBX files.
+}
+
+void EditorSceneFormatImporterFBX2GLTF::handle_compatibility_options(HashMap<StringName, Variant> &p_import_params) const {
+	if (!p_import_params.has("fbx/importer")) {
+		p_import_params["fbx/importer"] = EditorSceneFormatImporterUFBX::FBX_IMPORTER_UFBX;
+	}
+	if (!p_import_params.has("fbx/naming_version")) {
+		// If a .fbx's existing import file is missing the FBX
+		// naming compatibility version, we need to use version 1.
+		// Version 1 is the behavior before this option was added.
+		p_import_params["fbx/naming_version"] = 1;
+	}
+}

modules/fbx/editor/editor_scene_importer_fbx2gltf.h

@@ -0,0 +1,51 @@
+/**************************************************************************/
+/*  editor_scene_importer_fbx2gltf.h                                      */
+/**************************************************************************/
+/*                         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.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "editor/import/3d/resource_importer_scene.h"
+
+class Animation;
+class Node;
+
+class EditorSceneFormatImporterFBX2GLTF : public EditorSceneFormatImporter {
+	GDCLASS(EditorSceneFormatImporterFBX2GLTF, EditorSceneFormatImporter);
+
+public:
+	virtual void get_extensions(List<String> *r_extensions) const override;
+	virtual Node *import_scene(const String &p_path, uint32_t p_flags,
+			const HashMap<StringName, Variant> &p_options,
+			List<String> *r_missing_deps, Error *r_err = nullptr) override;
+	virtual void get_import_options(const String &p_path,
+			List<ResourceImporter::ImportOption> *r_options) override;
+	virtual Variant get_option_visibility(const String &p_path, const String &p_scene_import_type, const String &p_option,
+			const HashMap<StringName, Variant> &p_options) override;
+	virtual void handle_compatibility_options(HashMap<StringName, Variant> &p_import_params) const override;
+};

modules/fbx/editor/editor_scene_importer_ufbx.cpp

@@ -0,0 +1,115 @@
+/**************************************************************************/
+/*  editor_scene_importer_ufbx.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.                 */
+/**************************************************************************/
+
+#include "editor_scene_importer_ufbx.h"
+
+#include "../fbx_document.h"
+#include "editor_scene_importer_fbx2gltf.h"
+
+#include "core/config/project_settings.h"
+
+void EditorSceneFormatImporterUFBX::get_extensions(List<String> *r_extensions) const {
+	r_extensions->push_back("fbx");
+}
+
+Node *EditorSceneFormatImporterUFBX::import_scene(const String &p_path, uint32_t p_flags,
+		const HashMap<StringName, Variant> &p_options,
+		List<String> *r_missing_deps, Error *r_err) {
+	// FIXME: Hack to work around GH-86309.
+	if (p_options.has("fbx/importer") && int(p_options["fbx/importer"]) == FBX_IMPORTER_FBX2GLTF && GLOBAL_GET_CACHED(bool, "filesystem/import/fbx2gltf/enabled")) {
+		Ref<EditorSceneFormatImporterFBX2GLTF> fbx2gltf_importer;
+		fbx2gltf_importer.instantiate();
+		Node *scene = fbx2gltf_importer->import_scene(p_path, p_flags, p_options, r_missing_deps, r_err);
+		if (r_err && *r_err == OK) {
+			return scene;
+		} else {
+			return nullptr;
+		}
+	}
+	Ref<FBXDocument> fbx;
+	fbx.instantiate();
+	Ref<FBXState> state;
+	state.instantiate();
+	print_verbose(vformat("FBX path: %s", p_path));
+	String path = ProjectSettings::get_singleton()->globalize_path(p_path);
+	if (p_options.has("fbx/naming_version")) {
+		int naming_version = p_options["fbx/naming_version"];
+		fbx->set_naming_version(naming_version);
+	}
+	bool allow_geometry_helper_nodes = p_options.has("fbx/allow_geometry_helper_nodes") ? (bool)p_options["fbx/allow_geometry_helper_nodes"] : false;
+	if (allow_geometry_helper_nodes) {
+		state->set_allow_geometry_helper_nodes(allow_geometry_helper_nodes);
+	}
+	if (p_options.has("fbx/embedded_image_handling")) {
+		int32_t enum_option = p_options["fbx/embedded_image_handling"];
+		state->set_handle_binary_image(enum_option);
+	}
+	if (p_options.has(SNAME("nodes/import_as_skeleton_bones")) ? (bool)p_options[SNAME("nodes/import_as_skeleton_bones")] : false) {
+		state->set_import_as_skeleton_bones(true);
+	}
+	p_flags |= EditorSceneFormatImporter::IMPORT_USE_NAMED_SKIN_BINDS;
+	state->set_bake_fps(p_options["animation/fps"]);
+	Error err = fbx->append_from_file(path, state, p_flags, p_path.get_base_dir());
+	if (err != OK) {
+		if (r_err) {
+			*r_err = FAILED;
+		}
+		return nullptr;
+	}
+	return fbx->generate_scene(state, state->get_bake_fps(), (bool)p_options["animation/trimming"], false);
+}
+
+Variant EditorSceneFormatImporterUFBX::get_option_visibility(const String &p_path, const String &p_scene_import_type,
+		const String &p_option, const HashMap<StringName, Variant> &p_options) {
+	return true;
+}
+
+void EditorSceneFormatImporterUFBX::get_import_options(const String &p_path,
+		List<ResourceImporter::ImportOption> *r_options) {
+	// Returns all the options when path is empty because that means it's for the Project Settings.
+	if (p_path.is_empty() || p_path.get_extension().to_lower() == "fbx") {
+		r_options->push_back(ResourceImporterScene::ImportOption(PropertyInfo(Variant::INT, "fbx/importer", PROPERTY_HINT_ENUM, "ufbx,FBX2glTF"), FBX_IMPORTER_UFBX));
+		r_options->push_back(ResourceImporterScene::ImportOption(PropertyInfo(Variant::BOOL, "fbx/allow_geometry_helper_nodes"), false));
+		r_options->push_back(ResourceImporterScene::ImportOption(PropertyInfo(Variant::INT, "fbx/embedded_image_handling", PROPERTY_HINT_ENUM, "Discard All Textures,Extract Textures,Embed as Basis Universal,Embed as Uncompressed", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_UPDATE_ALL_IF_MODIFIED), FBXState::HANDLE_BINARY_EXTRACT_TEXTURES));
+		r_options->push_back(ResourceImporterScene::ImportOption(PropertyInfo(Variant::INT, "fbx/naming_version", PROPERTY_HINT_ENUM, "Godot 4.0 or 4.1,Godot 4.2 to 4.4,Godot 4.5 or later"), 2));
+	}
+}
+
+void EditorSceneFormatImporterUFBX::handle_compatibility_options(HashMap<StringName, Variant> &p_import_params) const {
+	if (!p_import_params.has("fbx/importer")) {
+		p_import_params["fbx/importer"] = EditorSceneFormatImporterUFBX::FBX_IMPORTER_FBX2GLTF;
+	}
+	if (!p_import_params.has("fbx/naming_version")) {
+		// If a .fbx's existing import file is missing the FBX
+		// naming compatibility version, we need to use version 1.
+		// Version 1 is the behavior before this option was added.
+		p_import_params["fbx/naming_version"] = 1;
+	}
+}

modules/fbx/editor/editor_scene_importer_ufbx.h

@@ -0,0 +1,55 @@
+/**************************************************************************/
+/*  editor_scene_importer_ufbx.h                                          */
+/**************************************************************************/
+/*                         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.                 */
+/**************************************************************************/
+
+#pragma once
+
+#include "editor/import/3d/resource_importer_scene.h"
+
+class Animation;
+class Node;
+
+class EditorSceneFormatImporterUFBX : public EditorSceneFormatImporter {
+	GDCLASS(EditorSceneFormatImporterUFBX, EditorSceneFormatImporter);
+
+public:
+	enum FBX_IMPORTER_TYPE {
+		FBX_IMPORTER_UFBX,
+		FBX_IMPORTER_FBX2GLTF,
+	};
+	virtual void get_extensions(List<String> *r_extensions) const override;
+	virtual Node *import_scene(const String &p_path, uint32_t p_flags,
+			const HashMap<StringName, Variant> &p_options,
+			List<String> *r_missing_deps, Error *r_err = nullptr) override;
+	virtual void get_import_options(const String &p_path,
+			List<ResourceImporter::ImportOption> *r_options) override;
+	virtual Variant get_option_visibility(const String &p_path, const String &p_scene_import_type, const String &p_option,
+			const HashMap<StringName, Variant> &p_options) override;
+	virtual void handle_compatibility_options(HashMap<StringName, Variant> &p_import_params) const override;
+};