o3de/Code/Editor/TrackView/SelectKeyUIControls.cpp

/*
 * 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
 *
 */


#include "EditorDefs.h"

#include "TrackViewKeyPropertiesDlg.h"                          // for CTrackViewKeyUIControls

#include <AzCore/Component/EntityBus.h>                         // for AZ::EntitySystemBus
#include <AzFramework/Components/CameraBus.h>                   // for Camera::CameraNotificationBus
#include <CryCommon/Maestro/Types/AnimValueType.h>              // for AnimValueType

//////////////////////////////////////////////////////////////////////////
class CSelectKeyUIControls
    : public CTrackViewKeyUIControls
    , protected Camera::CameraNotificationBus::Handler
    , protected AZ::EntitySystemBus::Handler
{
public:
    CSelectKeyUIControls() = default;

    ~CSelectKeyUIControls() override;

    CSmartVariableArray mv_table;
    CSmartVariableEnum<QString> mv_camera;
    CSmartVariable<float> mv_BlendTime;

    void OnCreateVars() override
    {
        AddVariable(mv_table, "Key Properties");
        AddVariable(mv_table, mv_camera, "Camera");
        AddVariable(mv_table, mv_BlendTime, "Blend time");

        Camera::CameraNotificationBus::Handler::BusConnect();
        AZ::EntitySystemBus::Handler::BusConnect();
    }
    bool SupportTrackType([[maybe_unused]] const CAnimParamType& paramType, [[maybe_unused]] EAnimCurveType trackType, AnimValueType valueType) const override
    {
        return valueType == AnimValueType::Select;
    }
    bool OnKeySelectionChange(CTrackViewKeyBundle& selectedKeys) override;
    void OnUIChange(IVariable* pVar, CTrackViewKeyBundle& selectedKeys) override;

    unsigned int GetPriority() const override { return 1; }

    static const GUID& GetClassID()
    {
        // {9018D0D1-24CC-45e5-9D3D-16D3F9E591B2}
        static const GUID guid =
        {
            0x9018d0d1, 0x24cc, 0x45e5, { 0x9d, 0x3d, 0x16, 0xd3, 0xf9, 0xe5, 0x91, 0xb2 }
        };
        return guid;
    }

protected:
    ////////////////////////////////////////////////////////////////////////
    // CameraNotificationBus interface implementation
    void OnCameraAdded(const AZ::EntityId& cameraId) override;
    void OnCameraRemoved(const AZ::EntityId& cameraId) override;

    //////////////////////////////////////////////////////////////////////////
    // AZ::EntitySystemBus::Handler
    void OnEntityNameChanged(const AZ::EntityId& entityId, const AZStd::string& name) override;

private:

    void ResetCameraEntries();
};

CSelectKeyUIControls::~CSelectKeyUIControls()
{
    AZ::EntitySystemBus::Handler::BusDisconnect();
    Camera::CameraNotificationBus::Handler::BusDisconnect();
}

//////////////////////////////////////////////////////////////////////////
bool CSelectKeyUIControls::OnKeySelectionChange(CTrackViewKeyBundle& selectedKeys)
{
    if (!selectedKeys.AreAllKeysOfSameType())
    {
        return false;
    }

    bool bAssigned = false;
    if (selectedKeys.GetKeyCount() == 1)
    {
        const CTrackViewKeyHandle& keyHandle = selectedKeys.GetKey(0);

        AnimValueType valueType = keyHandle.GetTrack()->GetValueType();
        if (valueType == AnimValueType::Select)
        {
            ResetCameraEntries();

            // Get All cameras.
            mv_camera.SetEnumList(nullptr);

            mv_camera->AddEnumItem(QObject::tr("<None>"), QString::number(static_cast<AZ::u64>(AZ::EntityId::InvalidEntityId)));

            // Find all Component Entity Cameras
            AZ::EBusAggregateResults<AZ::EntityId> cameraComponentEntities;
            Camera::CameraBus::BroadcastResult(cameraComponentEntities, &Camera::CameraRequests::GetCameras);

            // add names of all found entities with Camera Components
            for (int i = 0; i < cameraComponentEntities.values.size(); i++)
            {
                AZ::Entity* entity = nullptr;
                AZ::ComponentApplicationBus::BroadcastResult(entity, &AZ::ComponentApplicationBus::Events::FindEntity, cameraComponentEntities.values[i]);
                if (entity)
                {
                    // For Camera Components the enum value is the stringified AZ::EntityId of the entity with the Camera Component
                    QString entityIdString = QString::number(static_cast<AZ::u64>(entity->GetId()));
                    mv_camera->AddEnumItem(entity->GetName().c_str(), entityIdString);
                }
            }            

            ISelectKey selectKey;
            keyHandle.GetKey(&selectKey);

            mv_camera = QString::number(static_cast<AZ::u64>(selectKey.cameraAzEntityId));            

            mv_BlendTime.GetVar()->SetLimits(0.0f, selectKey.fDuration > .0f ? selectKey.fDuration : 1.0f, 0.1f, true, false);
            mv_BlendTime = selectKey.fBlendTime;

            bAssigned = true;        
        }
    }
    return bAssigned;
}

// Called when UI variable changes.
void CSelectKeyUIControls::OnUIChange(IVariable* pVar, CTrackViewKeyBundle& selectedKeys)
{
    CTrackViewSequence* sequence = GetIEditor()->GetAnimation()->GetSequence();

    if (!sequence || !selectedKeys.AreAllKeysOfSameType())
    {
        return;
    }

    for (unsigned int keyIndex = 0; keyIndex < selectedKeys.GetKeyCount(); ++keyIndex)
    {
        CTrackViewKeyHandle keyHandle = selectedKeys.GetKey(keyIndex);

        AnimValueType valueType = keyHandle.GetTrack()->GetValueType();
        if (valueType == AnimValueType::Select)
        {
            ISelectKey selectKey;
            keyHandle.GetKey(&selectKey);

            if (pVar == mv_camera.GetVar())
            {
                QString entityIdString = mv_camera;
                selectKey.cameraAzEntityId = AZ::EntityId(entityIdString.toULongLong());
                selectKey.szSelection =  mv_camera.GetVar()->GetDisplayValue().toUtf8().data();
            }

            if (pVar == mv_BlendTime.GetVar())
            {
                if (mv_BlendTime < 0.0f)
                {
                    mv_BlendTime = 0.0f;
                }

                selectKey.fBlendTime = mv_BlendTime;
            }

            if (!selectKey.szSelection.empty())
            {
                IAnimSequence* pSequence = GetIEditor()->GetSystem()->GetIMovieSystem()->FindLegacySequenceByName(selectKey.szSelection.c_str());
                if (pSequence)
                {
                    selectKey.fDuration = pSequence->GetTimeRange().Length();
                }
            }

            bool isDuringUndo = false;
            AzToolsFramework::ToolsApplicationRequests::Bus::BroadcastResult(isDuringUndo, &AzToolsFramework::ToolsApplicationRequests::Bus::Events::IsDuringUndoRedo);

            if (isDuringUndo)
            {
                keyHandle.SetKey(&selectKey);
            }
            else
            {
                AzToolsFramework::ScopedUndoBatch undoBatch("Set Key Value");
                keyHandle.SetKey(&selectKey);
                undoBatch.MarkEntityDirty(sequence->GetSequenceComponentEntityId());
            }

        }
    }
}

void CSelectKeyUIControls::OnCameraAdded(const AZ::EntityId & cameraId)
{
    // Add a single camera component
    AZ::Entity* entity = nullptr;
    AZ::ComponentApplicationBus::BroadcastResult(entity, &AZ::ComponentApplicationBus::Events::FindEntity, cameraId);
    if (entity)
    {
        // For Camera Components the enum value is the stringified AZ::EntityId of the entity with the Camera Component
        QString entityIdString = QString::number(static_cast<AZ::u64>(entity->GetId()));
        mv_camera->AddEnumItem(entity->GetName().c_str(), entityIdString);
    }
}

void CSelectKeyUIControls::OnCameraRemoved(const AZ::EntityId & cameraId)
{
    mv_camera->EnableUpdateCallbacks(false);

    // We can't iterate or remove an item from the enum list, and Camera::CameraRequests::GetCameras
    // still includes the deleted camera at this point. Reset the list anyway and filter out the
    // deleted camera.
    mv_camera->SetEnumList(nullptr);
    mv_camera->AddEnumItem(QObject::tr("<None>"), QString::number(static_cast<AZ::u64>(AZ::EntityId::InvalidEntityId)));

    AZ::EBusAggregateResults<AZ::EntityId> cameraComponentEntities;
    Camera::CameraBus::BroadcastResult(cameraComponentEntities, &Camera::CameraRequests::GetCameras);
    for (int i = 0; i < cameraComponentEntities.values.size(); i++)
    {
        if (cameraId == cameraComponentEntities.values[i])
        {
            continue;
        }
        OnCameraAdded(cameraComponentEntities.values[i]);
    }

    mv_camera->EnableUpdateCallbacks(true);
}

void CSelectKeyUIControls::OnEntityNameChanged(const AZ::EntityId & entityId, [[maybe_unused]] const AZStd::string & name)
{
    AZ::Entity* entity = nullptr;
    AZ::ComponentApplicationBus::BroadcastResult(entity, &AZ::ComponentApplicationBus::Events::FindEntity, entityId);
    if (entity == nullptr)
    {
        return;
    }

    AZ::Entity::ComponentArrayType cameraComponents = entity->FindComponents(EditorCameraComponentTypeId);
    if (cameraComponents.size() == 0)
    {
        return;
    }

    mv_camera->EnableUpdateCallbacks(false);
    ResetCameraEntries();
    mv_camera->EnableUpdateCallbacks(true);
}

void CSelectKeyUIControls::ResetCameraEntries()
{
    mv_camera.SetEnumList(nullptr);
    mv_camera->AddEnumItem(QObject::tr("<None>"), QString::number(static_cast<AZ::u64>(AZ::EntityId::InvalidEntityId)));

    // Find all Component Entity Cameras
    AZ::EBusAggregateResults<AZ::EntityId> cameraComponentEntities;
    Camera::CameraBus::BroadcastResult(cameraComponentEntities, &Camera::CameraRequests::GetCameras);

    // add names of all found entities with Camera Components
    for (int i = 0; i < cameraComponentEntities.values.size(); i++)
    {
        OnCameraAdded(cameraComponentEntities.values[i]);
    }
}

REGISTER_QT_CLASS_DESC(CSelectKeyUIControls, "TrackView.KeyUI.Select", "TrackViewKeyUI");