o3de/Gems/LyShine/Code/Source/Animation/AzEntityNode.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */


#pragma once

#include "AnimNode.h"
//#include "SoundTrack.h"
#include "StlUtils.h"
#include <AzCore/Component/Entity.h>
#include <LyShine/Bus/UiAnimationBus.h>

// remove comment to enable the check.
//#define CHECK_FOR_TOO_MANY_ONPROPERTY_SCRIPT_CALLS

class CUiAnimAzEntityNode
    : public CUiAnimNode
    , public UiAnimNodeBus::Handler
{
    struct SScriptPropertyParamInfo;
    struct SAnimState;

public:
    AZ_CLASS_ALLOCATOR(CUiAnimAzEntityNode, AZ::SystemAllocator)
    AZ_RTTI(CUiAnimAzEntityNode, "{1C6FAEE1-92E4-42ED-8EEB-3483C36A0B77}", CUiAnimNode);

    CUiAnimAzEntityNode(const int id);
    CUiAnimAzEntityNode();
    ~CUiAnimAzEntityNode();

    void EnableEntityPhysics(bool bEnable);

    EUiAnimNodeType GetType() const override { return eUiAnimNodeType_AzEntity; }

    void AddTrack(IUiAnimTrack* track) override;

    //////////////////////////////////////////////////////////////////////////
    // Overrides from CUiAnimNode
    //////////////////////////////////////////////////////////////////////////

    // UiAnimNodeInterface
    AZ::EntityId GetAzEntityId() override { return m_entityId; };
    void SetAzEntity(AZ::Entity* entity) override { m_entityId = entity->GetId(); }
    // ~UiAnimNodeInterface


    void StillUpdate() override;
    void Animate(SUiAnimContext& ec) override;

    void CreateDefaultTracks() override;

    bool SetParamValueAz(float time, const UiAnimParamData& param, float value) override;
    bool SetParamValueAz(float time, const UiAnimParamData& param, bool value) override;
    bool SetParamValueAz(float time, const UiAnimParamData& param, int value) override;
    bool SetParamValueAz(float time, const UiAnimParamData& param, unsigned int value) override;
    bool SetParamValueAz(float time, const UiAnimParamData& param, const AZ::Vector2& value) override;
    bool SetParamValueAz(float time, const UiAnimParamData& param, const AZ::Vector3& value) override;
    bool SetParamValueAz(float time, const UiAnimParamData& param, const AZ::Vector4& value) override;
    bool SetParamValueAz(float time, const UiAnimParamData& param, const AZ::Color& value) override;

    bool GetParamValueAz(float time, const UiAnimParamData& param, float& value) override;

    void PrecacheStatic(float startTime) override;
    void PrecacheDynamic(float time) override;

    Vec3 GetPos() { return m_pos; };
    Quat GetRotate() { return m_rotate; };
    Vec3 GetScale() { return m_scale; };

    void Activate(bool bActivate) override;

    IUiAnimTrack* GetTrackForAzField(const UiAnimParamData& param) const override;
    IUiAnimTrack* CreateTrackForAzField(const UiAnimParamData& param) override;

    //////////////////////////////////////////////////////////////////////////
    void Serialize(XmlNodeRef& xmlNode, bool bLoading, bool bLoadEmptyTracks) override;
    void InitPostLoad(IUiAnimSequence* pSequence, bool remapIds, LyShine::EntityIdMap* entityIdMap) override;
    void OnReset() override;
    void OnResetHard() override;
    void OnStart() override;
    void OnPause() override;
    void OnStop() override;

    //////////////////////////////////////////////////////////////////////////
    unsigned int GetParamCount() const override;
    CUiAnimParamType GetParamType(unsigned int nIndex) const override;
    AZStd::string GetParamName(const CUiAnimParamType& param) const override;
    AZStd::string GetParamNameForTrack(const CUiAnimParamType& param, const IUiAnimTrack* track) const override;

    static int GetParamCountStatic();
    static bool GetParamInfoStatic(int nIndex, SParamInfo& info);

    static void Reflect(AZ::SerializeContext* serializeContext);

protected:
    bool GetParamInfoFromType(const CUiAnimParamType& paramId, SParamInfo& info) const override;

    //! Given the class data definition and a track for a field within it,
    //! compute the offset for the field and set it in the track
    const AZ::SerializeContext::ClassElement* ComputeOffsetFromElementName(
        const AZ::SerializeContext::ClassData* classData,
        IUiAnimTrack* track,
        size_t baseOffset);

    //! This is called on load to compute the offset into the component for each track
    void ComputeOffsetsFromElementNames();

    void ReleaseSounds();

    // functions involved in the process to parse and store lua animated properties
    void UpdateDynamicParams() override;
    virtual void UpdateDynamicParams_Editor();
    virtual void UpdateDynamicParams_PureGame();

    enum EUpdateEntityFlags
    {
        eUpdateEntity_Position = 1 << 0,
        eUpdateEntity_Rotation = 1 << 1,
        eUpdateEntity_Animation = 1 << 2,
    };

protected:
    Vec3 m_pos;
    Quat m_rotate;
    Vec3 m_scale;

private:
    IUiAnimTrack* CreateVectorTrack(const UiAnimParamData& param, EUiAnimValue valueType, int numElements);

    //! Reference to AZ entity
    AZ::EntityId m_entityId;

    //! Pointer to target animation node.
    AZStd::intrusive_ptr<IUiAnimNode> m_target;

    // Cached parameters of node at given time.
    float m_time;
    Vec3 m_velocity;
    Vec3 m_angVelocity;

    //! Last animated key in Entity track.
    int m_lastEntityKey;

    bool m_bWasTransRot;
    bool m_visible;
    bool m_bInitialPhysicsStatus;

    // Pos/rot noise parameters
    struct Noise
    {
        float m_amp;
        float m_freq;

        Vec3 Get(float time) const;

        Noise()
            : m_amp(0.0f)
            , m_freq(0.0f) {}
    };

    Noise m_posNoise;
    Noise m_rotNoise;

    struct SScriptPropertyParamInfo
    {
        AZStd::string variableName;
        AZStd::string displayName;
        bool isVectorTable;
        SParamInfo animNodeParamInfo;
    };

    AZStd::vector<SScriptPropertyParamInfo> m_entityScriptPropertiesParamInfos;
    using TScriptPropertyParamInfoMap = AZStd::unordered_map<AZStd::string, size_t, stl::hash_string_caseless<AZStd::string>, stl::equality_string_caseless<AZStd::string>>;
    TScriptPropertyParamInfoMap m_nameToScriptPropertyParamInfo;
    #ifdef CHECK_FOR_TOO_MANY_ONPROPERTY_SCRIPT_CALLS
    uint32 m_OnPropertyCalls;
    #endif
};