animation_component.cpp

Go to the documentation of this file.

#include "animation_component.hpp"
#include <engine/meta/assets/asset_handle.hpp>
#include <engine/meta/ecs/entity.hpp>
#include <serialization/associative_archive.h>
#include <serialization/binary_archive.h>
 
namespace unravel
{
 
REFLECT_INLINE(animation_retargeting_mode)
{
    entt::meta_factory<animation_retargeting_mode>{}
        .type("animation_retargeting_mode"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "animation_retargeting_mode"},
            entt::attribute{"pretty_name", "Animation Retargeting Mode"},
        })
        .data<animation_retargeting_mode::index_based>("index_based"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "index_based"},
            entt::attribute{"pretty_name", "Index Based"},
        })
        .data<animation_retargeting_mode::name_based>("name_based"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "name_based"},
            entt::attribute{"pretty_name", "Name Based"},
        });
}
 
REFLECT(animation_component)
{
    entt::meta_factory<animation_component::culling_mode>{}
        .type("culling_mode"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "culling_mode"},
            entt::attribute{"pretty_name", "Culling Mode"},
        })
        .data<animation_component::culling_mode::always_animate>("always_animate"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "always_animate"},
            entt::attribute{"pretty_name", "Always Animate"},
        })
        .data<animation_component::culling_mode::renderer_based>("renderer_based"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "renderer_based"},
            entt::attribute{"pretty_name", "Renderer Based"},
        });
 
    // Register animation_component class with entt
    entt::meta_factory<animation_component>{}
        .type("animation_component"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "animation_component"},
            entt::attribute{"category", "ANIMATION"},
            entt::attribute{"pretty_name", "Animation"},
        })
        .func<&component_meta<animation_component>::exists>("component_exists"_hs)
        .func<&component_meta<animation_component>::add>("component_add"_hs)
        .func<&component_meta<animation_component>::save>("component_save"_hs)
        .func<&component_meta<animation_component>::load>("component_load"_hs)
        .func<&component_meta<animation_component>::remove>("component_remove"_hs)
        .data<&animation_component::set_animation, &animation_component::get_animation>("animation"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "animation"},
            entt::attribute{"pretty_name", "Animation"},
        })
        .data<&animation_component::set_autoplay, &animation_component::get_autoplay>("auto_play"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "auto_play"},
            entt::attribute{"pretty_name", "Auto Play"},
            entt::attribute{"tooltip", "Controls whether the animation should auto start."},
        })
        .data<&animation_component::set_culling_mode, &animation_component::get_culling_mode>("culling_mode"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "culling_mode"},
            entt::attribute{"pretty_name", "Culling Mode"},
            entt::attribute{"tooltip", "Controls how the animation logic should be culled."},
        })
        .data<&animation_component::set_apply_root_motion, &animation_component::get_apply_root_motion>("apply_root_motion"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "apply_root_motion"},
            entt::attribute{"pretty_name", "Apply Root Motion"},
        })
        .data<&animation_component::set_speed, &animation_component::get_speed>("speed"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "speed"},
            entt::attribute{"pretty_name", "Speed"},
            entt::attribute{"tooltip", "Controls the playback speed of the animation. 1.0 = normal speed, 2.0 = double speed, 0.5 = half speed."},
            entt::attribute{"min", 0.0f},
            entt::attribute{"max", 10.0f},
        })
        .data<&animation_component::set_retargeting_mode, &animation_component::get_retargeting_mode>("retargeting_mode"_hs)
        .custom<entt::attributes>(entt::attributes{
            entt::attribute{"name", "retargeting_mode"},
            entt::attribute{"pretty_name", "Retargeting Mode"},
            entt::attribute{"tooltip", "Bone matching mode: index-based (fast, requires exact match) or name-based (flexible, works with different skeletons)"},
        });
}
 
SAVE(animation_component)
{
    try_save(ar, ser20::make_nvp("animation", obj.get_animation()));
    try_save(ar, ser20::make_nvp("auto_play", obj.get_autoplay()));
    try_save(ar, ser20::make_nvp("culling_mode", obj.get_culling_mode()));
    try_save(ar, ser20::make_nvp("apply_root_motion", obj.get_apply_root_motion()));
    try_save(ar, ser20::make_nvp("speed", obj.get_speed()));
    try_save(ar, ser20::make_nvp("retargeting_mode", obj.get_retargeting_mode()));
}
SAVE_INSTANTIATE(animation_component, ser20::oarchive_associative_t);
SAVE_INSTANTIATE(animation_component, ser20::oarchive_binary_t);
 
LOAD(animation_component)
{
    asset_handle<animation_clip> animation;
    if(try_load(ar, ser20::make_nvp("animation", animation)))
    {
        obj.set_animation(animation);
    }
 
    bool auto_play{};
    if(try_load(ar, ser20::make_nvp("auto_play", auto_play)))
    {
        obj.set_autoplay(auto_play);
    }
 
    animation_component::culling_mode culling_mode{};
    if(try_load(ar, ser20::make_nvp("culling_mode", culling_mode)))
    {
        obj.set_culling_mode(culling_mode);
    }
 
    bool apply_root_motion{};
    if(try_load(ar, ser20::make_nvp("apply_root_motion", apply_root_motion)))
    {
        obj.set_apply_root_motion(apply_root_motion);
    }
 
    float speed{1.0f};
    if(try_load(ar, ser20::make_nvp("speed", speed)))
    {
        obj.set_speed(speed);
    }
 
    animation_retargeting_mode retargeting_mode{animation_retargeting_mode::name_based};
    if(try_load(ar, ser20::make_nvp("retargeting_mode", retargeting_mode)))
    {
        obj.set_retargeting_mode(retargeting_mode);
    }
}
LOAD_INSTANTIATE(animation_component, ser20::iarchive_associative_t);
LOAD_INSTANTIATE(animation_component, ser20::iarchive_binary_t);
 
} // namespace unravel