Finish skeletal animations.

Author: Flone-dnb

README.md

@@ -13,7 +13,7 @@ Supported platforms: Windows (x32, x64), Linux (x32, x64 and ARM64).
 - [X] Simple editor
 - [X] GLTF/GLB import
 - [X] Audio
-- [ ] Skeletal animations
+- [X] Skeletal animations
 - [ ] Particle effects
 - [ ] Simple physics engine
 

src/editor/src/obj_picking.c

@@ -109,12 +109,19 @@ obj_picking_find_obj_under_cursor(
             break;
         }
 
-        te_model* child = model_get_child_model(model);
-        if (child != NULL) {
+        // Test child models.
+        unsigned int child_idx = 0;
+        while (true) {
+            te_model* child = model_get_child_model(model, child_idx);
+            if (child == NULL) {
+                break;
+            }
+
             if (test_model_hit(
                     &info, frustum, gizmo, camera_world_pos, camera_world_ray, child)) {
                 break;
             }
+            child_idx += 1;
         }
     }
 

src/editor/src/ui/property_inspector.c

@@ -4,7 +4,10 @@
 #include <stdio.h>
 #include <type_database.h>
 #include <game/game_object_info.h>
+#include <game/model.h>
+#include <game/skeleton.h>
 #include <io/log.h>
+#include <io/filesystem.h>
 #include <ui/theme.h>
 #include <ui/editor_ui.h>
 #include <ui/world_inspector.h>
@@ -235,6 +238,31 @@ on_button_pilot_camera_clicked(te_button_widget* button) {
     property_inspector_hide(inspector);
 }
 
+static void on_preview_animation_selected(void* custom, const char* absolute_path_to_file) {
+    te_property_inspector* inspector = custom;
+
+    te_model* model = inspector->obj;
+    te_skeleton* skeleton = model_get_skeleton(model);
+
+    char* relative_path_to_anim = filesystem_convert_path_to_relative(absolute_path_to_file);
+
+    skeleton_load_animations(skeleton, relative_path_to_anim);
+
+    const char* filename = filesystem_find_filename(relative_path_to_anim, false, NULL);
+    skeleton_play_animation(skeleton, filename, true);
+
+    free(relative_path_to_anim);
+}
+
+static void
+on_button_preview_animation_clicked(te_button_widget* button) {
+    te_property_inspector* inspector = widget_get_custom_ptr(button_widget_get_widget(button));
+
+    te_editor* editor = editor_ui_get_editor(inspector->ui);
+    editor_show_file_dialog(
+        editor, inspector, on_preview_animation_selected, NULL, TE_FDM_SELECT_EXISTING_FILE);
+}
+
 void
 property_inspector_show(te_property_inspector* inspector, void* obj, const char* obj_type_id) {
     if (inspector->obj == obj) {
@@ -274,46 +302,90 @@ property_inspector_show(te_property_inspector* inspector, void* obj, const char*
     pos[0] = hpadding;
     pos[1] = theme_get_vertical_padding() / 2.0f;
 
-    if (type_info->get_game_object_info != NULL && type_info->get_game_object_info(obj)->type == TE_GOT_CAMERA) {
-        // Add a button to pilot the camera.
-        te_button_widget* button = button_widget_create();
-        {
-            te_widget* widget = button_widget_get_widget(button);
-            widget_set_custom_ptr(widget, inspector);
-            widget_set_parent(widget, inspector->right_panel);
-            widget_set_relative_position(widget, pos);
-            widget_set_relative_size(widget, size);
-        }
+    if (type_info->get_game_object_info != NULL) {
+        if (type_info->get_game_object_info(obj)->type == TE_GOT_CAMERA) {
+            // Add a button to pilot the camera.
+            te_button_widget* button = button_widget_create();
+            {
+                te_widget* widget = button_widget_get_widget(button);
+                widget_set_custom_ptr(widget, inspector);
+                widget_set_parent(widget, inspector->right_panel);
+                widget_set_relative_position(widget, pos);
+                widget_set_relative_size(widget, size);
+            }
 
-        vec4 color;
-        theme_get_button_color(color);
-        button_widget_set_color(button, color);
+            vec4 color;
+            theme_get_button_color(color);
+            button_widget_set_color(button, color);
 
-        theme_get_button_color_hovered(color);
-        button_widget_set_color_hovered(button, color);
+            theme_get_button_color_hovered(color);
+            button_widget_set_color_hovered(button, color);
 
-        theme_get_button_color_pressed(color);
-        button_widget_set_color_pressed(button, color);
+            theme_get_button_color_pressed(color);
+            button_widget_set_color_pressed(button, color);
 
-        button_widget_set_on_clicked(button, on_button_pilot_camera_clicked);
+            button_widget_set_on_clicked(button, on_button_pilot_camera_clicked);
 
-        // Button text.
+            // Button text.
 
-        te_text_widget* text_widget = text_widget_create();
-        {
-            te_widget* widget = text_widget_get_widget(text_widget);
-            widget_set_parent(widget, button_widget_get_widget(button));
-            widget_set_relative_position(widget, (vec2){hpadding, 0.0f});
-            widget_set_relative_size(widget, (vec2){1.0f - hpadding, 1.0f});
-        }
+            te_text_widget* text_widget = text_widget_create();
+            {
+                te_widget* widget = text_widget_get_widget(text_widget);
+                widget_set_parent(widget, button_widget_get_widget(button));
+                widget_set_relative_position(widget, (vec2){hpadding, 0.0f});
+                widget_set_relative_size(widget, (vec2){1.0f - hpadding, 1.0f});
+            }
 
-        text_widget_set_text_height(text_widget, theme_get_text_height());
+            text_widget_set_text_height(text_widget, theme_get_text_height());
+
+            unsigned int text_len;
+            wchar_t* text = wchar_from_char("Pilot camera", &text_len);
+            text_widget_set_text_own(text_widget, text, text_len);
+
+            pos[1] += size[1];
+        } else if (
+            type_info->get_game_object_info(obj)->type == TE_GOT_MODEL
+            && model_get_skeleton(obj) != NULL) {
+            // Add a button to preview skeleton animation.
+            te_button_widget* button = button_widget_create();
+            {
+                te_widget* widget = button_widget_get_widget(button);
+                widget_set_custom_ptr(widget, inspector);
+                widget_set_parent(widget, inspector->right_panel);
+                widget_set_relative_position(widget, pos);
+                widget_set_relative_size(widget, size);
+            }
 
-        unsigned int text_len;
-        wchar_t* text = wchar_from_char("Pilot camera", &text_len);
-        text_widget_set_text_own(text_widget, text, text_len);
+            vec4 color;
+            theme_get_button_color(color);
+            button_widget_set_color(button, color);
 
-        pos[1] += size[1];
+            theme_get_button_color_hovered(color);
+            button_widget_set_color_hovered(button, color);
+
+            theme_get_button_color_pressed(color);
+            button_widget_set_color_pressed(button, color);
+
+            button_widget_set_on_clicked(button, on_button_preview_animation_clicked);
+
+            // Button text.
+
+            te_text_widget* text_widget = text_widget_create();
+            {
+                te_widget* widget = text_widget_get_widget(text_widget);
+                widget_set_parent(widget, button_widget_get_widget(button));
+                widget_set_relative_position(widget, (vec2){hpadding, 0.0f});
+                widget_set_relative_size(widget, (vec2){1.0f - hpadding, 1.0f});
+            }
+
+            text_widget_set_text_height(text_widget, theme_get_text_height());
+
+            unsigned int text_len;
+            wchar_t* text = wchar_from_char("Preview animation", &text_len);
+            text_widget_set_text_own(text_widget, text, text_len);
+
+            pos[1] += size[1];
+        }
     }
 
     for (unsigned int var_idx = 0; var_idx < type_info->variable_count; var_idx++) {
@@ -585,6 +657,18 @@ property_inspector_show(te_property_inspector* inspector, void* obj, const char*
 
 void
 property_inspector_hide(te_property_inspector* inspector) {
+    {
+        // Check if we have a model with skeleton animation preview playing.
+        const te_type_info* type_info = type_database_get_type_info(inspector->obj_type_id);
+        if (type_info != NULL && type_info->get_game_object_info != NULL
+            && type_info->get_game_object_info(inspector->obj)->type == TE_GOT_MODEL) {
+            te_skeleton* skeleton = model_get_skeleton(inspector->obj);
+            if (skeleton != NULL) {
+                skeleton_unload_animations(skeleton);
+            }
+        }
+    }
+
     inspector->obj = NULL;
     inspector->obj_type_id = NULL;
 

src/editor/src/ui/world_inspector.c

@@ -425,7 +425,7 @@ rebuild_item_list_to_display_world_objects(te_world_inspector* inspector) {
             }
 
             if (info->type == TE_GOT_MODEL) {
-                // Models are special because they can have child model or attached camera.
+                // Models are special because they can have child models or attached camera.
                 te_model* model = info->game_object;
 
                 te_camera* attached_camera = model_get_attached_camera(model);
@@ -434,9 +434,17 @@ rebuild_item_list_to_display_world_objects(te_world_inspector* inspector) {
                     inspector->item_list_count += 1;
                 }
 
-                te_model* child_model = model_get_child_model(model);
-                if (child_model != NULL && model_is_serialization_allowed(child_model)) {
-                    inspector->item_list_count += 1;
+                unsigned int child_idx = 0;
+                while (true) {
+                    te_model* child_model = model_get_child_model(model, child_idx);
+                    if (child_model == NULL) {
+                        break;
+                    }
+
+                    if (model_is_serialization_allowed(child_model)) {
+                        inspector->item_list_count += 1;
+                    }
+                    child_idx += 1;
                 }
             }
 
@@ -479,14 +487,27 @@ rebuild_item_list_to_display_world_objects(te_world_inspector* inspector) {
                         item_info->game_object_info =
                             camera_get_game_object_info(attached_camera);
                         item_info->widget = NULL;
+
+                        item_idx += 1;
                     }
 
-                    te_model* child_model = model_get_child_model(model);
-                    if (child_model != NULL && model_is_serialization_allowed(child_model)) {
-                        te_world_item_info* item_info = &world_items[item_idx];
-                        item_info->indent = 1;
-                        item_info->game_object_info = model_get_game_object_info(child_model);
-                        item_info->widget = NULL;
+                    unsigned int child_idx = 0;
+                    while (true) {
+                        te_model* child_model = model_get_child_model(model, child_idx);
+                        if (child_model == NULL) {
+                            break;
+                        }
+
+                        if (model_is_serialization_allowed(child_model)) {
+                            te_world_item_info* item_info = &world_items[item_idx];
+                            item_info->indent = 1;
+                            item_info->game_object_info =
+                                model_get_game_object_info(child_model);
+                            item_info->widget = NULL;
+
+                            item_idx += 1;
+                        }
+                        child_idx += 1;
                     }
                 }
             }

src/engine_lib/include/game/model.h

@@ -150,7 +150,8 @@ void model_get_uv_offset(te_model* model, vec2 uv_offset);
 // Specify NULL as parent to detach.
 void model_set_parent(te_model* model, te_model* new_parent);
 te_model* model_get_parent(te_model* model);
-te_model* model_get_child_model(te_model* model);
+te_model* model_get_child_model(te_model* model, unsigned int index); // if returns NULL for 0 index then has no children
+unsigned int model_get_child_model_count(te_model* model);
 
 // Same as @ref model_set_parent but attaches a camera. Specify NULL to detach the camera.
 // After attached do not attempt to despawn this camera using the world because the world only operates on "root" cameras.

src/engine_lib/include/game/skeleton.h

@@ -3,23 +3,25 @@
 #include <cglm/mat4.h>
 #include <cglm/vec3.h>
 
+struct te_game_manager;
+
 // Skeleton for skeletal animations.
 typedef struct te_skeleton te_skeleton;
+typedef struct te_skeleton_animation te_skeleton_animation;
 
-// Preloads animations from the specified directory (relative to the `res` directory)
+// Preloads animation(s) from the specified file/directory (relative to the `res` directory)
 // to be later played using @ref skeleton_play_animation.
-void skeleton_load_animations(te_skeleton* skeleton, const char* relative_path_to_dir);
+void skeleton_load_animations(te_skeleton* skeleton, const char* relative_path);
 
 // Plays an animation (that was previously loaded using @ref skeleton_load_animations)
 // accepts animation file name (without extension).
-void skeleton_play_animation(te_skeleton* skeleton, const char* anim_file_name);
+void skeleton_play_animation(te_skeleton* skeleton, const char* anim_name, bool loop);
 
-// Updates inverse bind pose matrices for all skeleton bones and calculates skinning matrices
-// based on the current state of a skeleton (if playing an animation fills matrices
-// with animated bone transforms at the current animation time).
-//
-// Provided @ref skinning_mats must have N matrices where N is the number of bones the skeleton has.
-void skeleton_update(te_skeleton* skeleton);
+// Stops any currently playing animation.
+void skeleton_stop_animation(te_skeleton* skeleton);
+
+// Stops playing animation and unloads all previously loaded animations (from @ref skeleton_load_animations).
+void skeleton_unload_animations(te_skeleton* skeleton);
 
 // Returns the total number of bones the skeleton has.
 unsigned int skeleton_get_bone_count(te_skeleton* skeleton);
@@ -54,5 +56,12 @@ enum te_keyframe_interpolation_type {
 };
 
 // Loads skeleton from a file relative to the `res` directory.
-te_skeleton* prv_skeleton_create(const char* relative_path);
+te_skeleton* prv_skeleton_create(const char* relative_path, struct te_game_manager* game_manager);
 void prv_skeleton_destroy(te_skeleton* skeleton);
+
+// Updates inverse bind pose matrices for all skeleton bones and calculates skinning matrices
+// based on the current state of a skeleton (if playing an animation fills matrices
+// with animated bone transforms at the current animation time).
+//
+// Provided @ref skinning_mats must have N matrices where N is the number of bones the skeleton has.
+void prv_skeleton_update(te_skeleton* skeleton, float dt);

src/engine_lib/include/game_manager.h

@@ -21,6 +21,15 @@ struct te_world* game_manager_create_world(te_game_manager* game_manager, const
 // Destroys a world previously created using @ref game_manager_create_world.
 void game_manager_destroy_world(te_game_manager* game_manager, struct te_world* world);
 
+// Registers a custom function to be called every frame.
+// Returns a unique ID of the callback that you need to use to unregister the callback
+// in @ref game_manager_unregister_tick_callback.
+unsigned int game_manager_add_tick_callback(te_game_manager* game_manager,
+    void* custom, void (*on_tick)(void* custom, float delta_time_sec));
+
+// Unregisters a callback that was previously registered using @ref game_manager_register_tick_callback.
+void game_manager_remove_tick_callback(te_game_manager* game_manager, unsigned int callback_id);
+
 // Returns window that owns game manager.
 // Always valid pointer to the window. You should not free/destroy returned pointer.
 struct te_window* game_manager_get_window(te_game_manager* game_manager);

src/engine_lib/include/io/filesystem.h

@@ -15,6 +15,7 @@ typedef struct te_filesystem_entry {
 // ------------------------------------------------------------------------------------------------
 
 bool filesystem_does_path_exists(const char* path);
+bool filesystem_path_is_directory(const char* path);
 
 // Recursively creates directories for the specified path (if directories did not existed before).
 void filesystem_ensure_dirs_exist(const char* path);
@@ -28,6 +29,7 @@ void filesystem_copy_file(const char* src, const char* dst);
 
 // Returns pointer to the first character of the filename from the specified path string.
 // Also works for directories.
+// Specify NULL as `ret_len` to ignore returned string length.
 // Returns NULL if filename not found.
 const char*
 filesystem_find_filename(const char* path, bool include_extension, unsigned int* ret_len);