diff options
Diffstat (limited to 'plugins/hello_gdextension/src')
19 files changed, 461 insertions, 0 deletions
diff --git a/plugins/hello_gdextension/src/main/AndroidManifest.xml b/plugins/hello_gdextension/src/main/AndroidManifest.xml new file mode 100644 index 0000000..e65c66c --- /dev/null +++ b/plugins/hello_gdextension/src/main/AndroidManifest.xml @@ -0,0 +1,20 @@ +<manifest xmlns:android="http://schemas.android.com/apk/res/android" + package="fhuyakou.godot.plugin.android.hellogdextension"> + + <application> + <!-- + Plugin metadata: + + - In the `android:name` attribute, the `org.godotengine.plugin.v2` prefix + is required so Godot can recognize the project as a valid Godot + Android plugin. The plugin name following the prefix should match the value + of the plugin name returned by the plugin initializer. + + - The `android:value` attribute should be the classpath to the plugin + initializer. + --> + <meta-data + android:name="org.godotengine.plugin.v2.HelloGDExtension" + android:value="fhuyakou.godot.plugin.android.hellogdextension.HelloGDExtensionPlugin" /> + </application> +</manifest> diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.bin/.gdignore b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.bin/.gdignore new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.bin/.gdignore @@ -0,0 +1 @@ + diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.bin/.gitignore b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.bin/.gitignore new file mode 100644 index 0000000..d6b7ef3 --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.bin/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/.gdignore b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/.gdignore new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/.gdignore @@ -0,0 +1 @@ + diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/hello_gdextension_editor_export_plugin.gd b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/hello_gdextension_editor_export_plugin.gd new file mode 100644 index 0000000..5131aa2 --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/hello_gdextension_editor_export_plugin.gd @@ -0,0 +1,16 @@ +@tool +extends EditorExportPlugin + +func _supports_platform(platform): + if platform is EditorExportPlatformAndroid: + return true + return false + +func _get_android_libraries(platform, debug): + if debug: + return PackedStringArray(["hello_gdextension_plugin/.bin/debug/HelloGDExtension.debug.aar"]) + else: + return PackedStringArray(["hello_gdextension_plugin/.bin/release/HelloGDExtension.release.aar"]) + +func _get_name(): + return "Hello GDExtension plugin" diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/hello_gdextension_editor_plugin.gd b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/hello_gdextension_editor_plugin.gd new file mode 100644 index 0000000..f74419c --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/.export/hello_gdextension_editor_plugin.gd @@ -0,0 +1,15 @@ +@tool +extends EditorPlugin + +# A class member to hold the export plugin during its lifecycle +var export_plugin : EditorExportPlugin + +func _enter_tree(): + # Initialization of the plugin goes here. + export_plugin = preload("hello_gdextension_editor_export_plugin.gd").new() + add_export_plugin(export_plugin) + +func _exit_tree(): + # Clean up of the plugin goes here. + remove_export_plugin(export_plugin) + export_plugin = null diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/hello_gdextension.gdextension b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/hello_gdextension.gdextension new file mode 100644 index 0000000..176a194 --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/hello_gdextension.gdextension @@ -0,0 +1,14 @@ +[configuration] + +entry_symbol = "example_library_init" +compatibility_minimum = 4.1 + +[exportable] + +android=false + +[libraries] + +macos = "res://addons/hello_gdextension_plugin/.bin/libhello_gdextension.macos.template_debug.framework" +android.debug.arm64 = "res://addons/hello_gdextension_plugin/.bin/debug/libhello_gdextension.so" +android.release.arm64 = "res://addons/hello_gdextension_plugin/.bin/release/libhello_gdextension.so" diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/interface/android_icon.svg b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/interface/android_icon.svg new file mode 100644 index 0000000..29c0fde --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/interface/android_icon.svg @@ -0,0 +1,2 @@ +<svg xmlns="http://www.w3.org/2000/svg" height="128" viewBox="0 -960 960 960" width="128"><path + d="M40-239q8-106 65-196.5T256-579l-75-129q-3-9-.5-18t10.5-14q9-5 19.5-2t15.5 12l74 127q86-37 180-37t180 37l75-127q5-9 15.5-12t19.5 2q8 5 11.5 14.5T780-708l-76 129q94 53 151 143.5T920-239H40Zm240-110q20 0 35-15t15-35q0-20-15-35t-35-15q-20 0-35 15t-15 35q0 20 15 35t35 15Zm400 0q20 0 35-15t15-35q0-20-15-35t-35-15q-20 0-35 15t-15 35q0 20 15 35t35 15Z"/></svg> diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/interface/hello_gdextension_plugin.gd b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/interface/hello_gdextension_plugin.gd new file mode 100644 index 0000000..b46fb27 --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/interface/hello_gdextension_plugin.gd @@ -0,0 +1,26 @@ +class_name HelloGDExtensionPlugin extends Object + +## Interface used to access the functionality provided by the HelloGDExtension plugin + +var _hello_gdextension_singleton + +func _init(): + if Engine.has_singleton("HelloGDExtension"): + _hello_gdextension_singleton = Engine.get_singleton("HelloGDExtension") + else: + printerr("Couldn't find HelloGDExtension singleton") + + +## Add a GDExample node +func add_gdexample_node(parent_node_path: NodePath): + if _hello_gdextension_singleton: + _hello_gdextension_singleton.addGDExampleNode(parent_node_path) + else: + printerr("Unable to add gdexample node") + +## Update the visibility of the gdexample node +func set_gdexample_visible(visible: bool): + if _hello_gdextension_singleton: + _hello_gdextension_singleton.setGDExampleVisible(visible) + else: + printerr("Unable to update gdexample visibility") diff --git a/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/plugin.cfg b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/plugin.cfg new file mode 100644 index 0000000..5c60f2b --- /dev/null +++ b/plugins/hello_gdextension/src/main/assets/addons/hello_gdextension_plugin/plugin.cfg @@ -0,0 +1,7 @@ +[plugin] + +name="Hello GDExtension plugin" +description="Showcases how to package an Android GDExtension plugin" +author="Fredia Huya-Kouadio" +version="" +script=".export/hello_gdextension_editor_plugin.gd" diff --git a/plugins/hello_gdextension/src/main/cpp/gdexample.cpp b/plugins/hello_gdextension/src/main/cpp/gdexample.cpp new file mode 100644 index 0000000..1652936 --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/gdexample.cpp @@ -0,0 +1,22 @@ +#include "gdexample.h" +#include <godot_cpp/core/class_db.hpp> + +using namespace godot; + +void GDExample::_bind_methods() { + +} + +GDExample::GDExample() { + time_passed = 0.0; +} + +GDExample::~GDExample() {} + +void GDExample::_process(double delta) { + time_passed += delta; + + Vector2 new_position = Vector2(10.0 + (10.0 * sin(time_passed * 2.0)), 10.0 + (10.0 * cos(time_passed * 1.5))); + + set_position(new_position); +} diff --git a/plugins/hello_gdextension/src/main/cpp/gdexample.h b/plugins/hello_gdextension/src/main/cpp/gdexample.h new file mode 100644 index 0000000..6add085 --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/gdexample.h @@ -0,0 +1,25 @@ +#ifndef GDEXAMPLE_H +#define GDEXAMPLE_H + +#include <godot_cpp/classes/sprite2d.hpp> + +namespace godot { + +class GDExample : public Sprite2D { + GDCLASS(GDExample, Sprite2D) + +private: + double time_passed; + +protected: + static void _bind_methods(); + +public: + GDExample(); + ~GDExample(); + + void _process(double delta) override; +}; +} + +#endif // GDEXAMPLE_H diff --git a/plugins/hello_gdextension/src/main/cpp/jni/plugin_jni.cpp b/plugins/hello_gdextension/src/main/cpp/jni/plugin_jni.cpp new file mode 100644 index 0000000..36aa658 --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/jni/plugin_jni.cpp @@ -0,0 +1,20 @@ +#include <jni.h> + +#include "plugin_manager.h" +#include "utils.h" + +#undef JNI_PACKAGE_NAME +#define JNI_PACKAGE_NAME fhuyakou_godot_plugin_android_hellogdextension + +#undef JNI_CLASS_NAME +#define JNI_CLASS_NAME HelloGDExtensionPlugin + +extern "C" { + JNIEXPORT void JNICALL JNI_METHOD(nativeAddGDExampleNode)(JNIEnv *env, jobject, jstring p_parent_node_path) { + godot::PluginManager::get_singleton()->add_gdexample_node(jstring_to_string(env, p_parent_node_path)); + } + + JNIEXPORT void JNICALL JNI_METHOD(nativeToggleVisibility)(JNIEnv *env, jobject, jboolean p_visible) { + godot::PluginManager::get_singleton()->toggle_visibility(p_visible); + } +}; diff --git a/plugins/hello_gdextension/src/main/cpp/jni/plugin_manager.cpp b/plugins/hello_gdextension/src/main/cpp/jni/plugin_manager.cpp new file mode 100644 index 0000000..647dd3e --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/jni/plugin_manager.cpp @@ -0,0 +1,87 @@ +#include "plugin_manager.h" + +#include <godot_cpp/classes/engine.hpp> +#include <godot_cpp/classes/main_loop.hpp> +#include <godot_cpp/classes/resource.hpp> +#include <godot_cpp/classes/resource_loader.hpp> +#include <godot_cpp/classes/scene_tree.hpp> +#include <godot_cpp/classes/window.hpp> + +#include "utils.h" + +namespace godot { + +PluginManager *PluginManager::singleton = nullptr; + +PluginManager::PluginManager() { + gdexample_node = memnew(GDExample); + + Ref<Resource> resource_ref = ResourceLoader::get_singleton()->load("res://addons/hello_gdextension_plugin/interface/android_icon.svg"); + gdexample_node->set_texture(resource_ref); +} + +PluginManager::~PluginManager() { + memdelete(gdexample_node); +} + +PluginManager *PluginManager::get_singleton() { + if (singleton == nullptr) { + singleton = new PluginManager(); + } + return singleton; +} + +void PluginManager::toggle_visibility(bool p_visible) { + ALOG_ASSERT(gdexample_node != nullptr, "Uninitialized gdexample node"); + + gdexample_node->set_visible(p_visible); +} + +void PluginManager::add_gdexample_node(const String &p_parent_node_path) { + ALOG_ASSERT(gdexample_node != nullptr, "Uninitialized gdexample node"); + + if (p_parent_node_path.is_empty()) { + ALOGW("Empty parent node path, aborting..."); + return; + } + + // Retrieve the parent node. + Node *parent_node = get_node(p_parent_node_path); + if (!parent_node) { + ALOGE("Unable to retrieve parent node with path %s", p_parent_node_path.utf8().get_data()); + return; + } + + if (gdexample_node->get_parent() != nullptr) { + gdexample_node->get_parent()->remove_child(gdexample_node); + } + + parent_node->add_child(gdexample_node); + gdexample_node->set_owner(parent_node); + gdexample_node->set_centered(false); +} + +Node *PluginManager::get_node(const String &p_node_path) { + if (p_node_path.is_empty()) { + ALOGW("Empty node path argument."); + return nullptr; + } + + MainLoop *main_loop = Engine::get_singleton()->get_main_loop(); + auto *scene_tree = Object::cast_to<SceneTree>(main_loop); + if (!scene_tree) { + ALOGW("Unable to retrieve the scene tree."); + return nullptr; + } + + const Window *window = scene_tree->get_root(); + NodePath node_path(p_node_path); + Node *node = window->get_node_or_null(node_path); + if (!node) { + // Try again by treating the parameter as the node's name + node = window->find_child(p_node_path, true, false); + } + + return node; +} +} diff --git a/plugins/hello_gdextension/src/main/cpp/jni/plugin_manager.h b/plugins/hello_gdextension/src/main/cpp/jni/plugin_manager.h new file mode 100644 index 0000000..473a7e6 --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/jni/plugin_manager.h @@ -0,0 +1,32 @@ +#ifndef PLUGIN_MANAGER_H +#define PLUGIN_MANAGER_H + +#include <godot_cpp/variant/string.hpp> + +#include "../gdexample.h" + +namespace godot { + +class PluginManager { +public: + static PluginManager *get_singleton(); + + void add_gdexample_node(const String &p_parent_node_path); + + void toggle_visibility(bool p_visible); + +private: + PluginManager(); + + ~PluginManager(); + + static Node *get_node(const String &p_node_path); + + static PluginManager *singleton; + + GDExample *gdexample_node = nullptr; +}; + +} + +#endif // PLUGIN_MANAGER_H diff --git a/plugins/hello_gdextension/src/main/cpp/jni/utils.h b/plugins/hello_gdextension/src/main/cpp/jni/utils.h new file mode 100644 index 0000000..e55cb6b --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/jni/utils.h @@ -0,0 +1,75 @@ +#ifndef UTILS_H +#define UTILS_H + +#include <android/log.h> +#include <godot_cpp/variant/string.hpp> +#include <jni.h> + +#define LOG_TAG "HelloGDExtension" + +#define ALOG_ASSERT(_cond, ...) \ + if (!(_cond)) __android_log_assert("conditional", LOG_TAG, __VA_ARGS__) +#define ALOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__) +#define ALOGW(...) __android_log_print(ANDROID_LOG_WARN, LOG_TAG, __VA_ARGS__) +#define ALOGV(...) __android_log_print(ANDROID_LOG_VERBOSE, LOG_TAG, __VA_ARGS__) + +/** Auxiliary macros */ +#define __JNI_METHOD_BUILD(package, class_name, method) \ + Java_ ## package ## _ ## class_name ## _ ## method +#define __JNI_METHOD_EVAL(package, class_name, method) \ + __JNI_METHOD_BUILD(package, class_name, method) + +/** + * Expands the JNI signature for a JNI method. + * + * Requires to redefine the macros JNI_PACKAGE_NAME and JNI_CLASS_NAME. + * Not doing so will raise preprocessor errors during build. + * + * JNI_PACKAGE_NAME must be the JNI representation Java class package name. + * JNI_CLASS_NAME must be the JNI representation of the Java class name. + * + * For example, for the class com.example.package.SomeClass: + * JNI_PACKAGE_NAME: com_example_package + * JNI_CLASS_NAME: SomeClass + * + * Note that underscores in Java package and class names are replaced with "_1" + * in their JNI representations. + */ +#define JNI_METHOD(method) \ + __JNI_METHOD_EVAL(JNI_PACKAGE_NAME, JNI_CLASS_NAME, method) + +/** + * Expands a Java class name using slashes as package separators into its + * JNI type string representation. + * + * For example, to get the JNI type representation of a Java String: + * JAVA_TYPE("java/lang/String") + */ +#define JAVA_TYPE(class_name) "L" class_name ";" + +/** + * Default definitions for the macros required in JNI_METHOD. + * Used to raise build errors if JNI_METHOD is used without redefining them. + */ +#define JNI_CLASS_NAME "Error: JNI_CLASS_NAME not redefined" +#define JNI_PACKAGE_NAME "Error: JNI_PACKAGE_NAME not redefined" + +/** +* Converts JNI jstring to Godot String. +* @param source Source JNI string. If null an empty string is returned. +* @param env JNI environment instance. +* @return Godot string instance. +*/ +static inline godot::String jstring_to_string(JNIEnv *env, jstring source) { + if (env && source) { + const char *const source_utf8 = env->GetStringUTFChars(source, NULL); + if (source_utf8) { + godot::String result(source_utf8); + env->ReleaseStringUTFChars(source, source_utf8); + return result; + } + } + return godot::String(); +} + +#endif // UTILS_H diff --git a/plugins/hello_gdextension/src/main/cpp/register_types.cpp b/plugins/hello_gdextension/src/main/cpp/register_types.cpp new file mode 100644 index 0000000..e6be489 --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/register_types.cpp @@ -0,0 +1,41 @@ +#include "register_types.h" + +#include "gdexample.h" + +#include <gdextension_interface.h> +#include <godot_cpp/core/defs.hpp> +#include <godot_cpp/core/class_db.hpp> +#include <godot_cpp/godot.hpp> + +using namespace godot; + +void initialize_example_module(ModuleInitializationLevel p_level) { + if (p_level!=godot::MODULE_INITIALIZATION_LEVEL_SCENE) { + return; + } + + ClassDB::register_class<GDExample>(); +} + +void uninitialize_example_module(ModuleInitializationLevel p_level) { + if (p_level!=godot::MODULE_INITIALIZATION_LEVEL_SCENE) { + return; + } +} + +extern "C" { +// Initialization +GDExtensionBool GDE_EXPORT example_library_init(GDExtensionInterfaceGetProcAddress + p_get_proc_address, + const GDExtensionClassLibraryPtr p_library, + GDExtensionInitialization + *r_initialization) { + godot::GDExtensionBinding::InitObject init_obj(p_get_proc_address, p_library, r_initialization); + + init_obj.register_initializer(initialize_example_module); + init_obj.register_terminator(uninitialize_example_module); + init_obj.set_minimum_library_initialization_level(godot::MODULE_INITIALIZATION_LEVEL_SCENE); + + return init_obj.init(); +} +} diff --git a/plugins/hello_gdextension/src/main/cpp/register_types.h b/plugins/hello_gdextension/src/main/cpp/register_types.h new file mode 100644 index 0000000..d01d663 --- /dev/null +++ b/plugins/hello_gdextension/src/main/cpp/register_types.h @@ -0,0 +1,7 @@ +#ifndef REGISTER_TYPES_H +#define REGISTER_TYPES_H + +void initialize_example_module(); +void uninitialize_example_module(); + +#endif // REGISTER_TYPES_H diff --git a/plugins/hello_gdextension/src/main/java/fhuyakou/godot/plugin/android/hellogdextension/HelloGDExtensionPlugin.kt b/plugins/hello_gdextension/src/main/java/fhuyakou/godot/plugin/android/hellogdextension/HelloGDExtensionPlugin.kt new file mode 100644 index 0000000..85a28ab --- /dev/null +++ b/plugins/hello_gdextension/src/main/java/fhuyakou/godot/plugin/android/hellogdextension/HelloGDExtensionPlugin.kt @@ -0,0 +1,48 @@ +package fhuyakou.godot.plugin.android.hellogdextension + +import android.util.Log +import org.godotengine.godot.Godot +import org.godotengine.godot.plugin.GodotPlugin +import org.godotengine.godot.plugin.UsedByGodot + +/** + * Entry point for the 'HelloGDExtension' Android plugin. + * + * This plugin provides a couple of methods to add and manipulate a GDExample node. + * The GDExample node is implemented and integrated within Godot using GDExtension. + */ +class HelloGDExtensionPlugin(godot: Godot) : GodotPlugin(godot) { + + companion object { + val TAG = HelloGDExtensionPlugin::class.java.simpleName + + init { + try { + Log.v(TAG, "Loading hello_gdextension library") + System.loadLibrary("hello_gdextension") + } catch (e: UnsatisfiedLinkError) { + Log.e(TAG, "Unable to load the hello_gdextension shared library") + } + } + } + + @UsedByGodot + private fun addGDExampleNode(parentNodePath: String) { + Log.i(TAG, "Adding GDExample node to $parentNodePath") + nativeAddGDExampleNode(parentNodePath) + } + + @UsedByGodot + private fun setGDExampleVisible(visible: Boolean) { + Log.i(TAG, "Updating GDExample node visibility to $visible") + nativeToggleVisibility(visible) + } + + override fun getPluginName() = "HelloGDExtension" + + override fun getPluginGDExtensionModulesPaths() = setOf("res://addons/hello_gdextension_plugin/hello_gdextension.gdextension") + + private external fun nativeAddGDExampleNode(parentNodePath: String) + + private external fun nativeToggleVisibility(visible: Boolean) +} |
