Add Lottie resource importer using ThorVG

Add lottie importer for `.lot` and `.lottie` to import lottie as CompressedTexture2D, and support dropping it as AnimatedSprite2D in 2d editor.

Author: beicause

editor/doc_tools.cpp

@@ -40,6 +40,7 @@
 #include "core/string/translation_server.h"
 #include "editor/editor_settings.h"
 #include "editor/export/editor_export_platform.h"
+#include "editor/import/resource_importer_texture.h"
 #include "scene/resources/theme.h"
 #include "scene/theme/theme_db.h"
 
@@ -464,6 +465,34 @@ void DocTools::generate(BitField<GenerateFlags> p_flags) {
 			} else if (name == "ProjectSettings") {
 				ProjectSettings::get_singleton()->get_property_list(&properties);
 				own_properties = properties;
+			} else if (name == "ResourceImporterLottie") {
+				import_option = true;
+
+				List<ResourceImporter::ImportOption> texture_options;
+				ResourceImporter *texture_importer = memnew(ResourceImporterTexture);
+				texture_importer->get_import_options("", &texture_options);
+
+				ResourceImporter *resimp = Object::cast_to<ResourceImporter>(ClassDB::instantiate(name));
+				List<ResourceImporter::ImportOption> options;
+				resimp->get_import_options("", &options);
+				for (const ResourceImporter::ImportOption &option : options) {
+					const PropertyInfo &prop = option.option;
+					bool own_property = true;
+					for (const ResourceImporter::ImportOption &texture_option : texture_options) {
+						if (texture_option.option.name == prop.name) {
+							own_property = false;
+							break;
+						}
+					}
+					if (!own_property) {
+						continue;
+					}
+					properties.push_back(prop);
+					import_options_default[prop.name] = option.default_value;
+				}
+				own_properties = properties;
+				memdelete(resimp);
+				memdelete(texture_importer);
 			} else if (ClassDB::is_parent_class(name, "ResourceImporter") && name != "EditorImportPlugin" && ClassDB::can_instantiate(name)) {
 				import_option = true;
 				ResourceImporter *resimp = Object::cast_to<ResourceImporter>(ClassDB::instantiate(name));

editor/plugins/canvas_item_editor_plugin.cpp

@@ -32,6 +32,7 @@
 
 #include "core/config/project_settings.h"
 #include "core/input/input.h"
+#include "core/io/resource_importer.h"
 #include "core/os/keyboard.h"
 #include "editor/debugger/editor_debugger_node.h"
 #include "editor/editor_main_screen.h"
@@ -48,6 +49,7 @@
 #include "editor/scene_tree_dock.h"
 #include "editor/themes/editor_scale.h"
 #include "editor/themes/editor_theme_manager.h"
+#include "scene/2d/animated_sprite_2d.h"
 #include "scene/2d/audio_stream_player_2d.h"
 #include "scene/2d/physics/touch_screen_button.h"
 #include "scene/2d/polygon_2d.h"
@@ -62,6 +64,7 @@
 #include "scene/gui/view_panner.h"
 #include "scene/main/canvas_layer.h"
 #include "scene/main/window.h"
+#include "scene/resources/atlas_texture.h"
 #include "scene/resources/packed_scene.h"
 #include "scene/resources/style_box_texture.h"
 
@@ -5983,6 +5986,30 @@ void CanvasItemEditorViewport::_create_texture_node(Node *p_parent, Node *p_chil
 			Vector2(0, texture_size.height)
 		};
 		undo_redo->add_do_property(p_child, "polygon", list);
+	} else if (Object::cast_to<AnimatedSprite2D>(p_child)) {
+		// Currently this metadata is only set by ResourceImporterLottie.
+		Dictionary meta = ResourceFormatImporter::get_singleton()->get_resource_metadata(p_path);
+		if (meta.has("sprite_sheet_sprite_size") && meta["sprite_sheet_sprite_size"].get_type() == Variant::VECTOR2I &&
+				meta.has("sprite_sheet_columns") && meta["sprite_sheet_columns"].get_type() == Variant::INT &&
+				meta.has("sprite_sheet_frame_count") && meta["sprite_sheet_frame_count"].get_type() == Variant::INT) {
+			Ref<SpriteFrames> frames;
+			frames.instantiate();
+			frames->set_animation_speed(SceneStringName(default_), meta.get("sprite_sheet_fps", 30));
+			Size2i sprite_size = meta["sprite_sheet_sprite_size"];
+			for (int i = 0; i < (int)meta["sprite_sheet_frame_count"]; i++) {
+				int x = i % (int)meta["sprite_sheet_columns"] * sprite_size.width;
+				int y = i / (int)meta["sprite_sheet_columns"] * sprite_size.height;
+				Ref<AtlasTexture> atlas_texture;
+				atlas_texture.instantiate();
+				atlas_texture->set_atlas(texture);
+				atlas_texture->set_region(Rect2(x, y, sprite_size.width, sprite_size.height));
+				frames->add_frame(SceneStringName(default_), atlas_texture);
+			}
+			undo_redo->add_do_property(p_child, SceneStringName(autoplay), SceneStringName(default_));
+			undo_redo->add_do_property(p_child, "sprite_frames", frames);
+		} else {
+			ERR_PRINT("Miss metadata to create AnimationPlayer2D. This only supports textures imported from Lottie now");
+		}
 	}
 
 	// Compute the global position
@@ -6394,6 +6421,7 @@ CanvasItemEditorViewport::CanvasItemEditorViewport(CanvasItemEditor *p_canvas_it
 	texture_node_types.push_back("GPUParticles2D");
 	texture_node_types.push_back("Polygon2D");
 	texture_node_types.push_back("TouchScreenButton");
+	texture_node_types.push_back("AnimatedSprite2D");
 	// Control
 	texture_node_types.push_back("TextureRect");
 	texture_node_types.push_back("TextureButton");

modules/svg/SCsub

@@ -59,6 +59,21 @@ thirdparty_sources = [
     "src/renderer/sw_engine/tvgSwStroke.cpp",
 ]
 
+if env.editor_build:
+    thirdparty_sources += [
+        "src/renderer/tvgAnimation.cpp",
+        # Lottie loader
+        "src/loaders/lottie/tvgLottieAnimation.cpp",
+        "src/loaders/lottie/tvgLottieBuilder.cpp",
+        # "src/loaders/lottie/tvgLottieExpressions.cpp",
+        "src/loaders/lottie/tvgLottieInterpolator.cpp",
+        "src/loaders/lottie/tvgLottieLoader.cpp",
+        "src/loaders/lottie/tvgLottieModel.cpp",
+        "src/loaders/lottie/tvgLottieModifier.cpp",
+        "src/loaders/lottie/tvgLottieParser.cpp",
+        "src/loaders/lottie/tvgLottieParserHandler.cpp",
+    ]
+
 if env["module_webp_enabled"]:
     thirdparty_sources += ["src/loaders/external_webp/tvgWebpLoader.cpp"]
     env_svg.Append(CPPDEFINES=["THORVG_WEBP_LOADER_SUPPORT"])
@@ -72,6 +87,9 @@ env_svg.Append(CPPDEFINES=["TVG_STATIC"])
 # Explicit support for embedded images in svg.
 env_svg.Append(CPPDEFINES=["THORVG_FILE_IO_SUPPORT"])
 
+if env.editor_build:
+    env_svg.Append(CPPDEFINES=["THORVG_LOTTIE_LOADER_SUPPORT", "LOTTIE_ENABLED"])
+
 env_thirdparty = env_svg.Clone()
 env_thirdparty.disable_warnings()
 env_thirdparty.Prepend(
@@ -85,6 +103,9 @@ env_thirdparty.Prepend(
         thirdparty_dir + "src/loaders/jpg",
     ]
 )
+
+if env.editor_build:
+    env_thirdparty.Prepend(CPPPATH=[thirdparty_dir + "src/loaders/lottie"])
 if env["builtin_libpng"]:
     env_thirdparty.Prepend(CPPEXTPATH=["#thirdparty/libpng"])
 if env["module_webp_enabled"]:
@@ -99,7 +120,10 @@ env.modules_sources += thirdparty_obj
 
 module_obj = []
 
-env_svg.add_source_files(module_obj, "*.cpp")
+env_svg.add_source_files(module_obj, ["register_types.cpp", "image_loader_svg.cpp"])
+if env.editor_build:
+    env_svg.add_source_files(module_obj, "editor/*.cpp")
+
 env.modules_sources += module_obj
 
 # Needed to force rebuilding the module files when the thirdparty library is updated.

modules/svg/config.py

@@ -4,3 +4,13 @@ def can_build(env, platform):
 
 def configure(env):
     pass
+
+
+def get_doc_classes():
+    return [
+        "ResourceImporterLottie",
+    ]
+
+
+def get_doc_path():
+    return "doc_classes"

modules/svg/doc_classes/ResourceImporterLottie.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="ResourceImporterLottie" inherits="ResourceImporterTexture" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
+	<brief_description>
+		Import a Lottie animation as a sprite sheet.
+	</brief_description>
+	<description>
+		This imports a Lottie animation to a [CompressedTexture2D] with support for Lottie JSON.
+		[b]Note:[/b] This importer only recognizes files with [code].lot[/code] extension. You have to rename Lottie JSON files extension to [code].lot[/code] to import them.
+	</description>
+	<tutorials>
+	</tutorials>
+	<members>
+		<member name="lottie/begin" type="float" setter="" getter="" default="0">
+			The start of the Lottie animation in the range [code]0.0[/code] to [code]1.0[/code].
+		</member>
+		<member name="lottie/columns" type="int" setter="" getter="" default="0">
+			The number of columns of the sprite sheet. If it is [code]0[/code], the number of columns will be automatically calculated to be close to the number of rows.
+		</member>
+		<member name="lottie/end" type="float" setter="" getter="" default="1">
+			The end of the Lottie animation in the range [code]0.0[/code] to [code]1.0[/code]. This value will be clamped to be at least [member lottie/begin].
+		</member>
+		<member name="lottie/fps" type="float" setter="" getter="" default="30">
+			The frame rate Lottie animation should be rendered at. Higher values result in a larger image.
+		</member>
+		<member name="lottie/scale" type="float" setter="" getter="" default="1">
+			The scale the Lottie animation should be rendered at, with [code]1.0[/code] being the original size. Higher values result in a larger image.
+		</member>
+		<member name="lottie/size_limit" type="int" setter="" getter="" default="2048">
+			If set to a value greater than [code]0[/code], the size of the imported Lottie texture is limited on import to a value smaller than or equal to the value specified here.
+			[b]Note:[/b] Importing large Lottie textures in editor is slow. This setting ensures import speed and ignores [member lottie/scale].
+		</member>
+	</members>
+</class>