// Copyright (c) 2012-2023 Wojciech Figat. All rights reserved.

#pragma once

#include "Engine/Scripting/ScriptingObject.h"
#include "Engine/Core/ISerializable.h"
#if USE_EDITOR
#include "Engine/Core/Math/Color.h"
#endif

class AnimatedModel;
class Animation;

/// <summary>
/// The animation notification event triggered during animation playback.
/// </summary>
API_CLASS(Abstract) class FLAXENGINE_API AnimEvent : public ScriptingObject, public ISerializable
{
    DECLARE_SCRIPTING_TYPE(AnimEvent);

#if USE_EDITOR
    /// <summary>
    /// Event display color in the Editor.
    /// </summary>
    API_FIELD(Attributes="HideInEditor, NoSerialize") Color Color = Color::White;
#endif

    /// <summary>
    /// Animation event notification.
    /// </summary>
    /// <param name="actor">The animated model actor instance.</param>
    /// <param name="anim">The source animation.</param>
    /// <param name="time">The current animation time (in seconds).</param>
    /// <param name="deltaTime">The current animation tick delta time (in seconds).</param>
    API_FUNCTION() virtual void OnEvent(AnimatedModel* actor, Animation* anim, float time, float deltaTime)
    {
    }

    // [ISerializable]
    void Serialize(SerializeStream& stream, const void* otherObj) override;
    void Deserialize(DeserializeStream& stream, ISerializeModifier* modifier) override;
};

/// <summary>
/// The animation notification event (with duration) triggered during animation playback that contains begin and end (event notification is received as a tick).
/// </summary>
API_CLASS(Abstract) class FLAXENGINE_API AnimContinuousEvent : public AnimEvent
{
    DECLARE_SCRIPTING_TYPE(AnimContinuousEvent);

    /// <summary>
    /// Animation notification called before the first event.
    /// </summary>
    /// <param name="actor">The animated model actor instance.</param>
    /// <param name="anim">The source animation.</param>
    /// <param name="time">The current animation time (in seconds).</param>
    /// <param name="deltaTime">The current animation tick delta time (in seconds).</param>
    API_FUNCTION() virtual void OnBegin(AnimatedModel* actor, Animation* anim, float time, float deltaTime)
    {
    }

    /// <summary>
    /// Animation notification called after the last event (guaranteed to be always called).
    /// </summary>
    /// <param name="actor">The animated model actor instance.</param>
    /// <param name="anim">The source animation.</param>
    /// <param name="time">The current animation time (in seconds).</param>
    /// <param name="deltaTime">The current animation tick delta time (in seconds).</param>
    API_FUNCTION() virtual void OnEnd(AnimatedModel* actor, Animation* anim, float time, float deltaTime)
    {
    }
};