/*
 * 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 <AzCore/EBus/EBus.h>
#include <AzFramework/Entity/EntityContext.h>

namespace AzToolsFramework::Prefab
{
    //! Used to notify when the editor focus changes.
    class PrefabFocusNotifications
        : public AZ::EBusTraits
    {
    public:
        //////////////////////////////////////////////////////////////////////////
        // EBusTraits overrides
        static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple;
        static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById;
        using BusIdType = AzFramework::EntityContextId;
        //////////////////////////////////////////////////////////////////////////
        
        //! Triggered when the editor focus is changed to a different prefab.
        virtual void OnPrefabFocusChanged([[maybe_unused]] AZ::EntityId previousContainerEntityId, [[maybe_unused]] AZ::EntityId newContainerEntityId) {}

        //! Triggered when the editor focus path is changed, but the focused instance stays the same.
        virtual void OnPrefabFocusRefreshed() {}

        //! Triggered when the edit scope is changed.
        virtual void OnPrefabEditScopeChanged() {}

        //! Triggered when a prefab instance is opened/expanded.
        virtual void OnInstanceOpened([[maybe_unused]] AZ::EntityId containerEntityId) {}

    protected:
        ~PrefabFocusNotifications() = default;
    };

    using PrefabFocusNotificationBus = AZ::EBus<PrefabFocusNotifications>;

} // namespace AzToolsFramework::Prefab
