/**************************************************************************/
/* openxr_editor_plugin.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 "openxr_editor_plugin.h"
#include "../action_map/openxr_action_map.h"
#include "../openxr_api.h"
#include "editor/docks/editor_dock_manager.h"
#include "editor/editor_node.h"
#include "platform/android/export/export_plugin.h"
#include <openxr/openxr.h>
////////////////////////////////////////////////////////////////////////////
// OpenXRExportPlugin
bool OpenXRExportPlugin::supports_platform(const Ref<EditorExportPlatform> &p_export_platform) const {
return p_export_platform->is_class(EditorExportPlatformAndroid::get_class_static());
}
bool OpenXRExportPlugin::is_openxr_mode() const {
// Check if OpenXR is enabled using `EditorExportPlatform::get_project_settings()` because that'll
// take into account the feature tags on the specific export preset that is being exported.
bool openxr_enabled = (bool)get_export_platform()->get_project_setting(get_export_preset(), "xr/openxr/enabled");
int xr_mode_index = get_option("xr_features/xr_mode");
return openxr_enabled && xr_mode_index == XR_MODE_OPENXR;
}
String OpenXRExportPlugin::_get_export_option_warning(const Ref<EditorExportPlatform> &p_export_platform, const String &p_option_name) const {
if (!supports_platform(p_export_platform)) {
return String();
}
bool gradle_build = get_option("gradle_build/use_gradle_build");
if (is_openxr_mode() && !gradle_build) {
return "\"Use Gradle Build\" must be enabled when xr_mode is set to \"OpenXR\".";
}
return String();
}
PackedStringArray OpenXRExportPlugin::get_android_dependencies(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
PackedStringArray ret;
if (!supports_platform(p_export_platform)) {
return ret;
}
if (is_openxr_mode()) {
// Loader is always identified by the full API version even if we're initializing for OpenXR 1.0.
int major = XR_VERSION_MAJOR(XR_CURRENT_API_VERSION);
int minor = XR_VERSION_MINOR(XR_CURRENT_API_VERSION);
int patch = XR_VERSION_PATCH(XR_CURRENT_API_VERSION);
String openxr_loader = "org.khronos.openxr:openxr_loader_for_android:" + String::num_int64(major) + "." + String::num_int64(minor) + "." + String::num_int64(patch);
ret.push_back(openxr_loader);
}
return ret;
}
PackedStringArray OpenXRExportPlugin::_get_export_features(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
PackedStringArray features;
if (!supports_platform(p_export_platform) || !is_openxr_mode()) {
return features;
}
// Placeholder for now
return features;
}
String OpenXRExportPlugin::get_android_manifest_element_contents(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
String contents;
if (!supports_platform(p_export_platform) || !is_openxr_mode()) {
return contents;
}
contents += R"n(
<uses-permission android:name="org.khronos.openxr.permission.OPENXR" />
<uses-permission android:name="org.khronos.openxr.permission.OPENXR_SYSTEM" />
<queries>
<provider android:authorities="org.khronos.openxr.runtime_broker;org.khronos.openxr.system_runtime_broker" />
<intent>
<action android:name="org.khronos.openxr.OpenXRRuntimeService" />
</intent>
<intent>
<action android:name="org.khronos.openxr.OpenXRApiLayerService" />
</intent>
</queries>
)n";
#ifndef DISABLE_DEPRECATED
// This logic addresses the issue from https://github.com/GodotVR/godot_openxr_vendors/issues/429.
// The issue is caused by this plugin and the vendors plugin adding the same `uses-feature` tag to the generated
// manifest, causing a duplicate error at build time.
// In order to maintain backward compatibility, we fix the issue by disabling the addition of the `uses-feature`
// tag from this plugin when specific conditions are met.
bool meta_plugin_enabled = get_option("xr_features/enable_meta_plugin");
int meta_boundary_mode = get_option("meta_xr_features/boundary_mode");
if (!meta_plugin_enabled || meta_boundary_mode != 1 /* BOUNDARY_DISABLED_VALUE */) {
#endif // DISABLE_DEPRECATED
contents += " <uses-feature android:name=\"android.hardware.vr.headtracking\" android:required=\"false\" android:version=\"1\" />\n";
#ifndef DISABLE_DEPRECATED
}
#endif // DISABLE_DEPRECATED
return contents;
}
String OpenXRExportPlugin::get_android_manifest_activity_element_contents(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
String contents;
if (!supports_platform(p_export_platform) || !is_openxr_mode()) {
return contents;
}
contents += R"n(
<intent-filter>
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="org.khronos.openxr.intent.category.IMMERSIVE_HMD" />
</intent-filter>
)n";
return contents;
}
////////////////////////////////////////////////////////////////////////////
// OpenXREditorPlugin
void OpenXREditorPlugin::edit(Object *p_node) {
if (action_map_editor && Object::cast_to<OpenXRActionMap>(p_node)) {
String path = Object::cast_to<OpenXRActionMap>(p_node)->get_path();
if (path.is_resource_file()) {
action_map_editor->open_action_map(path);
}
}
}
bool OpenXREditorPlugin::handles(Object *p_node) const {
if (action_map_editor) {
return (Object::cast_to<OpenXRActionMap>(p_node) != nullptr);
}
return false;
}
void OpenXREditorPlugin::make_visible(bool p_visible) {
}
OpenXREditorPlugin::OpenXREditorPlugin() {
// Only add our OpenXR action map editor if OpenXR is enabled for the whole project.
if (OpenXRAPI::openxr_is_enabled(false)) {
action_map_editor = memnew(OpenXRActionMapEditor);
EditorDockManager::get_singleton()->add_dock(action_map_editor);
binding_modifier_inspector_plugin = Ref<EditorInspectorPluginBindingModifier>(memnew(EditorInspectorPluginBindingModifier));
EditorInspector::add_inspector_plugin(binding_modifier_inspector_plugin);
#ifndef ANDROID_ENABLED
select_runtime = memnew(OpenXRSelectRuntime);
add_control_to_container(CONTAINER_TOOLBAR, select_runtime);
#endif
}
}
void OpenXREditorPlugin::_notification(int p_what) {
switch (p_what) {
case NOTIFICATION_ENTER_TREE: {
// Initialize our export plugin
openxr_export_plugin.instantiate();
add_export_plugin(openxr_export_plugin);
} break;
case NOTIFICATION_EXIT_TREE: {
// Clean up our export plugin
remove_export_plugin(openxr_export_plugin);
openxr_export_plugin.unref();
}
}
}